azure.mgmt.web.v2019_08_01.models.AppServiceEnvironmentResource.yml

### YamlMime:PythonClass
uid: azure.mgmt.web.v2019_08_01.models.AppServiceEnvironmentResource
name: AppServiceEnvironmentResource
fullName: azure.mgmt.web.v2019_08_01.models.AppServiceEnvironmentResource
module: azure.mgmt.web.v2019_08_01.models
inheritances:
- azure.mgmt.web.v2019_08_01.models._models_py3.Resource
summary: '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.'
constructor:
  syntax: 'AppServiceEnvironmentResource(*, location: str, kind: str | None = None,
    tags: Dict[str, str] | None = None, name_properties_name: str | None = None, location_properties_location:
    str | None = None, vnet_name: str | None = None, vnet_resource_group_name: str
    | None = None, vnet_subnet_name: str | None = None, virtual_network: _models.VirtualNetworkProfile
    | None = None, internal_load_balancing_mode: str | _models.InternalLoadBalancingMode
    | None = None, multi_size: str | None = None, multi_role_count: int | None = None,
    worker_pools: List[_models.WorkerPool] | 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, has_linux_workers: bool | None = None, ssl_cert_key_vault_id:
    str | None = None, ssl_cert_key_vault_secret_name: str | None = None, **kwargs:
    Any)'
  keywordOnlyParameters:
  - name: kind
    description: Kind of resource.
    types:
    - <xref:str>
  - name: location
    description: Resource Location. Required.
    types:
    - <xref:str>
  - name: tags
    description: Resource tags.
    types:
    - <xref:dict>[<xref:str>, <xref:str>]
  - name: name_properties_name
    description: Name of the App Service Environment.
    types:
    - <xref:str>
  - name: location_properties_location
    description: Location of the App Service Environment, e.g. "West US".
    types:
    - <xref:str>
  - name: vnet_name
    description: Name of the Virtual Network for the App Service Environment.
    types:
    - <xref:str>
  - name: vnet_resource_group_name
    description: Resource group of the Virtual Network.
    types:
    - <xref:str>
  - name: vnet_subnet_name
    description: Subnet of the Virtual Network.
    types:
    - <xref:str>
  - name: virtual_network
    description: Description of the Virtual Network.
    types:
    - <xref:azure.mgmt.web.v2019_08_01.models.VirtualNetworkProfile>
  - name: internal_load_balancing_mode
    description: 'Specifies which endpoints to serve internally in the

      Virtual Network for the App Service Environment. Known values are: "None", "Web",
      and

      "Publishing".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.web.v2019_08_01.models.InternalLoadBalancingMode>
  - name: multi_size
    description: Front-end VM size, e.g. "Medium", "Large".
    types:
    - <xref:str>
  - name: multi_role_count
    description: Number of front-end instances.
    types:
    - <xref:int>
  - name: worker_pools
    description: 'Description of worker pools with worker size IDs, VM sizes, and
      number

      of workers in each pool.'
    types:
    - <xref:list>[<xref:azure.mgmt.web.v2019_08_01.models.WorkerPool>]
  - name: ipssl_address_count
    description: 'Number of IP SSL addresses reserved for the App Service

      Environment.'
    types:
    - <xref:int>
  - name: dns_suffix
    description: DNS suffix of the App Service Environment.
    types:
    - <xref:str>
  - name: network_access_control_list
    description: 'Access control list for controlling traffic to the App

      Service Environment.'
    types:
    - <xref:list>[<xref:azure.mgmt.web.v2019_08_01.models.NetworkAccessControlEntry>]
  - name: front_end_scale_factor
    description: Scale factor for front-ends.
    types:
    - <xref:int>
  - name: api_management_account_id
    description: 'API Management Account associated with the App Service

      Environment.'
    types:
    - <xref:str>
  - name: suspended
    description: "`<code>true</code>` if the App Service Environment is suspended;\n\
      otherwise, `<code>false</code>`. The environment can be suspended, e.g. when\
      \ the\nmanagement endpoint is no longer available\n\n   (most likely because\
      \ NSG blocked the incoming traffic)."
    types:
    - <xref:bool>
  - name: dynamic_cache_enabled
    description: '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).'
    types:
    - <xref:bool>
  - name: cluster_settings
    description: 'Custom settings for changing the behavior of the App Service

      Environment.'
    types:
    - <xref:list>[<xref:azure.mgmt.web.v2019_08_01.models.NameValuePair>]
  - name: user_whitelisted_ip_ranges
    description: User added list of IP Ranges allowed on ASE db.
    types:
    - <xref:list>[<xref:str>]
  - name: has_linux_workers
    description: Flag that displays whether an ASE has linux workers or not.
    types:
    - <xref:bool>
  - name: ssl_cert_key_vault_id
    description: 'Key Vault ID for ILB App Service Environment default SSL

      certificate.'
    types:
    - <xref:str>
  - name: ssl_cert_key_vault_secret_name
    description: 'Key Vault Secret Name for ILB App Service Environment

      default SSL certificate.'
    types:
    - <xref:str>
variables:
- description: Resource Id.
  name: id
  types:
  - <xref:str>
- description: Resource Name.
  name: name
  types:
  - <xref:str>
- description: Kind of resource.
  name: kind
  types:
  - <xref:str>
- description: Resource Location. Required.
  name: location
  types:
  - <xref:str>
- description: Resource type.
  name: type
  types:
  - <xref:str>
- description: Resource tags.
  name: tags
  types:
  - <xref:dict>[<xref:str>, <xref:str>]
- description: Name of the App Service Environment.
  name: name_properties_name
  types:
  - <xref:str>
- description: Location of the App Service Environment, e.g. "West US".
  name: location_properties_location
  types:
  - <xref:str>
- description: 'Provisioning state of the App Service Environment. Known values are:

    "Succeeded", "Failed", "Canceled", "InProgress", and "Deleting".'
  name: provisioning_state
  types:
  - <xref:str>
  - <xref:azure.mgmt.web.v2019_08_01.models.ProvisioningState>
- description: 'Current status of the App Service Environment. Known values are: "Preparing",

    "Ready", "Scaling", and "Deleting".'
  name: status
  types:
  - <xref:str>
  - <xref:azure.mgmt.web.v2019_08_01.models.HostingEnvironmentStatus>
- description: Name of the Virtual Network for the App Service Environment.
  name: vnet_name
  types:
  - <xref:str>
- description: Resource group of the Virtual Network.
  name: vnet_resource_group_name
  types:
  - <xref:str>
- description: Subnet of the Virtual Network.
  name: vnet_subnet_name
  types:
  - <xref:str>
- description: Description of the Virtual Network.
  name: virtual_network
  types:
  - <xref:azure.mgmt.web.v2019_08_01.models.VirtualNetworkProfile>
- description: 'Specifies which endpoints to serve internally in the

    Virtual Network for the App Service Environment. Known values are: "None", "Web",
    and

    "Publishing".'
  name: internal_load_balancing_mode
  types:
  - <xref:str>
  - <xref:azure.mgmt.web.v2019_08_01.models.InternalLoadBalancingMode>
- description: Front-end VM size, e.g. "Medium", "Large".
  name: multi_size
  types:
  - <xref:str>
- description: Number of front-end instances.
  name: multi_role_count
  types:
  - <xref:int>
- description: 'Description of worker pools with worker size IDs, VM sizes, and number
    of

    workers in each pool.'
  name: worker_pools
  types:
  - <xref:list>[<xref:azure.mgmt.web.v2019_08_01.models.WorkerPool>]
- description: Number of IP SSL addresses reserved for the App Service Environment.
  name: ipssl_address_count
  types:
  - <xref:int>
- description: 'Edition of the metadata database for the App Service Environment,
    e.g.

    "Standard".'
  name: database_edition
  types:
  - <xref:str>
- description: 'Service objective of the metadata database for the App

    Service Environment, e.g. "S0".'
  name: database_service_objective
  types:
  - <xref:str>
- description: Number of upgrade domains of the App Service Environment.
  name: upgrade_domains
  types:
  - <xref:int>
- description: Subscription of the App Service Environment.
  name: subscription_id
  types:
  - <xref:str>
- description: DNS suffix of the App Service Environment.
  name: dns_suffix
  types:
  - <xref:str>
- description: Last deployment action on the App Service Environment.
  name: last_action
  types:
  - <xref:str>
- description: Result of the last deployment action on the App Service Environment.
  name: last_action_result
  types:
  - <xref:str>
- description: 'List of comma separated strings describing which VM sizes are

    allowed for front-ends.'
  name: allowed_multi_sizes
  types:
  - <xref:str>
- description: 'List of comma separated strings describing which VM sizes are

    allowed for workers.'
  name: allowed_worker_sizes
  types:
  - <xref:str>
- description: Maximum number of VMs in the App Service Environment.
  name: maximum_number_of_machines
  types:
  - <xref:int>
- description: Description of IP SSL mapping for the App Service Environment.
  name: vip_mappings
  types:
  - <xref:list>[<xref:azure.mgmt.web.v2019_08_01.models.VirtualIPMapping>]
- description: Current total, used, and available worker capacities.
  name: environment_capacities
  types:
  - <xref:list>[<xref:azure.mgmt.web.v2019_08_01.models.StampCapacity>]
- description: 'Access control list for controlling traffic to the App

    Service Environment.'
  name: network_access_control_list
  types:
  - <xref:list>[<xref:azure.mgmt.web.v2019_08_01.models.NetworkAccessControlEntry>]
- description: 'True/false indicating whether the App Service Environment is

    healthy.'
  name: environment_is_healthy
  types:
  - <xref:bool>
- description: 'Detailed message about with results of the last check of the App

    Service Environment.'
  name: environment_status
  types:
  - <xref:str>
- description: Resource group of the App Service Environment.
  name: resource_group
  types:
  - <xref:str>
- description: Scale factor for front-ends.
  name: front_end_scale_factor
  types:
  - <xref:int>
- description: Default Scale Factor for FrontEnds.
  name: default_front_end_scale_factor
  types:
  - <xref:int>
- description: 'API Management Account associated with the App Service

    Environment.'
  name: api_management_account_id
  types:
  - <xref:str>
- description: "`<code>true</code>` if the App Service Environment is suspended;\n\
    otherwise, `<code>false</code>`. The environment can be suspended, e.g. when the\n\
    management endpoint is no longer available\n\n   (most likely because NSG blocked\
    \ the incoming traffic)."
  name: suspended
  types:
  - <xref:bool>
- description: '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).'
  name: dynamic_cache_enabled
  types:
  - <xref:bool>
- description: 'Custom settings for changing the behavior of the App Service

    Environment.'
  name: cluster_settings
  types:
  - <xref:list>[<xref:azure.mgmt.web.v2019_08_01.models.NameValuePair>]
- description: User added list of IP Ranges allowed on ASE db.
  name: user_whitelisted_ip_ranges
  types:
  - <xref:list>[<xref:str>]
- description: Flag that displays whether an ASE has linux workers or not.
  name: has_linux_workers
  types:
  - <xref:bool>
- description: 'Key Vault ID for ILB App Service Environment default SSL

    certificate.'
  name: ssl_cert_key_vault_id
  types:
  - <xref:str>
- description: 'Key Vault Secret Name for ILB App Service Environment

    default SSL certificate.'
  name: ssl_cert_key_vault_secret_name
  types:
  - <xref:str>