Share via

AppServiceEnvironment interface

  • Reference
Package:
@azure/arm-appservice-profile-2020-09-01-hybrid

Description of an App Service Environment.

Properties

allowedMultiSizes

List of comma separated strings describing which VM sizes are allowed for front-ends. NOTE: This property will not be serialized. It can only be populated by the server.
allowedWorkerSizes

List of comma separated strings describing which VM sizes are allowed for workers. NOTE: This property will not be serialized. It can only be populated by the server.
apiManagementAccountId

API Management Account associated with the App Service Environment.
clusterSettings

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

Edition of the metadata database for the App Service Environment, e.g. "Standard". NOTE: This property will not be serialized. It can only be populated by the server.
databaseServiceObjective

Service objective of the metadata database for the App Service Environment, e.g. "S0". NOTE: This property will not be serialized. It can only be populated by the server.
defaultFrontEndScaleFactor

Default Scale Factor for FrontEnds. NOTE: This property will not be serialized. It can only be populated by the server.
dnsSuffix

DNS suffix of the App Service Environment.
dynamicCacheEnabled

True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
environmentCapacities

Current total, used, and available worker capacities. NOTE: This property will not be serialized. It can only be populated by the server.
environmentIsHealthy

True/false indicating whether the App Service Environment is healthy. NOTE: This property will not be serialized. It can only be populated by the server.
environmentStatus

Detailed message about with results of the last check of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.
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.
lastAction

Last deployment action on the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.
lastActionResult

Result of the last deployment action on the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.
location

Location of the App Service Environment, e.g. "West US".
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.
multiSize

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

Name of the App Service Environment.
networkAccessControlList

Access control list for controlling traffic to the App Service Environment.
provisioningState

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

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

Key Vault ID for ILB App Service Environment default SSL certificate
sslCertKeyVaultSecretName

Key Vault Secret Name for ILB App Service Environment default SSL certificate
status

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

Subscription 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).
upgradeDomains

Number of upgrade domains of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.
userWhitelistedIpRanges

User added ip ranges to whitelist on ASE db
vipMappings

Description of IP SSL mapping for the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.
virtualNetwork

Description of the Virtual Network.
vnetName

Name of the Virtual Network for the App Service Environment.
vnetResourceGroupName

Resource group of the Virtual Network.
vnetSubnetName

Subnet of the Virtual Network.
workerPools

Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.

Property Details

allowedMultiSizes

List of comma separated strings describing which VM sizes are allowed for front-ends. NOTE: This property will not be serialized. It can only be populated by the server.

allowedMultiSizes?: string

Property Value

string

allowedWorkerSizes

List of comma separated strings describing which VM sizes are allowed for workers. NOTE: This property will not be serialized. It can only be populated by the server.

allowedWorkerSizes?: string

Property Value

string

apiManagementAccountId

API Management Account associated with the App Service Environment.

apiManagementAccountId?: string

Property Value

string

clusterSettings

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

clusterSettings?: NameValuePair[]

Property Value

NameValuePair[]

databaseEdition

Edition of the metadata database for the App Service Environment, e.g. "Standard". NOTE: This property will not be serialized. It can only be populated by the server.

databaseEdition?: string

Property Value

string

databaseServiceObjective

Service objective of the metadata database for the App Service Environment, e.g. "S0". NOTE: This property will not be serialized. It can only be populated by the server.

databaseServiceObjective?: string

Property Value

string

defaultFrontEndScaleFactor

Default Scale Factor for FrontEnds. NOTE: This property will not be serialized. It can only be populated by the server.

defaultFrontEndScaleFactor?: number

Property Value

number

dnsSuffix

DNS suffix of the App Service Environment.

dnsSuffix?: string

Property Value

string

dynamicCacheEnabled

True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).

dynamicCacheEnabled?: boolean

Property Value

boolean

environmentCapacities

Current total, used, and available worker capacities. NOTE: This property will not be serialized. It can only be populated by the server.

environmentCapacities?: StampCapacity[]

Property Value

StampCapacity[]

environmentIsHealthy

True/false indicating whether the App Service Environment is healthy. NOTE: This property will not be serialized. It can only be populated by the server.

environmentIsHealthy?: boolean

Property Value

boolean

environmentStatus

Detailed message about with results of the last check of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

environmentStatus?: 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?: InternalLoadBalancingMode

Property Value

InternalLoadBalancingMode

ipsslAddressCount

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

ipsslAddressCount?: number

Property Value

number

lastAction

Last deployment action on the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

lastAction?: string

Property Value

string

lastActionResult

Result of the last deployment action on the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

lastActionResult?: string

Property Value

string

location

Location of the App Service Environment, e.g. "West US".

location: string

Property Value

string

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.

multiRoleCount?: number

Property Value

number

multiSize

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

multiSize?: string

Property Value

string

name

Name of the App Service Environment.

name: string

Property Value

string

networkAccessControlList

Access control list for controlling traffic to the App Service Environment.

networkAccessControlList?: NetworkAccessControlEntry[]

Property Value

NetworkAccessControlEntry[]

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

resourceGroup

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

resourceGroup?: string

Property Value

string

sslCertKeyVaultId

Key Vault ID for ILB App Service Environment default SSL certificate

sslCertKeyVaultId?: string

Property Value

string

sslCertKeyVaultSecretName

Key Vault Secret Name for ILB App Service Environment default SSL certificate

sslCertKeyVaultSecretName?: string

Property Value

string

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

subscriptionId

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

subscriptionId?: string

Property Value

string

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

upgradeDomains

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

upgradeDomains?: number

Property Value

number

userWhitelistedIpRanges

User added ip ranges to whitelist on ASE db

userWhitelistedIpRanges?: string[]

Property Value

string[]

vipMappings

Description of IP SSL mapping for the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

vipMappings?: VirtualIPMapping[]

Property Value

VirtualIPMapping[]

virtualNetwork

Description of the Virtual Network.

virtualNetwork: VirtualNetworkProfile

Property Value

VirtualNetworkProfile

vnetName

Name of the Virtual Network for the App Service Environment.

vnetName?: string

Property Value

string

vnetResourceGroupName

Resource group of the Virtual Network.

vnetResourceGroupName?: string

Property Value

string

vnetSubnetName

Subnet of the Virtual Network.

vnetSubnetName?: string

Property Value

string

workerPools

Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.

workerPools: WorkerPool[]

Property Value

WorkerPool[]