AppServicePlan interface

Package:

@azure/arm-appservice

App Service plan.

Extends

Resource

Properties

elasticScaleEnabled	ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku
extendedLocation	Extended Location.
freeOfferExpirationTime	The time when the server farm free offer expires.
geoRegion	Geographical location for the App Service plan. NOTE: This property will not be serialized. It can only be populated by the server.
hostingEnvironmentProfile	Specification for the App Service Environment to use for the App Service plan.
hyperV	If Hyper-V container app service plan true, false otherwise.
isSpot	If true, this App Service Plan owns spot instances.
isXenon	Obsolete: If Hyper-V container app service plan true, false otherwise.
kubeEnvironmentProfile	Specification for the Kubernetes Environment to use for the App Service plan.
maximumElasticWorkerCount	Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
maximumNumberOfWorkers	Maximum number of instances that can be assigned to this App Service plan. NOTE: This property will not be serialized. It can only be populated by the server.
numberOfSites	Number of apps assigned to this App Service plan. NOTE: This property will not be serialized. It can only be populated by the server.
numberOfWorkers	The number of instances that are assigned to this App Service plan. NOTE: This property will not be serialized. It can only be populated by the server.
perSiteScaling	If true, apps assigned to this App Service plan can be scaled independently. If false, apps assigned to this App Service plan will scale to all instances of the plan.
provisioningState	Provisioning state of the App Service Plan. NOTE: This property will not be serialized. It can only be populated by the server.
reserved	If Linux app service plan true, false otherwise.
resourceGroup	Resource group of the App Service plan. NOTE: This property will not be serialized. It can only be populated by the server.
sku	Description of a SKU for a scalable resource.
spotExpirationTime	The time when the server farm expires. Valid only if it is a spot server farm.
status	App Service plan status. NOTE: This property will not be serialized. It can only be populated by the server.
subscription	App Service plan subscription. NOTE: This property will not be serialized. It can only be populated by the server.
targetWorkerCount	Scaling worker count.
targetWorkerSizeId	Scaling worker size ID.
workerTierName	Target worker tier assigned to the App Service plan.
zoneRedundant	If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing.

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

elasticScaleEnabled

ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku

elasticScaleEnabled?: boolean

Property Value

boolean

extendedLocation

Extended Location.

extendedLocation?: ExtendedLocation

Property Value

ExtendedLocation

freeOfferExpirationTime

The time when the server farm free offer expires.

freeOfferExpirationTime?: Date

Property Value

Date

geoRegion

Geographical location for the App Service plan. NOTE: This property will not be serialized. It can only be populated by the server.

geoRegion?: string

Property Value

string

hostingEnvironmentProfile

Specification for the App Service Environment to use for the App Service plan.

hostingEnvironmentProfile?: HostingEnvironmentProfile

Property Value

HostingEnvironmentProfile

hyperV

If Hyper-V container app service plan true, false otherwise.

hyperV?: boolean

Property Value

boolean

isSpot

If true, this App Service Plan owns spot instances.

isSpot?: boolean

Property Value

boolean

isXenon

Obsolete: If Hyper-V container app service plan true, false otherwise.

isXenon?: boolean

Property Value

boolean

kubeEnvironmentProfile

Specification for the Kubernetes Environment to use for the App Service plan.

kubeEnvironmentProfile?: KubeEnvironmentProfile

Property Value

KubeEnvironmentProfile

maximumElasticWorkerCount

Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan

maximumElasticWorkerCount?: number

Property Value

number

maximumNumberOfWorkers

Maximum number of instances that can be assigned to this App Service plan. NOTE: This property will not be serialized. It can only be populated by the server.

maximumNumberOfWorkers?: number

Property Value

number

numberOfSites

Number of apps assigned to this App Service plan. NOTE: This property will not be serialized. It can only be populated by the server.

numberOfSites?: number

Property Value

number

numberOfWorkers

The number of instances that are assigned to this App Service plan. NOTE: This property will not be serialized. It can only be populated by the server.

numberOfWorkers?: number

Property Value

number

perSiteScaling

If true, apps assigned to this App Service plan can be scaled independently. If false, apps assigned to this App Service plan will scale to all instances of the plan.

perSiteScaling?: boolean

Property Value

boolean

provisioningState

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

provisioningState?: ProvisioningState

Property Value

ProvisioningState

reserved

If Linux app service plan true, false otherwise.

reserved?: boolean

Property Value

boolean

resourceGroup

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

resourceGroup?: string

Property Value

string

sku

Description of a SKU for a scalable resource.

sku?: SkuDescription

Property Value

SkuDescription

spotExpirationTime

The time when the server farm expires. Valid only if it is a spot server farm.

spotExpirationTime?: Date

Property Value

Date

status

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

status?: StatusOptions

Property Value

StatusOptions

subscription

App Service plan subscription. NOTE: This property will not be serialized. It can only be populated by the server.

subscription?: string

Property Value

string

targetWorkerCount

Scaling worker count.

targetWorkerCount?: number

Property Value

number

targetWorkerSizeId

Scaling worker size ID.

targetWorkerSizeId?: number

Property Value

number

workerTierName

Target worker tier assigned to the App Service plan.

workerTierName?: string

Property Value

string

zoneRedundant

If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing.

zoneRedundant?: boolean

Property Value

boolean

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