Share via


AppServicePlanPatchResourcePropertiesOutput interface

AppServicePlanPatchResource resource specific properties

Properties

elasticScaleEnabled

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

freeOfferExpirationTime

The time when the server farm free offer expires.

geoRegion

Geographical location for the App Service plan.

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.

numberOfSites

Number of apps assigned to this App Service plan.

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.

reserved

If Linux app service plan true, false otherwise.

resourceGroup

Resource group of the App Service plan.

spotExpirationTime

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

status

App Service plan status.

subscription

App Service plan subscription.

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.

Property Details

elasticScaleEnabled

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

elasticScaleEnabled?: boolean

Property Value

boolean

freeOfferExpirationTime

The time when the server farm free offer expires.

freeOfferExpirationTime?: string

Property Value

string

geoRegion

Geographical location for the App Service plan.

geoRegion?: string

Property Value

string

hostingEnvironmentProfile

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

hostingEnvironmentProfile?: HostingEnvironmentProfileOutput

Property Value

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

Property Value

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.

maximumNumberOfWorkers?: number

Property Value

number

numberOfSites

Number of apps assigned to this App Service plan.

numberOfSites?: 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.

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

Property Value

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

reserved

If Linux app service plan true, false otherwise.

reserved?: boolean

Property Value

boolean

resourceGroup

Resource group of the App Service plan.

resourceGroup?: string

Property Value

string

spotExpirationTime

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

spotExpirationTime?: string

Property Value

string

status

App Service plan status.

status?: "Pending" | "Ready" | "Creating"

Property Value

"Pending" | "Ready" | "Creating"

subscription

App Service plan subscription.

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