Share via

SitePropertiesOutput interface

Package:
@azure-rest/arm-appservice

Site resource specific properties

Properties

availabilityState

Management information availability state for the app.
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).
defaultHostName

Default hostname of the app. Read-only.
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.
hostingEnvironmentProfile

App Service Environment to use for the app.
hostNames

Hostnames associated with 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.
inProgressOperationId

Specifies an operation id if this site has a pending operation.

Value may contain a UUID
isDefaultContainer

true if the app is a default container; otherwise, false.
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.
maxNumberOfWorkers

Maximum number of workers. This only applies to Functions container.
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.
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.
redundancyMode

Site redundancy mode
repositorySiteName

Name of the repository site.
reserved

true if reserved; otherwise, false.
resourceGroup

Name of the resource group the app belongs to. Read-only.
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.
state

Current state of the app.
storageAccountRequired

Checks if Customer provided storage account is required
suspendedTill

App suspended till in case memory-time quota is exceeded.
targetSwapSlot

Specifies which deployment slot this app will swap into. Read-only.
trafficManagerHostNames

Azure Traffic Manager hostnames associated with the app. Read-only.
usageState

State indicating whether the app has exceeded its quota usage. Read-only.
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

availabilityState

Management information availability state for the app.

availabilityState?: "Normal" | "Limited" | "DisasterRecoveryMode"

Property Value

"Normal" | "Limited" | "DisasterRecoveryMode"

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

Property Value

CloningInfoOutput

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

defaultHostName

Default hostname of the app. Read-only.

defaultHostName?: string

Property Value

string

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.

enabledHostNames?: string[]

Property Value

string[]

hostingEnvironmentProfile

App Service Environment to use for the app.

hostingEnvironmentProfile?: HostingEnvironmentProfileOutput

Property Value

HostingEnvironmentProfileOutput

hostNames

Hostnames associated with the app.

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?: HostNameSslStateOutput[]

Property Value

HostNameSslStateOutput[]

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

inProgressOperationId

Specifies an operation id if this site has a pending operation.

Value may contain a UUID

inProgressOperationId?: string

Property Value

string

isDefaultContainer

true if the app is a default container; otherwise, false.

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.

lastModifiedTimeUtc?: string

Property Value

string

maxNumberOfWorkers

Maximum number of workers. This only applies to Functions container.

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.

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.

possibleOutboundIpAddresses?: string

Property Value

string

redundancyMode

Site redundancy mode

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

Property Value

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

repositorySiteName

Name of the repository site.

repositorySiteName?: string

Property Value

string

reserved

true if reserved; otherwise, false.

reserved?: boolean

Property Value

boolean

resourceGroup

Name of the resource group the app belongs to. Read-only.

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

Property Value

SiteConfigOutput

slotSwapStatus

Status of the last deployment slot swap operation.

slotSwapStatus?: SlotSwapStatusOutput

Property Value

SlotSwapStatusOutput

state

Current state of the app.

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.

suspendedTill?: string

Property Value

string

targetSwapSlot

Specifies which deployment slot this app will swap into. Read-only.

targetSwapSlot?: string

Property Value

string

trafficManagerHostNames

Azure Traffic Manager hostnames associated with the app. Read-only.

trafficManagerHostNames?: string[]

Property Value

string[]

usageState

State indicating whether the app has exceeded its quota usage. Read-only.

usageState?: "Normal" | "Exceeded"

Property Value

"Normal" | "Exceeded"

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