SiteProperties interface

Package:

@azure-rest/arm-appservice

Site resource specific properties

Properties

clientAffinityEnabled	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.
clientCertEnabled	true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.
clientCertExclusionPaths	client certificate authentication comma-separated exclusion paths
clientCertMode	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.
cloningInfo	If specified during app creation, the app is cloned from a source app.
containerSize	Size of the function container.
customDomainVerificationId	Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.
dailyMemoryTimeQuota	Maximum allowed daily memory-time quota (applicable on dynamic apps only).
enabled	true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).
hostingEnvironmentProfile	App Service Environment to use for the app.
hostNamesDisabled	true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process.
hostNameSslStates	Hostname SSL states are used to manage the SSL bindings for app's hostnames.
httpsOnly	HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests
hyperV	Hyper-V sandbox.
isXenon	Obsolete: Hyper-V sandbox.
keyVaultReferenceIdentity	Identity to use for Key Vault Reference authentication.
redundancyMode	Site redundancy mode
reserved	true if reserved; otherwise, false.
scmSiteAlsoStopped	true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.
serverFarmId	Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
siteConfig	Configuration of the app.
storageAccountRequired	Checks if Customer provided storage account is required
virtualNetworkSubnetId	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}

Property Details

clientAffinityEnabled

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

clientCertEnabled

true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.

clientCertEnabled?: boolean

Property Value

boolean

clientCertExclusionPaths

client certificate authentication comma-separated exclusion paths

clientCertExclusionPaths?: string

Property Value

string

clientCertMode

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?: "Required" | "Optional" | "OptionalInteractiveUser"

Property Value

"Required" | "Optional" | "OptionalInteractiveUser"

cloningInfo

If specified during app creation, the app is cloned from a source app.

cloningInfo?: CloningInfo

Property Value

CloningInfo

containerSize

Size of the function container.

containerSize?: number

Property Value

number

customDomainVerificationId

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

dailyMemoryTimeQuota

Maximum allowed daily memory-time quota (applicable on dynamic apps only).

dailyMemoryTimeQuota?: number

Property Value

number

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

hostingEnvironmentProfile

App Service Environment to use for the app.

hostingEnvironmentProfile?: HostingEnvironmentProfile

Property Value

HostingEnvironmentProfile

hostNamesDisabled

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

hostNameSslStates

Hostname SSL states are used to manage the SSL bindings for app's hostnames.

hostNameSslStates?: HostNameSslState[]

Property Value

HostNameSslState[]

httpsOnly

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

isXenon

Obsolete: Hyper-V sandbox.

isXenon?: boolean

Property Value

boolean

keyVaultReferenceIdentity

Identity to use for Key Vault Reference authentication.

keyVaultReferenceIdentity?: string

Property Value

string

redundancyMode

Site redundancy mode

redundancyMode?: "None" | "Manual" | "Failover" | "ActiveActive" | "GeoRedundant"

Property Value

"None" | "Manual" | "Failover" | "ActiveActive" | "GeoRedundant"

reserved

true if reserved; otherwise, false.

reserved?: boolean

Property Value

boolean

scmSiteAlsoStopped

true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.

scmSiteAlsoStopped?: boolean

Property Value

boolean

serverFarmId

Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".

serverFarmId?: string

Property Value

string

siteConfig

Configuration of the app.

siteConfig?: SiteConfig

Property Value

SiteConfig

storageAccountRequired

Checks if Customer provided storage account is required

storageAccountRequired?: boolean

Property Value

boolean

virtualNetworkSubnetId

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