# Microsoft Azure App Service App Service Environments API

**Canonical:** https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-appserviceenvironments-api/  
**Provider:** Microsoft Azure App Service — https://apis.io/providers/microsoft-azure-app-service/  
**Base URL:** https://management.azure.com  
**Documentation:** https://learn.microsoft.com/en-us/rest/api/appservice/

Microsoft Azure App Service App Service Environments API is one of 24 APIs that [Microsoft Azure App Service](https://apis.io/providers/microsoft-azure-app-service/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 2 JSON Schema definitions. Tagged areas include AppServiceEnvironments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and 2 JSON Schemas.

The AppServiceEnvironments API from Microsoft Azure App Service — 36 operation(s) for appserviceenvironments.

## Operations (48)

| Method | Path | Summary |
|---|---|---|
| GET | `/subscriptions/{subscriptionId}/providers/Microsoft.Web/hostingEnvironments` | Get all App Service Environments for a subscription |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments` | Get all App Service Environments in a resource group |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}` | Get the properties of an App Service Environment |
| PUT | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}` | Create or update an App Service Environment |
| PATCH | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}` | Create or update an App Service Environment |
| DELETE | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}` | Delete an App Service Environment |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute` | Get the used, available, and total worker capacity an App Service Environment |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip` | Get IP addresses assigned to an App Service Environment |
| POST | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/changeVirtualNetwork` | Move an App Service Environment to a different VNET |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix` | Get Custom Dns Suffix configuration of an App Service Environment |
| PUT | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix` | Update Custom Dns Suffix configuration of an App Service Environment |
| DELETE | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix` | Delete Custom Dns Suffix configuration of an App Service Environment |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/networking` | Get networking configuration of an App Service Environment |
| PUT | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/networking` | Update networking configuration of an App Service Environment |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics` | Get diagnostic information for an App Service Environment |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics/{diagnosticsName}` | Get a diagnostics item for an App Service Environment |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/inboundNetworkDependenciesEndpoints` | Get the network endpoints of all inbound dependencies of an App Service… |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools` | Get all multi-role pools |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default` | Get properties of a multi-role pool |
| PUT | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default` | Create or update a multi-role pool |
| PATCH | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default` | Create or update a multi-role pool |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metricdefinitions` | Get metric definitions for a specific instance of a multi-role pool of an App… |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metricdefinitions` | Get metric definitions for a multi-role pool of an App Service Environment |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/skus` | Get available SKUs for scaling a multi-role pool |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/usages` | Get usage metrics for a multi-role pool of an App Service Environment |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations` | List all currently running operations on the App Service Environment |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/outboundNetworkDependenciesEndpoints` | Get the network endpoints of all outbound dependencies of an App Service… |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections` | Gets the list of private endpoints associated with a hosting environment |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName}` | Gets a private endpoint connection |
| PUT | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName}` | Approves or rejects a private endpoint connection |
| DELETE | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName}` | Deletes a private endpoint connection |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateLinkResources` | Gets the private link resources |
| POST | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/reboot` | Reboot all machines in an App Service Environment |
| POST | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/resume` | Resume an App Service Environment |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms` | Get all App Service plans in an App Service Environment |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites` | Get all apps in an App Service Environment |
| POST | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/suspend` | Suspend an App Service Environment |
| POST | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/testUpgradeAvailableNotification` | Send a test notification that an upgrade is available for this App Service… |
| POST | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/upgrade` | Initiate an upgrade of an App Service Environment if one is available |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages` | Get global usage metrics of an App Service Environment |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools` | Get all worker pools of an App Service Environment |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}` | Get properties of a worker pool |
| PUT | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}` | Create or update a worker pool |
| PATCH | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}` | Create or update a worker pool |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metricdefinitions` | Get metric definitions for a specific instance of a worker pool of an App… |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metricdefinitions` | Get metric definitions for a worker pool of an App Service Environment |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/skus` | Get available SKUs for scaling a worker pool |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/usages` | Get usage metrics for a worker pool of an App Service Environment |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/microsoft-azure-app-service/openapi/microsoft-azure-app-service-appserviceenvironments-api-openapi.yml
- **Documentation** — https://learn.microsoft.com/en-us/rest/api/appservice/
- **SDKs** — https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/appservice
- **APIReference** — https://learn.microsoft.com/en-us/rest/api/appservice/operation-groups
- **Authentication** — https://learn.microsoft.com/en-us/azure/app-service/overview-authentication-authorization
- **JSONSchema** — https://artifacts.apis.io/microsoft-azure-app-service/json-schema/microsoft-azure-app-service-resource-schema.json
- **JSONSchema** — https://artifacts.apis.io/microsoft-azure-app-service/json-schema/microsoft-azure-app-service-resource-list-schema.json

## Other Microsoft Azure App Service APIs (12)

- [Microsoft Azure App Service Operations API](https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-operations-api/)
- [Microsoft Azure App Service AI Gateways API](https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-aigateways-api/)
- [Microsoft Azure App Service App Service Plans API](https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-appserviceplans-api/)
- [Microsoft Azure App Service Certificates API](https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-certificates-api/)
- [Microsoft Azure App Service Deleted Web Apps API](https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-deletedwebapps-api/)
- [Microsoft Azure App Service Diagnostics API](https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-diagnostics-api/)
- [Microsoft Azure App Service Global API](https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-global-api/)
- [Microsoft Azure App Service Kube Environments API](https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-kubeenvironments-api/)
- [Microsoft Azure App Service Provider API](https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-provider-api/)
- [Microsoft Azure App Service Providers API](https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-providers-api/)
- [Microsoft Azure App Service Recommendations API](https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-recommendations-api/)
- [Microsoft Azure App Service Resource Health Metadata API](https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-resourcehealthmetadata-api/)

## Tags

AppServiceEnvironments

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-appserviceenvironments-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/microsoft-azure-app-service/.