AppServiceEnvironment Class

Reference

Description of an App Service Environment.

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._serialization.Model

AppServiceEnvironment

Constructor

AppServiceEnvironment(*, name: str, location: str, virtual_network: _models.VirtualNetworkProfile, worker_pools: List[_models.WorkerPool], vnet_name: str | None = None, vnet_resource_group_name: str | None = None, vnet_subnet_name: str | None = None, internal_load_balancing_mode: str | _models.InternalLoadBalancingMode | None = None, multi_size: str | None = None, multi_role_count: int | None = None, ipssl_address_count: int | None = None, dns_suffix: str | None = None, network_access_control_list: List[_models.NetworkAccessControlEntry] | None = None, front_end_scale_factor: int | None = None, api_management_account_id: str | None = None, suspended: bool | None = None, dynamic_cache_enabled: bool | None = None, cluster_settings: List[_models.NameValuePair] | None = None, user_whitelisted_ip_ranges: List[str] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
name	str Name of the App Service Environment. Required.
location	str Location of the App Service Environment, e.g. "West US". Required.
vnet_name	str Name of the Virtual Network for the App Service Environment.
vnet_resource_group_name	str Resource group of the Virtual Network.
vnet_subnet_name	str Subnet of the Virtual Network.
virtual_network	VirtualNetworkProfile Description of the Virtual Network. Required.
internal_load_balancing_mode	str or InternalLoadBalancingMode Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Known values are: "None", "Web", and "Publishing".
multi_size	str Front-end VM size, e.g. "Medium", "Large".
multi_role_count	int Number of front-end instances.
worker_pools	list[WorkerPool] Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool. Required.
ipssl_address_count	int Number of IP SSL addresses reserved for the App Service Environment.
dns_suffix	str DNS suffix of the App Service Environment.
network_access_control_list	list[NetworkAccessControlEntry] Access control list for controlling traffic to the App Service Environment.
front_end_scale_factor	int Scale factor for front-ends.
api_management_account_id	str API Management Account associated with the App Service Environment.
suspended	bool `<code>true</code>` if the App Service Environment is suspended; otherwise, `<code>false</code>`. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
dynamic_cache_enabled	bool True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
cluster_settings	list[NameValuePair] Custom settings for changing the behavior of the App Service Environment.
user_whitelisted_ip_ranges	list[str] User added list of IP Ranges allowed on ASE db.

Variables

Name	Description
name	str Name of the App Service Environment. Required.
location	str Location of the App Service Environment, e.g. "West US". Required.
provisioning_state	str or ProvisioningState Provisioning state of the App Service Environment. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", and "Deleting".
status	str or HostingEnvironmentStatus Current status of the App Service Environment. Known values are: "Preparing", "Ready", "Scaling", and "Deleting".
vnet_name	str Name of the Virtual Network for the App Service Environment.
vnet_resource_group_name	str Resource group of the Virtual Network.
vnet_subnet_name	str Subnet of the Virtual Network.
virtual_network	VirtualNetworkProfile Description of the Virtual Network. Required.
internal_load_balancing_mode	str or InternalLoadBalancingMode Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Known values are: "None", "Web", and "Publishing".
multi_size	str Front-end VM size, e.g. "Medium", "Large".
multi_role_count	int Number of front-end instances.
worker_pools	list[WorkerPool] Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool. Required.
ipssl_address_count	int Number of IP SSL addresses reserved for the App Service Environment.
database_edition	str Edition of the metadata database for the App Service Environment, e.g. "Standard".
database_service_objective	str Service objective of the metadata database for the App Service Environment, e.g. "S0".
upgrade_domains	int Number of upgrade domains of the App Service Environment.
subscription_id	str Subscription of the App Service Environment.
dns_suffix	str DNS suffix of the App Service Environment.
last_action	str Last deployment action on the App Service Environment.
last_action_result	str Result of the last deployment action on the App Service Environment.
allowed_multi_sizes	str List of comma separated strings describing which VM sizes are allowed for front-ends.
allowed_worker_sizes	str List of comma separated strings describing which VM sizes are allowed for workers.
maximum_number_of_machines	int Maximum number of VMs in the App Service Environment.
vip_mappings	list[VirtualIPMapping] Description of IP SSL mapping for the App Service Environment.
environment_capacities	list[StampCapacity] Current total, used, and available worker capacities.
network_access_control_list	list[NetworkAccessControlEntry] Access control list for controlling traffic to the App Service Environment.
environment_is_healthy	bool True/false indicating whether the App Service Environment is healthy.
environment_status	str Detailed message about with results of the last check of the App Service Environment.
resource_group	str Resource group of the App Service Environment.
front_end_scale_factor	int Scale factor for front-ends.
default_front_end_scale_factor	int Default Scale Factor for FrontEnds.
api_management_account_id	str API Management Account associated with the App Service Environment.
suspended	bool `<code>true</code>` if the App Service Environment is suspended; otherwise, `<code>false</code>`. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
dynamic_cache_enabled	bool True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
cluster_settings	list[NameValuePair] Custom settings for changing the behavior of the App Service Environment.
user_whitelisted_ip_ranges	list[str] User added list of IP Ranges allowed on ASE db.

Share via

AppServiceEnvironment Class

Constructor

Keyword-Only Parameters

Variables

Additional resources