Share via

Site interface

  • Reference
Package:
@azure/arm-appservice

A web app, a mobile app backend, or an API app.

Extends
Resource

Properties

availabilityState

Management information availability state for the app. NOTE: This property will not be serialized. It can only be populated by the server.
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).
daprConfig

Dapr configuration of the app.
defaultHostName

Default hostname of the app. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.
dnsConfiguration

Property to configure various DNS related settings for a site.
enabled

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

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.
extendedLocation

Extended Location.
functionAppConfig

Configuration specific of the Azure Function app.
hostingEnvironmentProfile

App Service Environment to use for the app.
hostNames

Hostnames associated with the app. NOTE: This property will not be serialized. It can only be populated by the server.
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.
identity

Managed service identity.
inProgressOperationId

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.
isDefaultContainer

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.
isXenon

Obsolete: Hyper-V sandbox.
keyVaultReferenceIdentity

Identity to use for Key Vault Reference authentication.
lastModifiedTimeUtc

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.
managedEnvironmentId

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}
maxNumberOfWorkers

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.
outboundIpAddresses

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.
possibleOutboundIpAddresses

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.
publicNetworkAccess

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

Site redundancy mode
repositorySiteName

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

true if reserved; otherwise, false.
resourceConfig

Function app resource requirements.
resourceGroup

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.
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.
slotSwapStatus

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.
storageAccountRequired

Checks if Customer provided storage account is required
suspendedTill

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.
targetSwapSlot

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.
trafficManagerHostNames

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.
usageState

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.
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}
vnetBackupRestoreEnabled

To enable Backup and Restore operations over virtual network
vnetContentShareEnabled

To enable accessing content over virtual network
vnetImagePullEnabled

To enable pulling image over Virtual Network
vnetRouteAllEnabled

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

Workload profile name for function app to execute on.

Inherited Properties

id

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

Kind of resource.
location

Resource Location.
name

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

Resource tags.
type

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

Property Details

availabilityState

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

SiteAvailabilityState

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?: ClientCertMode

Property Value

ClientCertMode

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

daprConfig

Dapr configuration of the app.

daprConfig?: DaprConfig

Property Value

DaprConfig

defaultHostName

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

dnsConfiguration

Property to configure various DNS related settings for a site.

dnsConfiguration?: SiteDnsConfig

Property Value

SiteDnsConfig

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

enabledHostNames

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[]

extendedLocation

Extended Location.

extendedLocation?: ExtendedLocation

Property Value

ExtendedLocation

functionAppConfig

Configuration specific of the Azure Function app.

functionAppConfig?: FunctionAppConfig

Property Value

FunctionAppConfig

hostingEnvironmentProfile

App Service Environment to use for the app.

hostingEnvironmentProfile?: HostingEnvironmentProfile

Property Value

HostingEnvironmentProfile

hostNames

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[]

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

identity

Managed service identity.

identity?: ManagedServiceIdentity

Property Value

ManagedServiceIdentity

inProgressOperationId

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

isDefaultContainer

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

isXenon

Obsolete: Hyper-V sandbox.

isXenon?: boolean

Property Value

boolean

keyVaultReferenceIdentity

Identity to use for Key Vault Reference authentication.

keyVaultReferenceIdentity?: string

Property Value

string

lastModifiedTimeUtc

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

managedEnvironmentId

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

string

maxNumberOfWorkers

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

outboundIpAddresses

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

possibleOutboundIpAddresses

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

publicNetworkAccess

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

publicNetworkAccess?: string

Property Value

string

redundancyMode

Site redundancy mode

redundancyMode?: RedundancyMode

Property Value

RedundancyMode

repositorySiteName

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

resourceConfig

Function app resource requirements.

resourceConfig?: ResourceConfig

Property Value

ResourceConfig

resourceGroup

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

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

slotSwapStatus

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

SlotSwapStatus

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

storageAccountRequired

Checks if Customer provided storage account is required

storageAccountRequired?: boolean

Property Value

boolean

suspendedTill

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

targetSwapSlot

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

trafficManagerHostNames

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[]

usageState

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

UsageState

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

vnetBackupRestoreEnabled

To enable Backup and Restore operations over virtual network

vnetBackupRestoreEnabled?: boolean

Property Value

boolean

vnetContentShareEnabled

To enable accessing content over virtual network

vnetContentShareEnabled?: boolean

Property Value

boolean

vnetImagePullEnabled

To enable pulling image over Virtual Network

vnetImagePullEnabled?: boolean

Property Value

boolean

vnetRouteAllEnabled

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

boolean

workloadProfileName

Workload profile name for function app to execute on.

workloadProfileName?: 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 Resource.id

kind

Kind of resource.

kind?: string

Property Value

string

Inherited From Resource.kind

location

Resource Location.

location: string

Property Value

string

Inherited From Resource.location

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 Resource.name

tags

Resource tags.

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

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

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 Resource.type