App Service Environments - List

Service:: App Service

API Version:: 2025-05-01

Description for Get all App Service Environments for a subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Web/hostingEnvironments?api-version=2025-05-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	AppServiceEnvironmentCollection	Azure operation completed successfully.
Other Status Codes	DefaultErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get all App Service Environments for a subscription.

Sample request

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/hostingEnvironments?api-version=2025-05-01


/**
 * Samples for AppServiceEnvironments List.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-05-01/AppServiceEnvironments_List.json
     */
    /**
     * Sample code: Get all App Service Environments for a subscription.
     * 
     * @param manager Entry point to AppServiceManager.
     */
    public static void
        getAllAppServiceEnvironmentsForASubscription(com.azure.resourcemanager.appservice.AppServiceManager manager) {
        manager.serviceClient().getAppServiceEnvironments().list(com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v6"
)

// Generated from example definition: 2025-05-01/AppServiceEnvironments_List.json
func ExampleEnvironmentsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewEnvironmentsClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armappservice.EnvironmentsClientListResponse{
		// 	EnvironmentCollection: armappservice.EnvironmentCollection{
		// 		Value: []*armappservice.EnvironmentResource{
		// 			{
		// 				Name: to.Ptr("test-ase"),
		// 				Type: to.Ptr("Microsoft.Web/hostingEnvironments"),
		// 				ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase"),
		// 				Kind: to.Ptr("ASEV3"),
		// 				Location: to.Ptr("South Central US"),
		// 				Properties: &armappservice.Environment{
		// 					DedicatedHostCount: to.Ptr[int32](0),
		// 					DNSSuffix: to.Ptr("test-ase.p.azurewebsites.net"),
		// 					FrontEndScaleFactor: to.Ptr[int32](15),
		// 					HasLinuxWorkers: to.Ptr(true),
		// 					InternalLoadBalancingMode: to.Ptr(armappservice.LoadBalancingModeNone),
		// 					IpsslAddressCount: to.Ptr[int32](0),
		// 					MaximumNumberOfMachines: to.Ptr[int32](250),
		// 					MultiSize: to.Ptr("Standard_D2d_v4"),
		// 					NetworkingConfiguration: &armappservice.AseV3NetworkingConfiguration{
		// 						ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking"),
		// 						Properties: &armappservice.AseV3NetworkingConfigurationProperties{
		// 							AllowNewPrivateEndpointConnections: to.Ptr(false),
		// 							ExternalInboundIPAddresses: []*string{
		// 								to.Ptr("52.153.248.36"),
		// 							},
		// 							FtpEnabled: to.Ptr(false),
		// 							InternalInboundIPAddresses: []*string{
		// 							},
		// 							LinuxOutboundIPAddresses: []*string{
		// 								to.Ptr("20.88.241.56"),
		// 								to.Ptr("20.88.241.9"),
		// 							},
		// 							RemoteDebugEnabled: to.Ptr(false),
		// 							WindowsOutboundIPAddresses: []*string{
		// 								to.Ptr("20.88.241.56"),
		// 								to.Ptr("20.88.241.9"),
		// 							},
		// 						},
		// 					},
		// 					ProvisioningState: to.Ptr(armappservice.ProvisioningStateSucceeded),
		// 					Status: to.Ptr(armappservice.HostingEnvironmentStatusReady),
		// 					Suspended: to.Ptr(false),
		// 					VirtualNetwork: &armappservice.VirtualNetworkProfile{
		// 						Name: to.Ptr("delegated"),
		// 						Type: to.Ptr("Microsoft.Network/virtualNetworks/subnets"),
		// 						ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated"),
		// 						Subnet: to.Ptr(""),
		// 					},
		// 					ZoneRedundant: to.Ptr(false),
		// 				},
		// 				Tags: map[string]*string{
		// 				},
		// 			},
		// 		},
		// 	},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "value": [
    {
      "name": "test-ase",
      "type": "Microsoft.Web/hostingEnvironments",
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase",
      "kind": "ASEV3",
      "location": "South Central US",
      "properties": {
        "clusterSettings": null,
        "dedicatedHostCount": 0,
        "dnsSuffix": "test-ase.p.azurewebsites.net",
        "frontEndScaleFactor": 15,
        "hasLinuxWorkers": true,
        "internalLoadBalancingMode": "None",
        "ipsslAddressCount": 0,
        "maximumNumberOfMachines": 250,
        "multiRoleCount": null,
        "multiSize": "Standard_D2d_v4",
        "networkingConfiguration": {
          "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking",
          "properties": {
            "allowNewPrivateEndpointConnections": false,
            "externalInboundIpAddresses": [
              "52.153.248.36"
            ],
            "ftpEnabled": false,
            "inboundIpAddressOverride": null,
            "internalInboundIpAddresses": [],
            "linuxOutboundIpAddresses": [
              "20.88.241.56",
              "20.88.241.9"
            ],
            "remoteDebugEnabled": false,
            "windowsOutboundIpAddresses": [
              "20.88.241.56",
              "20.88.241.9"
            ]
          }
        },
        "provisioningState": "Succeeded",
        "status": "Ready",
        "suspended": false,
        "userWhitelistedIpRanges": null,
        "virtualNetwork": {
          "name": "delegated",
          "type": "Microsoft.Network/virtualNetworks/subnets",
          "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated",
          "subnet": ""
        },
        "zoneRedundant": false
      },
      "tags": {}
    }
  ]
}

Definitions

Name	Description
AppServiceEnvironmentCollection	Collection of App Service Environments.
AppServiceEnvironmentResource	App Service Environment ARM resource.
AseV3NetworkingConfiguration	Full view of networking configuration for an ASE.
createdByType	The type of identity that created the resource.
CustomDnsSuffixConfiguration	Full view of the custom domain suffix configuration for ASEv3.
CustomDnsSuffixProvisioningState
DefaultErrorResponse	App Service error response.
DefaultErrorResponseError	Error model.
DefaultErrorResponseErrorDetailsItem	Detailed errors.
HostingEnvironmentStatus	Current status of the App Service Environment.
LoadBalancingMode	Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
NameValuePair	Name value pair.
ProvisioningState	Provisioning state of the App Service Plan.
systemData	Metadata pertaining to creation and last modification of the resource.
UpgradeAvailability	Whether an upgrade is available for this App Service Environment.
UpgradePreference	Upgrade Preference
VirtualNetworkProfile	Specification for using a Virtual Network.

AppServiceEnvironmentCollection

Object

Collection of App Service Environments.

Name	Type	Description
nextLink	string (uri)	The link to the next page of items
value	AppServiceEnvironmentResource[]	The AppServiceEnvironmentResource items on this page

AppServiceEnvironmentResource

Object

App Service Environment ARM resource.

Name	Type	Default value	Description
id	string (arm-id)		Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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
name	string		The name of the resource
properties.clusterSettings	NameValuePair[]		Custom settings for changing the behavior of the App Service Environment.
properties.customDnsSuffixConfiguration	CustomDnsSuffixConfiguration		Full view of the custom domain suffix configuration for ASEv3.
properties.dedicatedHostCount	integer (int32)		Dedicated Host Count
properties.dnsSuffix	string		DNS suffix of the App Service Environment.
properties.frontEndScaleFactor	integer (int32)		Scale factor for front-ends.
properties.hasLinuxWorkers	boolean		Flag that displays whether an ASE has linux workers or not
properties.internalLoadBalancingMode	LoadBalancingMode		Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
properties.ipsslAddressCount	integer (int32)		Number of IP SSL addresses reserved for the App Service Environment.
properties.maximumNumberOfMachines	integer (int32)		Maximum number of VMs in the App Service Environment.
properties.multiRoleCount	integer (int32)		Number of front-end instances.
properties.multiSize	string		Front-end VM size, e.g. "Medium", "Large".
properties.networkingConfiguration	AseV3NetworkingConfiguration		Full view of networking configuration for an ASE.
properties.provisioningState	ProvisioningState		Provisioning state of the App Service Environment.
properties.status	HostingEnvironmentStatus		Current status of the App Service Environment.
properties.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).
properties.upgradeAvailability	UpgradeAvailability		Whether an upgrade is available for this App Service Environment.
properties.upgradePreference	UpgradePreference	None	Upgrade Preference
properties.userWhitelistedIpRanges	string[]		User added ip ranges to whitelist on ASE db
properties.virtualNetwork	VirtualNetworkProfile		Description of the Virtual Network.
properties.zoneRedundant	boolean		Whether or not this App Service Environment is zone-redundant.
systemData	systemData		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"

AseV3NetworkingConfiguration

Object

Full view of networking configuration for an ASE.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Kind of resource.
name	string	The name of the resource
properties.allowNewPrivateEndpointConnections	boolean	Property to enable and disable new private endpoint connection creation on ASE
properties.externalInboundIpAddresses	string[]
properties.ftpEnabled	boolean	Property to enable and disable FTP on ASEV3
properties.inboundIpAddressOverride	string	Customer provided Inbound IP Address. Only able to be set on Ase create.
properties.internalInboundIpAddresses	string[]
properties.linuxOutboundIpAddresses	string[]
properties.remoteDebugEnabled	boolean	Property to enable and disable Remote Debug on ASEV3
properties.windowsOutboundIpAddresses	string[]
systemData	systemData	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"

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

CustomDnsSuffixConfiguration

Object

Full view of the custom domain suffix configuration for ASEv3.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Kind of resource.
name	string	The name of the resource
properties.certificateUrl	string	The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
properties.dnsSuffix	string	The default custom domain suffix to use for all sites deployed on the ASE.
properties.keyVaultReferenceIdentity	string	The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
properties.provisioningDetails	string
properties.provisioningState	CustomDnsSuffixProvisioningState
systemData	systemData	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"

CustomDnsSuffixProvisioningState

Enumeration

Value	Description
Succeeded
Failed
Degraded
InProgress

DefaultErrorResponse

Object

App Service error response.

Name	Type	Description
error	DefaultErrorResponseError	Error model.

DefaultErrorResponseError

Object

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	DefaultErrorResponseErrorDetailsItem[]	Detailed errors.
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

DefaultErrorResponseErrorDetailsItem

Object

Detailed errors.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

HostingEnvironmentStatus

Enumeration

Current status of the App Service Environment.

Value	Description
Preparing
Ready
Scaling
Deleting

LoadBalancingMode

Enumeration

Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.

Value	Description
None
Web
Publishing
Web, Publishing

NameValuePair

Object

Name value pair.

Name	Type	Description
name	string	Pair name.
value	string	Pair value.

ProvisioningState

Enumeration

Provisioning state of the App Service Plan.

Value	Description
Succeeded
Failed
Canceled
InProgress
Deleting

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UpgradeAvailability

Enumeration

Whether an upgrade is available for this App Service Environment.

Value	Description
None	No upgrade is currently available for this App Service Environment
Ready	An upgrade is ready to be manually initiated on this App Service Environment

UpgradePreference

Enumeration

Upgrade Preference

Value	Description
None	No preference on when this App Service Environment will be upgraded
Early	This App Service Environment will be upgraded before others in the same region that have Upgrade Preference 'Late'
Late	This App Service Environment will be upgraded after others in the same region that have Upgrade Preference 'Early'
Manual	ASEv3 only. Once an upgrade is available, this App Service Environment will wait 10 days for the upgrade to be manually initiated. After 10 days the upgrade will begin automatically

VirtualNetworkProfile

Object

Specification for using a Virtual Network.

Name	Type	Description
id	string	Resource id of the Virtual Network.
name	string	Name of the Virtual Network (read-only).
subnet	string	Subnet within the Virtual Network.
type	string	Resource type of the Virtual Network (read-only).