AppServicePlanProperties Class

AppServicePlan resource specific properties.

Constructor

AppServicePlanProperties()

Variables

Name	Description
worker_tier_name	str Target worker tier assigned to the App Service plan.
status	Union[str, <xref:"StatusOptions">] App Service plan status. Known values are: "Ready", "Pending", and "Creating".
subscription	str App Service plan subscription.
hosting_environment_profile	<xref:<xref:"HostingEnvironmentProfile">> Specification for the App Service Environment to use for the App Service plan.
maximum_number_of_workers	int Maximum number of instances that can be assigned to this App Service plan.
number_of_workers	int The number of instances that are assigned to this App Service plan.
geo_region	str Geographical location for the App Service plan.
per_site_scaling	bool 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.
elastic_scale_enabled	bool ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku.
maximum_elastic_worker_count	int Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan.
number_of_sites	int Number of apps assigned to this App Service plan.
is_spot	bool If true, this App Service Plan owns spot instances.
spot_expiration_time	str The time when the server farm expires. Valid only if it is a spot server farm.
free_offer_expiration_time	str The time when the server farm free offer expires.
resource_group	str Resource group of the App Service plan.
reserved	bool If Linux app service plan true, false otherwise.
is_xenon	bool Obsolete: If Hyper-V container app service plan true, false otherwise.
hyper_v	bool If Hyper-V container app service plan true, false otherwise.
target_worker_count	int Scaling worker count.
target_worker_size_id	int Scaling worker size ID.
provisioning_state	Union[str, <xref:"ProvisioningState">] Provisioning state of the App Service Plan. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", and "Deleting".
kube_environment_profile	<xref:<xref:"KubeEnvironmentProfile">> Specification for the Kubernetes Environment to use for the App Service plan.
zone_redundant	bool If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing.
async_scaling_enabled	bool If true, this App Service Plan will attempt to scale asynchronously if there are insufficient workers to scale synchronously. If false, this App Service Plan will only attempt sync scaling.
plan_default_identity	<xref:<xref:"DefaultIdentity">> Identity to use by platform for various features and integrations using managed identity.
is_custom_mode	bool Whether this server farm is in custom mode.
registry_adapters	list[<xref:"RegistryAdapter">] Registry adapters associated with this App Service plan.
install_scripts	list[<xref:"InstallScript">] Install scripts associated with this App Service plan.
network	<xref:<xref:"ServerFarmNetworkSettings">> All network settings for the server farm.
storage_mounts	list[<xref:"StorageMount">] Storage mounts associated with this App Service plan.
rdp_enabled	bool If true, RDP access is enabled for this App Service plan. Only applicable for IsCustomMode ASPs. If false, RDP access is disabled.

Attributes

asyncScalingEnabled

If true, this App Service Plan will attempt to scale asynchronously if there are insufficient workers to scale synchronously. If false, this App Service Plan will only attempt sync scaling.

asyncScalingEnabled: bool

elasticScaleEnabled

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

elasticScaleEnabled: bool

freeOfferExpirationTime

The time when the server farm free offer expires.

freeOfferExpirationTime: str

geoRegion

Geographical location for the App Service plan.

geoRegion: str

hostingEnvironmentProfile

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

hostingEnvironmentProfile: HostingEnvironmentProfile

hyperV

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

hyperV: bool

installScripts

Install scripts associated with this App Service plan.

installScripts: list['InstallScript']

isCustomMode

Whether this server farm is in custom mode.

isCustomMode: bool

isSpot

If true, this App Service Plan owns spot instances.

isSpot: bool

isXenon

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

isXenon: bool

kubeEnvironmentProfile

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

kubeEnvironmentProfile: KubeEnvironmentProfile

maximumElasticWorkerCount

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

maximumElasticWorkerCount: int

maximumNumberOfWorkers

Maximum number of instances that can be assigned to this App Service plan.

maximumNumberOfWorkers: int

network

All network settings for the server farm.

network: ServerFarmNetworkSettings

numberOfSites

Number of apps assigned to this App Service plan.

numberOfSites: int

numberOfWorkers

The number of instances that are assigned to this App Service plan.

numberOfWorkers: int

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: bool

planDefaultIdentity

Identity to use by platform for various features and integrations using managed identity.

planDefaultIdentity: DefaultIdentity

provisioningState

"Succeeded", "Failed", "Canceled", "InProgress", and "Deleting".

provisioningState: str | ProvisioningState

rdpEnabled

If true, RDP access is enabled for this App Service plan. Only applicable for IsCustomMode ASPs. If false, RDP access is disabled.

rdpEnabled: bool

registryAdapters

Registry adapters associated with this App Service plan.

registryAdapters: list['RegistryAdapter']

reserved

If Linux app service plan true, false otherwise.

reserved: bool

resourceGroup

Resource group of the App Service plan.

resourceGroup: str

spotExpirationTime

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

spotExpirationTime: str

status

"Ready", "Pending", and "Creating".

status: str | StatusOptions

storageMounts

Storage mounts associated with this App Service plan.

storageMounts: list['StorageMount']

subscription

App Service plan subscription.

subscription: str

targetWorkerCount

Scaling worker count.

targetWorkerCount: int

targetWorkerSizeId

Scaling worker size ID.

targetWorkerSizeId: int

workerTierName

Target worker tier assigned to the App Service plan.

workerTierName: str

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: bool