Share via

AppServiceEnvironment interface

  • Reference
Package:
@azure/arm-appservice

Description of an App Service Environment.

Properties

clusterSettings

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

Full view of the custom domain suffix configuration for ASEv3.
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 NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
multiRoleCount

Number of front-end instances. NOTE: This property will not be serialized. It can only be populated by the server.
multiSize

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

Full view of networking configuration for an ASE.
provisioningState

Provisioning state of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.
status

Current status of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.
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). NOTE: This property will not be serialized. It can only be populated by the server.
upgradeAvailability

Whether an upgrade is available for this App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.
upgradePreference

Upgrade Preference
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?: NameValuePair[]

Property Value

NameValuePair[]

customDnsSuffixConfiguration

Full view of the custom domain suffix configuration for ASEv3.

customDnsSuffixConfiguration?: CustomDnsSuffixConfiguration

Property Value

CustomDnsSuffixConfiguration

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

hasLinuxWorkers?: boolean

Property Value

boolean

internalLoadBalancingMode

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

internalLoadBalancingMode?: string

Property Value

string

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

maximumNumberOfMachines?: number

Property Value

number

multiRoleCount

Number of front-end instances. NOTE: This property will not be serialized. It can only be populated by the server.

multiRoleCount?: number

Property Value

number

multiSize

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

multiSize?: string

Property Value

string

networkingConfiguration

Full view of networking configuration for an ASE.

networkingConfiguration?: AseV3NetworkingConfiguration

Property Value

AseV3NetworkingConfiguration

provisioningState

Provisioning state of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: ProvisioningState

Property Value

ProvisioningState

status

Current status of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

status?: HostingEnvironmentStatus

Property Value

HostingEnvironmentStatus

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

suspended?: boolean

Property Value

boolean

upgradeAvailability

Whether an upgrade is available for this App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

upgradeAvailability?: string

Property Value

string

upgradePreference

Upgrade Preference

upgradePreference?: string

Property Value

string

userWhitelistedIpRanges

User added ip ranges to whitelist on ASE db

userWhitelistedIpRanges?: string[]

Property Value

string[]

virtualNetwork

Description of the Virtual Network.

virtualNetwork: VirtualNetworkProfile

Property Value

VirtualNetworkProfile

zoneRedundant

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

zoneRedundant?: boolean

Property Value

boolean