Feedback Edit

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 Azure.

Inheritance
Model
AppServiceEnvironment

Constructor

AppServiceEnvironment(*, name: str, location: str, virtual_network: azure.mgmt.web.v2019_08_01.models._models_py3.VirtualNetworkProfile, worker_pools: List[azure.mgmt.web.v2019_08_01.models._models_py3.WorkerPool], vnet_name: Optional[str] = None, vnet_resource_group_name: Optional[str] = None, vnet_subnet_name: Optional[str] = None, internal_load_balancing_mode: Optional[Union[str, azure.mgmt.web.v2019_08_01.models._web_site_management_client_enums.InternalLoadBalancingMode]] = None, multi_size: Optional[str] = None, multi_role_count: Optional[int] = None, ipssl_address_count: Optional[int] = None, dns_suffix: Optional[str] = None, network_access_control_list: Optional[List[azure.mgmt.web.v2019_08_01.models._models_py3.NetworkAccessControlEntry]] = None, front_end_scale_factor: Optional[int] = None, api_management_account_id: Optional[str] = None, suspended: Optional[bool] = None, dynamic_cache_enabled: Optional[bool] = None, cluster_settings: Optional[List[azure.mgmt.web.v2019_08_01.models._models_py3.NameValuePair]] = None, user_whitelisted_ip_ranges: Optional[List[str]] = None, has_linux_workers: Optional[bool] = None, ssl_cert_key_vault_id: Optional[str] = None, ssl_cert_key_vault_secret_name: Optional[str] = None, **kwargs)

Parameters

name
str
Required

Required. Name of the App Service Environment.

location
str
Required

Required. Location of the App Service Environment, e.g. "West US".

vnet_name
str
Required

Name of the Virtual Network for the App Service Environment.

vnet_resource_group_name
str
Required

Resource group of the Virtual Network.

vnet_subnet_name
str
Required

Subnet of the Virtual Network.

virtual_network
VirtualNetworkProfile
Required

Required. Description of the Virtual Network.

internal_load_balancing_mode
str or InternalLoadBalancingMode
Required

Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values include: "None", "Web", "Publishing".

multi_size
str
Required

Front-end VM size, e.g. "Medium", "Large".

multi_role_count
int
Required

Number of front-end instances.

worker_pools
list[WorkerPool]
Required

Required. Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.

ipssl_address_count
int
Required

Number of IP SSL addresses reserved for the App Service Environment.

dns_suffix
str
Required

DNS suffix of the App Service Environment.

network_access_control_list
list[NetworkAccessControlEntry]
Required

Access control list for controlling traffic to the App Service Environment.

front_end_scale_factor
int
Required

Scale factor for front-ends.

api_management_account_id
str
Required

API Management Account associated with the App Service Environment.

suspended
bool
Required

<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
Required

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]
Required

Custom settings for changing the behavior of the App Service Environment.

user_whitelisted_ip_ranges
list[str]
Required

User added ip ranges to whitelist on ASE db.

has_linux_workers
bool
Required

Flag that displays whether an ASE has linux workers or not.

ssl_cert_key_vault_id
str
Required

Key Vault ID for ILB App Service Environment default SSL certificate.

ssl_cert_key_vault_secret_name
str
Required

Key Vault Secret Name for ILB App Service Environment default SSL certificate.

Variables

provisioning_state
str or ProvisioningState

Provisioning state of the App Service Environment. Possible values include: "Succeeded", "Failed", "Canceled", "InProgress", "Deleting".

status
str or HostingEnvironmentStatus

Current status of the App Service Environment. Possible values include: "Preparing", "Ready", "Scaling", "Deleting".

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.

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.

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.

default_front_end_scale_factor
int

Default Scale Factor for FrontEnds.