AppServicePlan Class

Reference

App Service plan.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Inheritance: azure.mgmt.web.v2022_09_01.models._models_py3.Resource

AppServicePlan

Constructor

AppServicePlan(*, location: str, kind: str | None = None, tags: Dict[str, str] | None = None, sku: _models.SkuDescription | None = None, extended_location: _models.ExtendedLocation | None = None, worker_tier_name: str | None = None, hosting_environment_profile: _models.HostingEnvironmentProfile | None = None, per_site_scaling: bool = False, elastic_scale_enabled: bool | None = None, maximum_elastic_worker_count: int | None = None, is_spot: bool | None = None, spot_expiration_time: datetime | None = None, free_offer_expiration_time: datetime | None = None, reserved: bool = False, is_xenon: bool = False, hyper_v: bool = False, target_worker_count: int | None = None, target_worker_size_id: int | None = None, kube_environment_profile: _models.KubeEnvironmentProfile | None = None, zone_redundant: bool = False, **kwargs: Any)

Keyword-Only Parameters

Name	Description
kind	str Kind of resource.
location	str Resource Location. Required.
tags	dict[str, str] Resource tags.
sku	SkuDescription Description of a SKU for a scalable resource.
extended_location	ExtendedLocation Extended Location.
worker_tier_name	str Target worker tier assigned to the App Service plan.
hosting_environment_profile	HostingEnvironmentProfile Specification for the App Service Environment to use for the App Service plan.
per_site_scaling	bool If `<code>true</code>`, apps assigned to this App Service plan can be scaled independently. If `<code>false</code>`, 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.
is_spot	bool If `<code>true</code>`, 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.
reserved	bool If Linux app service plan `<code>true</code>`, `<code>false</code>` otherwise.
is_xenon	bool Obsolete: If Hyper-V container app service plan `<code>true</code>`, `<code>false</code>` otherwise.
hyper_v	bool If Hyper-V container app service plan `<code>true</code>`, `<code>false</code>` otherwise.
target_worker_count	int Scaling worker count.
target_worker_size_id	int Scaling worker size ID.
kube_environment_profile	KubeEnvironmentProfile Specification for the Kubernetes Environment to use for the App Service plan.
zone_redundant	bool If `<code>true</code>`, this App Service Plan will perform availability zone balancing. If `<code>false</code>`, this App Service Plan will not perform availability zone balancing.

Variables

Name	Description
id	str Resource Id.
name	str Resource Name.
kind	str Kind of resource.
location	str Resource Location. Required.
type	str Resource type.
tags	dict[str, str] Resource tags.
sku	SkuDescription Description of a SKU for a scalable resource.
extended_location	ExtendedLocation Extended Location.
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 `<code>true</code>`, apps assigned to this App Service plan can be scaled independently. If `<code>false</code>`, 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 `<code>true</code>`, 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 `<code>true</code>`, `<code>false</code>` otherwise.
is_xenon	bool Obsolete: If Hyper-V container app service plan `<code>true</code>`, `<code>false</code>` otherwise.
hyper_v	bool If Hyper-V container app service plan `<code>true</code>`, `<code>false</code>` 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 `<code>true</code>`, this App Service Plan will perform availability zone balancing. If `<code>false</code>`, this App Service Plan will not perform availability zone balancing.

Share via

AppServicePlan Class

Constructor

Keyword-Only Parameters

Variables

Additional resources