AppServiceEnvironmentOutput interface

Package:

@azure-rest/arm-appservice

Description of an App Service Environment.

Properties

clusterSettings	Custom settings for changing the behavior of the App Service Environment.
dedicatedHostCount	Dedicated Host Count
dnsSuffix	DNS suffix of the App Service Environment.
frontEndScaleFactor	Scale factor for front-ends.
hasLinuxWorkers	Flag that displays whether an ASE has linux workers or not
internalLoadBalancingMode	Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
ipsslAddressCount	Number of IP SSL addresses reserved for the App Service Environment.
maximumNumberOfMachines	Maximum number of VMs in the App Service Environment.
multiRoleCount	Number of front-end instances.
multiSize	Front-end VM size, e.g. "Medium", "Large".
provisioningState	Provisioning state of the App Service Environment.
status	Current status of the App Service Environment.
suspended	true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
userWhitelistedIpRanges	User added ip ranges to whitelist on ASE db
virtualNetwork	Description of the Virtual Network.
zoneRedundant	Whether or not this App Service Environment is zone-redundant.

Property Details

clusterSettings

Custom settings for changing the behavior of the App Service Environment.

clusterSettings?: NameValuePairOutput[]

Property Value

NameValuePairOutput[]

dedicatedHostCount

Dedicated Host Count

dedicatedHostCount?: number

Property Value

number

dnsSuffix

DNS suffix of the App Service Environment.

dnsSuffix?: string

Property Value

string

frontEndScaleFactor

Scale factor for front-ends.

frontEndScaleFactor?: number

Property Value

number

hasLinuxWorkers

Flag that displays whether an ASE has linux workers or not

hasLinuxWorkers?: boolean

Property Value

boolean

internalLoadBalancingMode

Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.

internalLoadBalancingMode?: "None" | "Web" | "Publishing" | "Web, Publishing"

Property Value

"None" | "Web" | "Publishing" | "Web, Publishing"

ipsslAddressCount

Number of IP SSL addresses reserved for the App Service Environment.

ipsslAddressCount?: number

Property Value

number

maximumNumberOfMachines

Maximum number of VMs in the App Service Environment.

maximumNumberOfMachines?: number

Property Value

number

multiRoleCount

Number of front-end instances.

multiRoleCount?: number

Property Value

number

multiSize

Front-end VM size, e.g. "Medium", "Large".

multiSize?: string

Property Value

string

provisioningState

Provisioning state of the App Service Environment.

provisioningState?: "Failed" | "Succeeded" | "Canceled" | "InProgress" | "Deleting"

Property Value

"Failed" | "Succeeded" | "Canceled" | "InProgress" | "Deleting"

status

Current status of the App Service Environment.

status?: "Deleting" | "Preparing" | "Ready" | "Scaling"

Property Value

"Deleting" | "Preparing" | "Ready" | "Scaling"

suspended

true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).

suspended?: boolean

Property Value

boolean

userWhitelistedIpRanges

User added ip ranges to whitelist on ASE db

userWhitelistedIpRanges?: string[]

Property Value

string[]

virtualNetwork

Description of the Virtual Network.

virtualNetwork: VirtualNetworkProfileOutput

Property Value

VirtualNetworkProfileOutput

zoneRedundant

Whether or not this App Service Environment is zone-redundant.

zoneRedundant?: boolean

Property Value

boolean