azure.mgmt.web.models.AppServicePlanProperties class

Constructor

AppServicePlanProperties(*args: Any, **kwargs: Any)

Variables

Name	Description
worker_tier_name	str Target worker tier assigned to the App Service plan.
status	str or StatusOptions App Service plan status. Known values are: "Ready", "Pending", and "Creating".
subscription	str App Service plan subscription.
hosting_environment_profile	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	datetime The time when the server farm expires. Valid only if it is a spot server farm.
free_offer_expiration_time	datetime 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	str or ProvisioningState Provisioning state of the App Service Plan. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", and "Deleting".
kube_environment_profile	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	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[RegistryAdapter] Registry adapters associated with this App Service plan.
install_scripts	list[InstallScript] Install scripts associated with this App Service plan.
network	ServerFarmNetworkSettings All network settings for the server farm.
storage_mounts	list[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.

async_scaling_enabled

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.

async_scaling_enabled: bool | None

elastic_scale_enabled

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

elastic_scale_enabled: bool | None

free_offer_expiration_time

The time when the server farm free offer expires.

free_offer_expiration_time: datetime | None

geo_region

Geographical location for the App Service plan.

geo_region: str | None

hosting_environment_profile

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

hosting_environment_profile: _models.HostingEnvironmentProfile | None

hyper_v

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

hyper_v: bool | None

install_scripts

Install scripts associated with this App Service plan.

install_scripts: list['_models.InstallScript'] | None

is_custom_mode

Whether this server farm is in custom mode.

is_custom_mode: bool | None

is_spot

If true, this App Service Plan owns spot instances.

is_spot: bool | None

is_xenon

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

is_xenon: bool | None

kube_environment_profile

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

kube_environment_profile: _models.KubeEnvironmentProfile | None

maximum_elastic_worker_count

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

maximum_elastic_worker_count: int | None

maximum_number_of_workers

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

maximum_number_of_workers: int | None

network

All network settings for the server farm.

network: _models.ServerFarmNetworkSettings | None

number_of_sites

Number of apps assigned to this App Service plan.

number_of_sites: int | None

number_of_workers

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

number_of_workers: int | None

per_site_scaling

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.

per_site_scaling: bool | None

plan_default_identity

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

plan_default_identity: _models.DefaultIdentity | None

provisioning_state

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

provisioning_state: str | _models.ProvisioningState | None

rdp_enabled

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

rdp_enabled: bool | None

registry_adapters

Registry adapters associated with this App Service plan.

registry_adapters: list['_models.RegistryAdapter'] | None

reserved

If Linux app service plan true, false otherwise.

reserved: bool | None

resource_group

Resource group of the App Service plan.

resource_group: str | None

spot_expiration_time

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

spot_expiration_time: datetime | None

status

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

status: str | _models.StatusOptions | None

storage_mounts

Storage mounts associated with this App Service plan.

storage_mounts: list['_models.StorageMount'] | None

subscription

App Service plan subscription.

subscription: str | None

target_worker_count

Scaling worker count.

target_worker_count: int | None

target_worker_size_id

Scaling worker size ID.

target_worker_size_id: int | None

worker_tier_name

Target worker tier assigned to the App Service plan.

worker_tier_name: str | None

zone_redundant

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

zone_redundant: bool | None