Share via

AppServiceEnvironmentResource Class

  • Reference

App Service Environment ARM resource.

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
AppServiceEnvironmentResource

Constructor

AppServiceEnvironmentResource(*, location: str, kind: str | None = None, tags: Dict[str, str] | None = None, virtual_network: _models.VirtualNetworkProfile | None = None, internal_load_balancing_mode: str | _models.LoadBalancingMode | None = None, multi_size: str | None = None, ipssl_address_count: int | None = None, dns_suffix: str | None = None, front_end_scale_factor: int | None = None, cluster_settings: List[_models.NameValuePair] | None = None, user_whitelisted_ip_ranges: List[str] | None = None, upgrade_preference: str | _models.UpgradePreference = 'None', dedicated_host_count: int | None = None, zone_redundant: bool | None = None, custom_dns_suffix_configuration: _models.CustomDnsSuffixConfiguration | None = None, networking_configuration: _models.AseV3NetworkingConfiguration | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
kind
str

Kind of resource.
location
str

Resource Location. Required.
tags
dict[str, str]

Resource tags.
virtual_network
VirtualNetworkProfile

Description of the Virtual Network.
internal_load_balancing_mode
str or LoadBalancingMode

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".
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.
front_end_scale_factor
int

Scale factor for front-ends.
cluster_settings
list[NameValuePair]

Custom settings for changing the behavior of the App Service Environment.
user_whitelisted_ip_ranges
list[str]

User added ip ranges to whitelist on ASE db.
upgrade_preference
str or UpgradePreference

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

Default value: None
dedicated_host_count
int

Dedicated Host Count.
zone_redundant
bool

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

Full view of the custom domain suffix configuration for ASEv3.
networking_configuration
AseV3NetworkingConfiguration

Full view of networking configuration for an ASE.

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.
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".
virtual_network
VirtualNetworkProfile

Description of the Virtual Network.
internal_load_balancing_mode
str or LoadBalancingMode

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
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).
cluster_settings
list[NameValuePair]

Custom settings for changing the behavior of the App Service Environment.
user_whitelisted_ip_ranges
list[str]

User added ip ranges to whitelist on ASE db.
has_linux_workers
bool

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

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

Dedicated Host Count.
zone_redundant
bool

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

Full view of the custom domain suffix configuration for ASEv3.
networking_configuration
AseV3NetworkingConfiguration

Full view of networking configuration for an ASE.
upgrade_availability
str or UpgradeAvailability

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