Site interface

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

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

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

clientCertEnabled?: boolean

Property Value

client certificate authentication comma-separated exclusion paths

clientCertExclusionPaths?: string

Property Value

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

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

cloningInfo?: CloningInfo

Property Value

Size of the function container.

containerSize?: number

Property Value

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

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

dailyMemoryTimeQuota?: number

Property Value

Dapr configuration of the app.

daprConfig?: DaprConfig

Property Value

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

Property to configure various DNS related settings for a site.

dnsConfiguration?: SiteDnsConfig

Property Value

true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).

enabled?: boolean

Property Value

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

Extended Location.

extendedLocation?: ExtendedLocation

Property Value

Configuration specific of the Azure Function app.

functionAppConfig?: FunctionAppConfig

Property Value

App Service Environment to use for the app.

hostingEnvironmentProfile?: HostingEnvironmentProfile

Property Value

Hostnames associated with the app. NOTE: This property will not be serialized. It can only be populated by the server.

hostNames?: string[]

Property Value

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

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

hostNameSslStates?: HostNameSslState[]

Property Value

HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests

httpsOnly?: boolean

Property Value

Hyper-V sandbox.

hyperV?: boolean

Property Value

Managed service identity.

identity?: ManagedServiceIdentity

Property Value

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

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

Obsolete: Hyper-V sandbox.

isXenon?: boolean

Property Value

Identity to use for Key Vault Reference authentication.

keyVaultReferenceIdentity?: string

Property Value

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

Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName}

managedEnvironmentId?: string

Property Value

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

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

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

Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string.

publicNetworkAccess?: string

Property Value

Site redundancy mode

redundancyMode?: RedundancyMode

Property Value

Name of the repository site. NOTE: This property will not be serialized. It can only be populated by the server.

repositorySiteName?: string

Property Value

true if reserved; otherwise, false.

reserved?: boolean

Property Value

Function app resource requirements.

resourceConfig?: ResourceConfig

Property Value

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

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

scmSiteAlsoStopped?: boolean

Property Value

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

serverFarmId?: string

Property Value

Configuration of the app.

siteConfig?: SiteConfig

Property Value

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

Current state of the app. NOTE: This property will not be serialized. It can only be populated by the server.

state?: string

Property Value

Checks if Customer provided storage account is required

storageAccountRequired?: boolean

Property Value

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

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

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

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

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

To enable Backup and Restore operations over virtual network

vnetBackupRestoreEnabled?: boolean

Property Value

To enable accessing content over virtual network

vnetContentShareEnabled?: boolean

Property Value

To enable pulling image over Virtual Network

vnetImagePullEnabled?: boolean

Property Value

Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.

vnetRouteAllEnabled?: boolean

Property Value

Workload profile name for function app to execute on.

workloadProfileName?: string

Property Value

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

Inherited From Resource.id

Kind of resource.

kind?: string

Property Value

Inherited From Resource.kind

Resource Location.

location: string

Property Value

Inherited From Resource.location

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

Inherited From Resource.name

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

Inherited From Resource.tags

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

Inherited From Resource.type