Site Patch Resource interface
ARM resource for a site.
- Extends
Properties
availability |
Management information availability state for the app. NOTE: This property will not be serialized. It can only be populated by the server. |
client |
|
client |
|
client |
client certificate authentication comma-separated exclusion paths |
client |
This composes with ClientCertEnabled setting.
|
cloning |
If specified during app creation, the app is cloned from a source app. |
container |
Size of the function container. |
custom |
Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. |
daily |
Maximum allowed daily memory-time quota (applicable on dynamic apps only). |
default |
Default hostname of the app. Read-only. NOTE: This property will not be serialized. It can only be populated by the server. |
dns |
Property to configure various DNS related settings for a site. |
enabled |
|
enabled |
Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. NOTE: This property will not be serialized. It can only be populated by the server. |
hosting |
App Service Environment to use for the app. |
host |
Hostnames associated with the app. NOTE: This property will not be serialized. It can only be populated by the server. |
host |
|
host |
Hostname SSL states are used to manage the SSL bindings for app's hostnames. |
https |
HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests |
hyperV | Hyper-V sandbox. |
identity | Managed service identity. |
in |
Specifies an operation id if this site has a pending operation. NOTE: This property will not be serialized. It can only be populated by the server. |
is |
|
is |
Obsolete: Hyper-V sandbox. |
key |
Identity to use for Key Vault Reference authentication. |
last |
Last time the app was modified, in UTC. Read-only. NOTE: This property will not be serialized. It can only be populated by the server. |
max |
Maximum number of workers. This only applies to Functions container. NOTE: This property will not be serialized. It can only be populated by the server. |
outbound |
List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. NOTE: This property will not be serialized. It can only be populated by the server. |
possible |
List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. NOTE: This property will not be serialized. It can only be populated by the server. |
redundancy |
Site redundancy mode |
repository |
Name of the repository site. NOTE: This property will not be serialized. It can only be populated by the server. |
reserved |
|
resource |
Name of the resource group the app belongs to. Read-only. NOTE: This property will not be serialized. It can only be populated by the server. |
scm |
|
server |
Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". |
site |
Configuration of the app. |
slot |
Status of the last deployment slot swap operation. NOTE: This property will not be serialized. It can only be populated by the server. |
state | Current state of the app. NOTE: This property will not be serialized. It can only be populated by the server. |
storage |
Checks if Customer provided storage account is required |
suspended |
App suspended till in case memory-time quota is exceeded. NOTE: This property will not be serialized. It can only be populated by the server. |
target |
Specifies which deployment slot this app will swap into. Read-only. NOTE: This property will not be serialized. It can only be populated by the server. |
traffic |
Azure Traffic Manager hostnames associated with the app. Read-only. NOTE: This property will not be serialized. It can only be populated by the server. |
usage |
State indicating whether the app has exceeded its quota usage. Read-only. NOTE: This property will not be serialized. It can only be populated by the server. |
virtual |
Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} |
Inherited Properties
id | Resource Id. NOTE: This property will not be serialized. It can only be populated by the server. |
kind | Kind of resource. |
name | Resource Name. NOTE: This property will not be serialized. It can only be populated by the server. |
type | Resource type. NOTE: This property will not be serialized. It can only be populated by the server. |
Property Details
availability State
Management information availability state for the app. NOTE: This property will not be serialized. It can only be populated by the server.
availabilityState?: SiteAvailabilityState
Property Value
client Affinity Enabled
true
to enable client affinity; false
to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true
.
clientAffinityEnabled?: boolean
Property Value
boolean
client Cert Enabled
true
to enable client certificate authentication (TLS mutual authentication); otherwise, false
. Default is false
.
clientCertEnabled?: boolean
Property Value
boolean
client Cert Exclusion Paths
client certificate authentication comma-separated exclusion paths
clientCertExclusionPaths?: string
Property Value
string
client Cert Mode
This composes with ClientCertEnabled setting.
- ClientCertEnabled: false means ClientCert is ignored.
- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.
- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted.
clientCertMode?: ClientCertMode
Property Value
cloning Info
If specified during app creation, the app is cloned from a source app.
cloningInfo?: CloningInfo
Property Value
container Size
Size of the function container.
containerSize?: number
Property Value
number
custom Domain Verification Id
Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.
customDomainVerificationId?: string
Property Value
string
daily Memory Time Quota
Maximum allowed daily memory-time quota (applicable on dynamic apps only).
dailyMemoryTimeQuota?: number
Property Value
number
default Host Name
Default hostname of the app. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.
defaultHostName?: string
Property Value
string
dns Configuration
Property to configure various DNS related settings for a site.
dnsConfiguration?: SiteDnsConfig
Property Value
enabled
true
if the app is enabled; otherwise, false
. Setting this value to false disables the app (takes the app offline).
enabled?: boolean
Property Value
boolean
enabled Host Names
Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. NOTE: This property will not be serialized. It can only be populated by the server.
enabledHostNames?: string[]
Property Value
string[]
hosting Environment Profile
App Service Environment to use for the app.
hostingEnvironmentProfile?: HostingEnvironmentProfile
Property Value
host Names
Hostnames associated with the app. NOTE: This property will not be serialized. It can only be populated by the server.
hostNames?: string[]
Property Value
string[]
host Names Disabled
true
to disable the public hostnames of the app; otherwise, false
.
If true
, the app is only accessible via API management process.
hostNamesDisabled?: boolean
Property Value
boolean
host Name Ssl States
Hostname SSL states are used to manage the SSL bindings for app's hostnames.
hostNameSslStates?: HostNameSslState[]
Property Value
https Only
HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests
httpsOnly?: boolean
Property Value
boolean
hyperV
Hyper-V sandbox.
hyperV?: boolean
Property Value
boolean
identity
in Progress Operation Id
Specifies an operation id if this site has a pending operation. NOTE: This property will not be serialized. It can only be populated by the server.
inProgressOperationId?: string
Property Value
string
is Default Container
true
if the app is a default container; otherwise, false
.
NOTE: This property will not be serialized. It can only be populated by the server.
isDefaultContainer?: boolean
Property Value
boolean
is Xenon
Obsolete: Hyper-V sandbox.
isXenon?: boolean
Property Value
boolean
key Vault Reference Identity
Identity to use for Key Vault Reference authentication.
keyVaultReferenceIdentity?: string
Property Value
string
last Modified Time Utc
Last time the app was modified, in UTC. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.
lastModifiedTimeUtc?: Date
Property Value
Date
max Number OfWorkers
Maximum number of workers. This only applies to Functions container. NOTE: This property will not be serialized. It can only be populated by the server.
maxNumberOfWorkers?: number
Property Value
number
outbound IpAddresses
List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.
outboundIpAddresses?: string
Property Value
string
possible Outbound IpAddresses
List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.
possibleOutboundIpAddresses?: string
Property Value
string
redundancy Mode
repository Site Name
Name of the repository site. NOTE: This property will not be serialized. It can only be populated by the server.
repositorySiteName?: string
Property Value
string
reserved
true
if reserved; otherwise, false
.
reserved?: boolean
Property Value
boolean
resource Group
Name of the resource group the app belongs to. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.
resourceGroup?: string
Property Value
string
scm Site Also Stopped
true
to stop SCM (KUDU) site when the app is stopped; otherwise, false
. The default is false
.
scmSiteAlsoStopped?: boolean
Property Value
boolean
server Farm Id
Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
serverFarmId?: string
Property Value
string
site Config
slot Swap Status
Status of the last deployment slot swap operation. NOTE: This property will not be serialized. It can only be populated by the server.
slotSwapStatus?: SlotSwapStatus
Property Value
state
Current state of the app. NOTE: This property will not be serialized. It can only be populated by the server.
state?: string
Property Value
string
storage Account Required
Checks if Customer provided storage account is required
storageAccountRequired?: boolean
Property Value
boolean
suspended Till
App suspended till in case memory-time quota is exceeded. NOTE: This property will not be serialized. It can only be populated by the server.
suspendedTill?: Date
Property Value
Date
target Swap Slot
Specifies which deployment slot this app will swap into. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.
targetSwapSlot?: string
Property Value
string
traffic Manager Host Names
Azure Traffic Manager hostnames associated with the app. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.
trafficManagerHostNames?: string[]
Property Value
string[]
usage State
State indicating whether the app has exceeded its quota usage. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.
usageState?: UsageState
Property Value
virtual Network Subnet Id
Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}
virtualNetworkSubnetId?: string
Property Value
string
Inherited Property Details
id
Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.
id?: string
Property Value
string
Inherited From ProxyOnlyResource.id
kind
name
Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.
name?: string
Property Value
string
Inherited From ProxyOnlyResource.name
type
Resource type. NOTE: This property will not be serialized. It can only be populated by the server.
type?: string
Property Value
string
Inherited From ProxyOnlyResource.type