app_service_environments

Creates, updates, deletes, gets or lists an app_service_environments resource.

Overview

Name	app_service_environments
Type	Resource
Id	azure.web.app_service_environments

Fields

The following fields are returned by SELECT queries:

list_worker_pool_instance_metric_definitions

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource Name.
kind	string	Kind of resource.
metricAvailabilities	array	List of time grains supported for the metric together with retention period.
primaryAggregationType	string	Primary aggregation type.
properties	object	Resource metric definition properties.
resourceUri	string	Resource URI.
type	string	Resource type.
unit	string	Unit of the metric.

list_web_worker_metric_definitions

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource Name.
kind	string	Kind of resource.
metricAvailabilities	array	List of time grains supported for the metric together with retention period.
primaryAggregationType	string	Primary aggregation type.
properties	object	Resource metric definition properties.
resourceUri	string	Resource URI.
type	string	Resource type.
unit	string	Unit of the metric.

list_multi_role_pool_instance_metric_definitions

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource Name.
kind	string	Kind of resource.
metricAvailabilities	array	List of time grains supported for the metric together with retention period.
primaryAggregationType	string	Primary aggregation type.
properties	object	Resource metric definition properties.
resourceUri	string	Resource URI.
type	string	Resource type.
unit	string	Unit of the metric.

get_diagnostics_item

Name	Datatype	Description
name	string	Name/identifier of the diagnostics.
diagnosticsOutput	string	Diagnostics output.

get_private_endpoint_connection

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
ipAddresses	array	Private IPAddresses mapped to the remote private endpoint.
kind	string	Kind of resource.
privateEndpoint	object	PrivateEndpoint of a remote private endpoint connection.
privateLinkServiceConnectionState	object	The state of a private link connection.
provisioningState	string	:vartype provisioning_state: str
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
clusterSettings	array	Custom settings for changing the behavior of the App Service Environment.
customDnsSuffixConfiguration	object	Full view of the custom domain suffix configuration for ASEv3.
dedicatedHostCount	integer	Dedicated Host Count.
dnsSuffix	string	DNS suffix of the App Service Environment.
frontEndScaleFactor	integer	Scale factor for front-ends.
hasLinuxWorkers	boolean	Flag that displays whether an ASE has linux workers or not.
internalLoadBalancingMode	string	Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Known values are: "None", "Web", "Publishing", and "Web, Publishing". (None, Web, Publishing, Web, Publishing)
ipsslAddressCount	integer	Number of IP SSL addresses reserved for the App Service Environment.
kind	string	Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference _ for details supported values for kind.
location	string	The geo-location where the resource lives. Required.
maximumNumberOfMachines	integer	Maximum number of VMs in the App Service Environment.
multiRoleCount	integer	Number of front-end instances.
multiSize	string	Front-end VM size, e.g. "Medium", "Large".
networkingConfiguration	object	Full view of networking configuration for an ASE.
provisioningState	string	Provisioning state of the App Service Environment. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", and "Deleting". (Succeeded, Failed, Canceled, InProgress, Deleting)
status	string	Current status of the App Service Environment. Known values are: "Preparing", "Ready", "Scaling", and "Deleting". (Preparing, Ready, Scaling, Deleting)
suspended	boolean	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).
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
upgradeAvailability	string	Whether an upgrade is available for this App Service Environment. Known values are: "None" and "Ready". (None, Ready)
upgradePreference	string	Upgrade Preference. Known values are: "None", "Early", "Late", and "Manual". (None, Early, Late, Manual)
userWhitelistedIpRanges	array	User added ip ranges to whitelist on ASE db.
virtualNetwork	object	Description of the Virtual Network. Required.
zoneRedundant	boolean	Whether or not this App Service Environment is zone-redundant.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
clusterSettings	array	Custom settings for changing the behavior of the App Service Environment.
customDnsSuffixConfiguration	object	Full view of the custom domain suffix configuration for ASEv3.
dedicatedHostCount	integer	Dedicated Host Count.
dnsSuffix	string	DNS suffix of the App Service Environment.
frontEndScaleFactor	integer	Scale factor for front-ends.
hasLinuxWorkers	boolean	Flag that displays whether an ASE has linux workers or not.
internalLoadBalancingMode	string	Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Known values are: "None", "Web", "Publishing", and "Web, Publishing". (None, Web, Publishing, Web, Publishing)
ipsslAddressCount	integer	Number of IP SSL addresses reserved for the App Service Environment.
kind	string	Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference _ for details supported values for kind.
location	string	The geo-location where the resource lives. Required.
maximumNumberOfMachines	integer	Maximum number of VMs in the App Service Environment.
multiRoleCount	integer	Number of front-end instances.
multiSize	string	Front-end VM size, e.g. "Medium", "Large".
networkingConfiguration	object	Full view of networking configuration for an ASE.
provisioningState	string	Provisioning state of the App Service Environment. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", and "Deleting". (Succeeded, Failed, Canceled, InProgress, Deleting)
status	string	Current status of the App Service Environment. Known values are: "Preparing", "Ready", "Scaling", and "Deleting". (Preparing, Ready, Scaling, Deleting)
suspended	boolean	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).
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
upgradeAvailability	string	Whether an upgrade is available for this App Service Environment. Known values are: "None" and "Ready". (None, Ready)
upgradePreference	string	Upgrade Preference. Known values are: "None", "Early", "Late", and "Manual". (None, Early, Late, Manual)
userWhitelistedIpRanges	array	User added ip ranges to whitelist on ASE db.
virtualNetwork	object	Description of the Virtual Network. Required.
zoneRedundant	boolean	Whether or not this App Service Environment is zone-redundant.

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
clusterSettings	array	Custom settings for changing the behavior of the App Service Environment.
customDnsSuffixConfiguration	object	Full view of the custom domain suffix configuration for ASEv3.
dedicatedHostCount	integer	Dedicated Host Count.
dnsSuffix	string	DNS suffix of the App Service Environment.
frontEndScaleFactor	integer	Scale factor for front-ends.
hasLinuxWorkers	boolean	Flag that displays whether an ASE has linux workers or not.
internalLoadBalancingMode	string	Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Known values are: "None", "Web", "Publishing", and "Web, Publishing". (None, Web, Publishing, Web, Publishing)
ipsslAddressCount	integer	Number of IP SSL addresses reserved for the App Service Environment.
kind	string	Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference _ for details supported values for kind.
location	string	The geo-location where the resource lives. Required.
maximumNumberOfMachines	integer	Maximum number of VMs in the App Service Environment.
multiRoleCount	integer	Number of front-end instances.
multiSize	string	Front-end VM size, e.g. "Medium", "Large".
networkingConfiguration	object	Full view of networking configuration for an ASE.
provisioningState	string	Provisioning state of the App Service Environment. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", and "Deleting". (Succeeded, Failed, Canceled, InProgress, Deleting)
status	string	Current status of the App Service Environment. Known values are: "Preparing", "Ready", "Scaling", and "Deleting". (Preparing, Ready, Scaling, Deleting)
suspended	boolean	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).
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
upgradeAvailability	string	Whether an upgrade is available for this App Service Environment. Known values are: "None" and "Ready". (None, Ready)
upgradePreference	string	Upgrade Preference. Known values are: "None", "Early", "Late", and "Manual". (None, Early, Late, Manual)
userWhitelistedIpRanges	array	User added ip ranges to whitelist on ASE db.
virtualNetwork	object	Description of the Virtual Network. Required.
zoneRedundant	boolean	Whether or not this App Service Environment is zone-redundant.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_worker_pool_instance_metric_definitions	select	resource_group_name, name, worker_pool_name, instance, subscription_id		Get metric definitions for a specific instance of a worker pool of an App Service Environment. Description for Get metric definitions for a specific instance of a worker pool of an App Service Environment.
list_web_worker_metric_definitions	select	resource_group_name, name, worker_pool_name, subscription_id		Get metric definitions for a worker pool of an App Service Environment. Description for Get metric definitions for a worker pool of an App Service Environment.
list_multi_role_pool_instance_metric_definitions	select	resource_group_name, name, instance, subscription_id		Get metric definitions for a specific instance of a multi-role pool of an App Service Environment. Description for Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.
get_diagnostics_item	select	resource_group_name, name, diagnostics_name, subscription_id		Get a diagnostics item for an App Service Environment. Description for Get a diagnostics item for an App Service Environment.
get_private_endpoint_connection	select	resource_group_name, name, private_endpoint_connection_name, subscription_id		Gets a private endpoint connection. Description for Gets a private endpoint connection.
get	select	resource_group_name, name, subscription_id		Get the properties of an App Service Environment. Description for Get the properties of an App Service Environment.
list_by_resource_group	select	resource_group_name, subscription_id		Get all App Service Environments in a resource group. Description for Get all App Service Environments in a resource group.
list	select	subscription_id		Get all App Service Environments for a subscription. Description for Get all App Service Environments for a subscription.
create_or_update	insert	resource_group_name, name, subscription_id, location		Create or update an App Service Environment. Description for Create or update an App Service Environment.
update	update	resource_group_name, name, subscription_id		Create or update an App Service Environment. Description for Create or update an App Service Environment.
create_or_update	replace	resource_group_name, name, subscription_id, location		Create or update an App Service Environment. Description for Create or update an App Service Environment.
delete	delete	resource_group_name, name, subscription_id	forceDelete	Delete an App Service Environment. Description for Delete an App Service Environment.
list_worker_pools	exec	resource_group_name, name, subscription_id		Get all worker pools of an App Service Environment. Description for Get all worker pools of an App Service Environment.
list_worker_pool_skus	exec	resource_group_name, name, worker_pool_name, subscription_id		Get available SKUs for scaling a worker pool. Description for Get available SKUs for scaling a worker pool.
list_web_worker_usages	exec	resource_group_name, name, worker_pool_name, subscription_id		Get usage metrics for a worker pool of an App Service Environment. Description for Get usage metrics for a worker pool of an App Service Environment.
list_capacities	exec	resource_group_name, name, subscription_id		Get the used, available, and total worker capacity an App Service Environment. Description for Get the used, available, and total worker capacity an App Service Environment.
list_diagnostics	exec	resource_group_name, name, subscription_id		Get diagnostic information for an App Service Environment. Description for Get diagnostic information for an App Service Environment.
list_operations	exec	resource_group_name, name, subscription_id		List all currently running operations on the App Service Environment. Description for List all currently running operations on the App Service Environment.
list_app_service_plans	exec	resource_group_name, name, subscription_id		Get all App Service plans in an App Service Environment. Description for Get all App Service plans in an App Service Environment.
list_web_apps	exec	resource_group_name, name, subscription_id	propertiesToInclude	Get all apps in an App Service Environment. Description for Get all apps in an App Service Environment.
list_usages	exec	resource_group_name, name, subscription_id	$filter	Get global usage metrics of an App Service Environment. Description for Get global usage metrics of an App Service Environment.
list_multi_role_pools	exec	resource_group_name, name, subscription_id		Get all multi-role pools. Description for Get all multi-role pools.
list_multi_role_metric_definitions	exec	resource_group_name, name, subscription_id		Get metric definitions for a multi-role pool of an App Service Environment. Description for Get metric definitions for a multi-role pool of an App Service Environment.
list_multi_role_pool_skus	exec	resource_group_name, name, subscription_id		Get available SKUs for scaling a multi-role pool. Description for Get available SKUs for scaling a multi-role pool.
list_multi_role_usages	exec	resource_group_name, name, subscription_id		Get usage metrics for a multi-role pool of an App Service Environment. Description for Get usage metrics for a multi-role pool of an App Service Environment.
get_worker_pool	exec	resource_group_name, name, worker_pool_name, subscription_id		Get properties of a worker pool. Description for Get properties of a worker pool.
create_or_update_worker_pool	exec	resource_group_name, name, worker_pool_name, subscription_id		Create or update a worker pool. Description for Create or update a worker pool.
update_worker_pool	exec	resource_group_name, name, worker_pool_name, subscription_id		Create or update a worker pool. Description for Create or update a worker pool.
get_inbound_network_dependencies_endpoints	exec	resource_group_name, name, subscription_id		Get the network endpoints of all inbound dependencies of an App Service Environment. Description for Get the network endpoints of all inbound dependencies of an App Service Environment.
get_outbound_network_dependencies_endpoints	exec	resource_group_name, name, subscription_id		Get the network endpoints of all outbound dependencies of an App Service Environment. Description for Get the network endpoints of all outbound dependencies of an App Service Environment.
get_private_link_resources	exec	resource_group_name, name, subscription_id		Gets the private link resources. Description for Gets the private link resources.
get_vip_info	exec	resource_group_name, name, subscription_id		Get IP addresses assigned to an App Service Environment. Description for Get IP addresses assigned to an App Service Environment.
get_ase_custom_dns_suffix_configuration	exec	resource_group_name, name, subscription_id		Get Custom Dns Suffix configuration of an App Service Environment. Get Custom Dns Suffix configuration of an App Service Environment.
update_ase_custom_dns_suffix_configuration	exec	resource_group_name, name, subscription_id		Update Custom Dns Suffix configuration of an App Service Environment. Update Custom Dns Suffix configuration of an App Service Environment.
delete_ase_custom_dns_suffix_configuration	exec	resource_group_name, name, subscription_id		Delete Custom Dns Suffix configuration of an App Service Environment. Delete Custom Dns Suffix configuration of an App Service Environment.
get_ase_v3_networking_configuration	exec	resource_group_name, name, subscription_id		Get networking configuration of an App Service Environment. Description for Get networking configuration of an App Service Environment.
update_ase_networking_configuration	exec	resource_group_name, name, subscription_id		Update networking configuration of an App Service Environment. Description for Update networking configuration of an App Service Environment.
get_multi_role_pool	exec	resource_group_name, name, subscription_id		Get properties of a multi-role pool. Description for Get properties of a multi-role pool.
create_or_update_multi_role_pool	exec	resource_group_name, name, subscription_id		Create or update a multi-role pool. Description for Create or update a multi-role pool.
update_multi_role_pool	exec	resource_group_name, name, subscription_id		Create or update a multi-role pool. Description for Create or update a multi-role pool.
approve_or_reject_private_endpoint_connection	exec	resource_group_name, name, private_endpoint_connection_name, subscription_id		Approves or rejects a private endpoint connection. Description for Approves or rejects a private endpoint connection.
delete_private_endpoint_connection	exec	resource_group_name, name, private_endpoint_connection_name, subscription_id		Deletes a private endpoint connection. Description for Deletes a private endpoint connection.
get_private_endpoint_connection_list	exec	resource_group_name, name, subscription_id		Gets the list of private endpoints associated with a hosting environment. Description for Gets the list of private endpoints associated with a hosting environment.
change_vnet	exec	resource_group_name, name, subscription_id, id		Move an App Service Environment to a different VNET. Description for Move an App Service Environment to a different VNET.
test_upgrade_available_notification	exec	resource_group_name, name, subscription_id		Send a test notification that an upgrade is available for this App Service Environment. Send a test notification that an upgrade is available for this App Service Environment.
upgrade	exec	resource_group_name, name, subscription_id		Initiate an upgrade of an App Service Environment if one is available. Description for Initiate an upgrade of an App Service Environment if one is available.
reboot	exec	resource_group_name, name, subscription_id		Reboot all machines in an App Service Environment. Description for Reboot all machines in an App Service Environment.
resume	exec	resource_group_name, name, subscription_id		Resume an App Service Environment. Description for Resume an App Service Environment.
suspend	exec	resource_group_name, name, subscription_id		Suspend an App Service Environment. Description for Suspend an App Service Environment.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
diagnostics_name	string	Required.
instance	string	Name of the instance in the multi-role pool. Required.
name	string	Name of the App Service Environment. Required.
private_endpoint_connection_name	string	Name of the private endpoint connection. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
worker_pool_name	string	Name of the worker pool. Required.
$filter	string	Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'. Default value is None.
forceDelete	boolean	Specify true to force the deletion even if the App Service Environment contains resources. The default is false. Default value is None.
propertiesToInclude	string	Comma separated list of app properties to include. Default value is None.

SELECT examples

list_worker_pool_instance_metric_definitions

Get metric definitions for a specific instance of a worker pool of an App Service Environment. Description for Get metric definitions for a specific instance of a worker pool of an App Service Environment.

SELECT
id,
name,
kind,
metricAvailabilities,
primaryAggregationType,
properties,
resourceUri,
type,
unit
FROM azure.web.app_service_environments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND worker_pool_name = '{{ worker_pool_name }}' -- required
AND instance = '{{ instance }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_web_worker_metric_definitions

Get metric definitions for a worker pool of an App Service Environment. Description for Get metric definitions for a worker pool of an App Service Environment.

SELECT
id,
name,
kind,
metricAvailabilities,
primaryAggregationType,
properties,
resourceUri,
type,
unit
FROM azure.web.app_service_environments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND worker_pool_name = '{{ worker_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_multi_role_pool_instance_metric_definitions

Get metric definitions for a specific instance of a multi-role pool of an App Service Environment. Description for Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.

SELECT
id,
name,
kind,
metricAvailabilities,
primaryAggregationType,
properties,
resourceUri,
type,
unit
FROM azure.web.app_service_environments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND instance = '{{ instance }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_diagnostics_item

Get a diagnostics item for an App Service Environment. Description for Get a diagnostics item for an App Service Environment.

SELECT
name,
diagnosticsOutput
FROM azure.web.app_service_environments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND diagnostics_name = '{{ diagnostics_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_private_endpoint_connection

Gets a private endpoint connection. Description for Gets a private endpoint connection.

SELECT
id,
name,
ipAddresses,
kind,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
type
FROM azure.web.app_service_environments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Get the properties of an App Service Environment. Description for Get the properties of an App Service Environment.

SELECT
id,
name,
clusterSettings,
customDnsSuffixConfiguration,
dedicatedHostCount,
dnsSuffix,
frontEndScaleFactor,
hasLinuxWorkers,
internalLoadBalancingMode,
ipsslAddressCount,
kind,
location,
maximumNumberOfMachines,
multiRoleCount,
multiSize,
networkingConfiguration,
provisioningState,
status,
suspended,
systemData,
tags,
type,
upgradeAvailability,
upgradePreference,
userWhitelistedIpRanges,
virtualNetwork,
zoneRedundant
FROM azure.web.app_service_environments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Get all App Service Environments in a resource group. Description for Get all App Service Environments in a resource group.

SELECT
id,
name,
clusterSettings,
customDnsSuffixConfiguration,
dedicatedHostCount,
dnsSuffix,
frontEndScaleFactor,
hasLinuxWorkers,
internalLoadBalancingMode,
ipsslAddressCount,
kind,
location,
maximumNumberOfMachines,
multiRoleCount,
multiSize,
networkingConfiguration,
provisioningState,
status,
suspended,
systemData,
tags,
type,
upgradeAvailability,
upgradePreference,
userWhitelistedIpRanges,
virtualNetwork,
zoneRedundant
FROM azure.web.app_service_environments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get all App Service Environments for a subscription. Description for Get all App Service Environments for a subscription.

SELECT
id,
name,
clusterSettings,
customDnsSuffixConfiguration,
dedicatedHostCount,
dnsSuffix,
frontEndScaleFactor,
hasLinuxWorkers,
internalLoadBalancingMode,
ipsslAddressCount,
kind,
location,
maximumNumberOfMachines,
multiRoleCount,
multiSize,
networkingConfiguration,
provisioningState,
status,
suspended,
systemData,
tags,
type,
upgradeAvailability,
upgradePreference,
userWhitelistedIpRanges,
virtualNetwork,
zoneRedundant
FROM azure.web.app_service_environments
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update an App Service Environment. Description for Create or update an App Service Environment.

INSERT INTO azure.web.app_service_environments (
tags,
location,
properties,
kind,
resource_group_name,
name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ kind }}',
'{{ resource_group_name }}',
'{{ name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
kind,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: app_service_environments
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the app_service_environments resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the app_service_environments resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the app_service_environments resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Description of an App Service Environment.
    value:
      provisioningState: "{{ provisioningState }}"
      status: "{{ status }}"
      virtualNetwork:
        id: "{{ id }}"
        name: "{{ name }}"
        type: "{{ type }}"
        subnet: "{{ subnet }}"
      internalLoadBalancingMode: "{{ internalLoadBalancingMode }}"
      multiSize: "{{ multiSize }}"
      multiRoleCount: {{ multiRoleCount }}
      ipsslAddressCount: {{ ipsslAddressCount }}
      dnsSuffix: "{{ dnsSuffix }}"
      maximumNumberOfMachines: {{ maximumNumberOfMachines }}
      frontEndScaleFactor: {{ frontEndScaleFactor }}
      suspended: {{ suspended }}
      clusterSettings:
        - name: "{{ name }}"
          value: "{{ value }}"
      userWhitelistedIpRanges:
        - "{{ userWhitelistedIpRanges }}"
      hasLinuxWorkers: {{ hasLinuxWorkers }}
      upgradePreference: "{{ upgradePreference }}"
      dedicatedHostCount: {{ dedicatedHostCount }}
      zoneRedundant: {{ zoneRedundant }}
      customDnsSuffixConfiguration:
        id: "{{ id }}"
        name: "{{ name }}"
        type: "{{ type }}"
        systemData:
          createdBy: "{{ createdBy }}"
          createdByType: "{{ createdByType }}"
          createdAt: "{{ createdAt }}"
          lastModifiedBy: "{{ lastModifiedBy }}"
          lastModifiedByType: "{{ lastModifiedByType }}"
          lastModifiedAt: "{{ lastModifiedAt }}"
        properties:
          provisioningState: "{{ provisioningState }}"
          provisioningDetails: "{{ provisioningDetails }}"
          dnsSuffix: "{{ dnsSuffix }}"
          certificateUrl: "{{ certificateUrl }}"
          keyVaultReferenceIdentity: "{{ keyVaultReferenceIdentity }}"
        kind: "{{ kind }}"
      networkingConfiguration:
        id: "{{ id }}"
        name: "{{ name }}"
        type: "{{ type }}"
        systemData:
          createdBy: "{{ createdBy }}"
          createdByType: "{{ createdByType }}"
          createdAt: "{{ createdAt }}"
          lastModifiedBy: "{{ lastModifiedBy }}"
          lastModifiedByType: "{{ lastModifiedByType }}"
          lastModifiedAt: "{{ lastModifiedAt }}"
        properties:
          windowsOutboundIpAddresses:
            - "{{ windowsOutboundIpAddresses }}"
          linuxOutboundIpAddresses:
            - "{{ linuxOutboundIpAddresses }}"
          externalInboundIpAddresses:
            - "{{ externalInboundIpAddresses }}"
          internalInboundIpAddresses:
            - "{{ internalInboundIpAddresses }}"
          allowNewPrivateEndpointConnections: {{ allowNewPrivateEndpointConnections }}
          ftpEnabled: {{ ftpEnabled }}
          remoteDebugEnabled: {{ remoteDebugEnabled }}
          inboundIpAddressOverride: "{{ inboundIpAddressOverride }}"
        kind: "{{ kind }}"
      upgradeAvailability: "{{ upgradeAvailability }}"
  - name: kind
    value: "{{ kind }}"
    description: |
      Kind of resource. If the resource is an app, you can refer to `https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference `_ for details supported values for kind.

UPDATE examples

update

Create or update an App Service Environment. Description for Create or update an App Service Environment.

UPDATE azure.web.app_service_environments
SET 
kind = '{{ kind }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
kind,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update an App Service Environment. Description for Create or update an App Service Environment.

REPLACE azure.web.app_service_environments
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
kind = '{{ kind }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
kind,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete an App Service Environment. Description for Delete an App Service Environment.

DELETE FROM azure.web.app_service_environments
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND forceDelete = '{{ forceDelete }}'
;

Lifecycle Methods

list_worker_pools

Get all worker pools of an App Service Environment. Description for Get all worker pools of an App Service Environment.

EXEC azure.web.app_service_environments.list_worker_pools 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_worker_pool_skus

Get available SKUs for scaling a worker pool. Description for Get available SKUs for scaling a worker pool.

EXEC azure.web.app_service_environments.list_worker_pool_skus 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@worker_pool_name='{{ worker_pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_web_worker_usages

Get usage metrics for a worker pool of an App Service Environment. Description for Get usage metrics for a worker pool of an App Service Environment.

EXEC azure.web.app_service_environments.list_web_worker_usages 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@worker_pool_name='{{ worker_pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_capacities

Get the used, available, and total worker capacity an App Service Environment. Description for Get the used, available, and total worker capacity an App Service Environment.

EXEC azure.web.app_service_environments.list_capacities 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_diagnostics

Get diagnostic information for an App Service Environment. Description for Get diagnostic information for an App Service Environment.

EXEC azure.web.app_service_environments.list_diagnostics 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_operations

List all currently running operations on the App Service Environment. Description for List all currently running operations on the App Service Environment.

EXEC azure.web.app_service_environments.list_operations 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_app_service_plans

Get all App Service plans in an App Service Environment. Description for Get all App Service plans in an App Service Environment.

EXEC azure.web.app_service_environments.list_app_service_plans 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_web_apps

Get all apps in an App Service Environment. Description for Get all apps in an App Service Environment.

EXEC azure.web.app_service_environments.list_web_apps 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@propertiesToInclude='{{ propertiesToInclude }}'
;

list_usages

Get global usage metrics of an App Service Environment. Description for Get global usage metrics of an App Service Environment.

EXEC azure.web.app_service_environments.list_usages 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@$filter='{{ $filter }}'
;

list_multi_role_pools

Get all multi-role pools. Description for Get all multi-role pools.

EXEC azure.web.app_service_environments.list_multi_role_pools 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_multi_role_metric_definitions

Get metric definitions for a multi-role pool of an App Service Environment. Description for Get metric definitions for a multi-role pool of an App Service Environment.

EXEC azure.web.app_service_environments.list_multi_role_metric_definitions 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_multi_role_pool_skus

Get available SKUs for scaling a multi-role pool. Description for Get available SKUs for scaling a multi-role pool.

EXEC azure.web.app_service_environments.list_multi_role_pool_skus 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_multi_role_usages

Get usage metrics for a multi-role pool of an App Service Environment. Description for Get usage metrics for a multi-role pool of an App Service Environment.

EXEC azure.web.app_service_environments.list_multi_role_usages 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_worker_pool

Get properties of a worker pool. Description for Get properties of a worker pool.

EXEC azure.web.app_service_environments.get_worker_pool 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@worker_pool_name='{{ worker_pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_or_update_worker_pool

Create or update a worker pool. Description for Create or update a worker pool.

EXEC azure.web.app_service_environments.create_or_update_worker_pool 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@worker_pool_name='{{ worker_pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"sku": "{{ sku }}", 
"kind": "{{ kind }}"
}'
;

update_worker_pool

Create or update a worker pool. Description for Create or update a worker pool.

EXEC azure.web.app_service_environments.update_worker_pool 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@worker_pool_name='{{ worker_pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"sku": "{{ sku }}", 
"kind": "{{ kind }}"
}'
;

get_inbound_network_dependencies_endpoints

Get the network endpoints of all inbound dependencies of an App Service Environment. Description for Get the network endpoints of all inbound dependencies of an App Service Environment.

EXEC azure.web.app_service_environments.get_inbound_network_dependencies_endpoints 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_outbound_network_dependencies_endpoints

Get the network endpoints of all outbound dependencies of an App Service Environment. Description for Get the network endpoints of all outbound dependencies of an App Service Environment.

EXEC azure.web.app_service_environments.get_outbound_network_dependencies_endpoints 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_private_link_resources

Gets the private link resources. Description for Gets the private link resources.

EXEC azure.web.app_service_environments.get_private_link_resources 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_vip_info

Get IP addresses assigned to an App Service Environment. Description for Get IP addresses assigned to an App Service Environment.

EXEC azure.web.app_service_environments.get_vip_info 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_ase_custom_dns_suffix_configuration

Get Custom Dns Suffix configuration of an App Service Environment. Get Custom Dns Suffix configuration of an App Service Environment.

EXEC azure.web.app_service_environments.get_ase_custom_dns_suffix_configuration 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

update_ase_custom_dns_suffix_configuration

Update Custom Dns Suffix configuration of an App Service Environment. Update Custom Dns Suffix configuration of an App Service Environment.

EXEC azure.web.app_service_environments.update_ase_custom_dns_suffix_configuration 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"kind": "{{ kind }}"
}'
;

delete_ase_custom_dns_suffix_configuration

Delete Custom Dns Suffix configuration of an App Service Environment. Delete Custom Dns Suffix configuration of an App Service Environment.

EXEC azure.web.app_service_environments.delete_ase_custom_dns_suffix_configuration 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_ase_v3_networking_configuration

Get networking configuration of an App Service Environment. Description for Get networking configuration of an App Service Environment.

EXEC azure.web.app_service_environments.get_ase_v3_networking_configuration 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

update_ase_networking_configuration

Update networking configuration of an App Service Environment. Description for Update networking configuration of an App Service Environment.

EXEC azure.web.app_service_environments.update_ase_networking_configuration 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"kind": "{{ kind }}"
}'
;

get_multi_role_pool

Get properties of a multi-role pool. Description for Get properties of a multi-role pool.

EXEC azure.web.app_service_environments.get_multi_role_pool 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_or_update_multi_role_pool

Create or update a multi-role pool. Description for Create or update a multi-role pool.

EXEC azure.web.app_service_environments.create_or_update_multi_role_pool 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"sku": "{{ sku }}", 
"kind": "{{ kind }}"
}'
;

update_multi_role_pool

Create or update a multi-role pool. Description for Create or update a multi-role pool.

EXEC azure.web.app_service_environments.update_multi_role_pool 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"sku": "{{ sku }}", 
"kind": "{{ kind }}"
}'
;

approve_or_reject_private_endpoint_connection

Approves or rejects a private endpoint connection. Description for Approves or rejects a private endpoint connection.

EXEC azure.web.app_service_environments.approve_or_reject_private_endpoint_connection 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@private_endpoint_connection_name='{{ private_endpoint_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"kind": "{{ kind }}"
}'
;

delete_private_endpoint_connection

Deletes a private endpoint connection. Description for Deletes a private endpoint connection.

EXEC azure.web.app_service_environments.delete_private_endpoint_connection 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@private_endpoint_connection_name='{{ private_endpoint_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_private_endpoint_connection_list

Gets the list of private endpoints associated with a hosting environment. Description for Gets the list of private endpoints associated with a hosting environment.

EXEC azure.web.app_service_environments.get_private_endpoint_connection_list 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

change_vnet

Move an App Service Environment to a different VNET. Description for Move an App Service Environment to a different VNET.

EXEC azure.web.app_service_environments.change_vnet 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"id": "{{ id }}", 
"subnet": "{{ subnet }}"
}'
;

test_upgrade_available_notification

Send a test notification that an upgrade is available for this App Service Environment. Send a test notification that an upgrade is available for this App Service Environment.

EXEC azure.web.app_service_environments.test_upgrade_available_notification 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

upgrade

Initiate an upgrade of an App Service Environment if one is available. Description for Initiate an upgrade of an App Service Environment if one is available.

EXEC azure.web.app_service_environments.upgrade 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

reboot

Reboot all machines in an App Service Environment. Description for Reboot all machines in an App Service Environment.

EXEC azure.web.app_service_environments.reboot 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

resume

Resume an App Service Environment. Description for Resume an App Service Environment.

EXEC azure.web.app_service_environments.resume 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

suspend

Suspend an App Service Environment. Description for Suspend an App Service Environment.

EXEC azure.web.app_service_environments.suspend 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;