AppServiceEnvironment Class

Description of an App Service Environment.

Constructor

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

Variables

Name Description
provisioning_state

Provisioning state of the App Service Environment. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", and "Deleting".

status

Current status of the App Service Environment. Known values are: "Preparing", "Ready", "Scaling", and "Deleting".

virtual_network

Description of the Virtual Network. Required.

internal_load_balancing_mode

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

multi_size
str

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

multi_role_count
int

Number of front-end instances.

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.

maximum_number_of_machines
int

Maximum number of VMs in the App Service Environment.

front_end_scale_factor
int

Scale factor for front-ends.

suspended

true if the App Service Environment is suspended; otherwise, false. 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

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

user_whitelisted_ip_ranges

User added ip ranges to whitelist on ASE db.

has_linux_workers

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

upgrade_preference

Upgrade Preference. Known values are: "None", "Early", "Late", and "Manual".

dedicated_host_count
int

Dedicated Host Count.

zone_redundant

Whether or not this App Service Environment is zone-redundant.

custom_dns_suffix_configuration

Full view of the custom domain suffix configuration for ASEv3.

networking_configuration

Full view of networking configuration for an ASE.

upgrade_availability

Whether an upgrade is available for this App Service Environment. Known values are: "None" and "Ready".

Attributes

cluster_settings

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

cluster_settings: list['_models.NameValuePair'] | None

custom_dns_suffix_configuration

Full view of the custom domain suffix configuration for ASEv3.

custom_dns_suffix_configuration: _models.CustomDnsSuffixConfiguration | None

dedicated_host_count

Dedicated Host Count.

dedicated_host_count: int | None

dns_suffix

DNS suffix of the App Service Environment.

dns_suffix: str | None

front_end_scale_factor

Scale factor for front-ends.

front_end_scale_factor: int | None

has_linux_workers

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

has_linux_workers: bool | None

internal_load_balancing_mode

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

internal_load_balancing_mode: str | _models.LoadBalancingMode | None

ipssl_address_count

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

ipssl_address_count: int | None

maximum_number_of_machines

Maximum number of VMs in the App Service Environment.

maximum_number_of_machines: int | None

multi_role_count

Number of front-end instances.

multi_role_count: int | None

multi_size

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

multi_size: str | None

networking_configuration

Full view of networking configuration for an ASE.

networking_configuration: _models.AseV3NetworkingConfiguration | None

provisioning_state

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

provisioning_state: str | _models.ProvisioningState | None

status

"Preparing", "Ready", "Scaling", and "Deleting".

status: str | _models.HostingEnvironmentStatus | None

suspended

true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).

suspended: bool | None

upgrade_availability

"None" and "Ready".

upgrade_availability: str | _models.UpgradeAvailability | None

upgrade_preference

"None", "Early", "Late", and "Manual".

upgrade_preference: str | _models.UpgradePreference | None

user_whitelisted_ip_ranges

User added ip ranges to whitelist on ASE db.

user_whitelisted_ip_ranges: list[str] | None

virtual_network

Description of the Virtual Network. Required.

virtual_network: _models.VirtualNetworkProfile

zone_redundant

Whether or not this App Service Environment is zone-redundant.

zone_redundant: bool | None