How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Microsoft Azure

Microsoft Azure AppServiceEnvironments API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Microsoft Azure AppServiceEnvironments API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include AppServiceEnvironments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.

This API exposes 48 operations across 36 paths, and defines 24 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

48 operations 36 paths 24 schemas 3 DELETE30 GET3 PATCH6 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 48

Across 36 paths, the API surfaces 48 operations — 3 DELETE, 30 GET, 3 PATCH, 6 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

AppServiceEnvironments 48
GET
/subscriptions/{subscriptionId}/providers/Microsoft.Web/hostingEnvironments
Microsoft Azure Get All App Service Environments For A Subscription
microsoftAzureAppserviceenvironmentsList 2 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments
Microsoft Azure Get All App Service Environments In A Resource Group
microsoftAzureAppserviceenvironmentsListbyresourcegroup 3 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
Microsoft Azure Get The Properties Of An App Service Environment
microsoftAzureAppserviceenvironmentsGet 4 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
Microsoft Azure Create Or Update An App Service Environment
microsoftAzureAppserviceenvironmentsCreateorupdate 4 params body → 200201202default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
Microsoft Azure Delete An App Service Environment
microsoftAzureAppserviceenvironmentsDelete 5 params → 202204default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
Microsoft Azure Create Or Update An App Service Environment
microsoftAzureAppserviceenvironmentsUpdate 4 params body → 200201202default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute
Microsoft Azure Get The Used, Available, And Total Worker Capacity An App Service Environment
microsoftAzureAppserviceenvironmentsListcapacities 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip
Microsoft Azure Get Ip Addresses Assigned To An App Service Environment
microsoftAzureAppserviceenvironmentsGetvipinfo 4 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/changeVirtualNetwork
Microsoft Azure Move An App Service Environment To A Different Vnet
microsoftAzureAppserviceenvironmentsChangevnet 4 params body → 200202default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix
Microsoft Azure Get Custom Dns Suffix Configuration Of An App Service Environment
microsoftAzureAppserviceenvironmentsGetasecustomdnssuffixconfiguration 4 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix
Microsoft Azure Update Custom Dns Suffix Configuration Of An App Service Environment
microsoftAzureAppserviceenvironmentsUpdateasecustomdnssuffixconfiguration 4 params body → 200default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix
Microsoft Azure Delete Custom Dns Suffix Configuration Of An App Service Environment
microsoftAzureAppserviceenvironmentsDeleteasecustomdnssuffixconfiguration 4 params → 200204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/networking
Microsoft Azure Get Networking Configuration Of An App Service Environment
microsoftAzureAppserviceenvironmentsGetasev3networkingconfiguration 4 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/networking
Microsoft Azure Update Networking Configuration Of An App Service Environment
microsoftAzureAppserviceenvironmentsUpdateasenetworkingconfiguration 4 params body → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics
Microsoft Azure Get Diagnostic Information For An App Service Environment
microsoftAzureAppserviceenvironmentsListdiagnostics 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics/{diagnosticsName}
Microsoft Azure Get A Diagnostics Item For An App Service Environment
microsoftAzureAppserviceenvironmentsGetdiagnosticsitem 5 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/inboundNetworkDependenciesEndpoints
Microsoft Azure Get The Network Endpoints Of All Inbound Dependencies Of An App Service Environment
microsoftAzureAppserviceenvironmentsGetinboundnetworkdependenciesendpoints 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools
Microsoft Azure Get All Multi Role Pools
microsoftAzureAppserviceenvironmentsListmultirolepools 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default
Microsoft Azure Get Properties Of A Multi Role Pool
microsoftAzureAppserviceenvironmentsGetmultirolepool 4 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default
Microsoft Azure Create Or Update A Multi Role Pool
microsoftAzureAppserviceenvironmentsCreateorupdatemultirolepool 4 params body → 200202default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default
Microsoft Azure Create Or Update A Multi Role Pool
microsoftAzureAppserviceenvironmentsUpdatemultirolepool 4 params body → 200202default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metricdefinitions
Microsoft Azure Get Metric Definitions For A Specific Instance Of A Multi Role Pool Of An App Service Environment
microsoftAzureAppserviceenvironmentsListmultirolepoolinstancemetricdefinitions 5 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metricdefinitions
Microsoft Azure Get Metric Definitions For A Multi Role Pool Of An App Service Environment
microsoftAzureAppserviceenvironmentsListmultirolemetricdefinitions 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/skus
Microsoft Azure Get Available Skus For Scaling A Multi Role Pool
microsoftAzureAppserviceenvironmentsListmultirolepoolskus 4 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/testUpgradeAvailableNotification
Microsoft Azure Send A Test Notification That An Upgrade Is Available For This App Service Environment
microsoftAzureAppserviceenvironmentsTestupgradeavailablenotification 4 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/upgrade
Microsoft Azure Initiate An Upgrade Of An App Service Environment If One Is Available
microsoftAzureAppserviceenvironmentsUpgrade 4 params → 202default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/usages
Microsoft Azure Get Usage Metrics For A Multi Role Pool Of An App Service Environment
microsoftAzureAppserviceenvironmentsListmultiroleusages 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations
Microsoft Azure List All Currently Running Operations On The App Service Environment
microsoftAzureAppserviceenvironmentsListoperations 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/outboundNetworkDependenciesEndpoints
Microsoft Azure Get The Network Endpoints Of All Outbound Dependencies Of An App Service Environment
microsoftAzureAppserviceenvironmentsGetoutboundnetworkdependenciesendpoints 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections
Microsoft Azure Gets The List Of Private Endpoints Associated With A Hosting Environment
microsoftAzureAppserviceenvironmentsGetprivateendpointconnectionlist 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName}
Microsoft Azure Gets A Private Endpoint Connection
microsoftAzureAppserviceenvironmentsGetprivateendpointconnection 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName}
Microsoft Azure Approves Or Rejects A Private Endpoint Connection
microsoftAzureAppserviceenvironmentsApproveorrejectprivateendpointconnection 5 params body → 200202default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName}
Microsoft Azure Deletes A Private Endpoint Connection
microsoftAzureAppserviceenvironmentsDeleteprivateendpointconnection 5 params → 200202204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateLinkResources
Microsoft Azure Gets The Private Link Resources
microsoftAzureAppserviceenvironmentsGetprivatelinkresources 4 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/reboot
Microsoft Azure Reboot All Machines In An App Service Environment
microsoftAzureAppserviceenvironmentsReboot 4 params → 202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/resume
Microsoft Azure Resume An App Service Environment
microsoftAzureAppserviceenvironmentsResume 4 params → 200202default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms
Microsoft Azure Get All App Service Plans In An App Service Environment
microsoftAzureAppserviceenvironmentsListappserviceplans 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites
Microsoft Azure Get All Apps In An App Service Environment
microsoftAzureAppserviceenvironmentsListwebapps 5 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/suspend
Microsoft Azure Suspend An App Service Environment
microsoftAzureAppserviceenvironmentsSuspend 4 params → 200202default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages
Microsoft Azure Get Global Usage Metrics Of An App Service Environment
microsoftAzureAppserviceenvironmentsListusages 5 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools
Microsoft Azure Get All Worker Pools Of An App Service Environment
microsoftAzureAppserviceenvironmentsListworkerpools 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}
Microsoft Azure Get Properties Of A Worker Pool
microsoftAzureAppserviceenvironmentsGetworkerpool 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}
Microsoft Azure Create Or Update A Worker Pool
microsoftAzureAppserviceenvironmentsCreateorupdateworkerpool 5 params body → 200202default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}
Microsoft Azure Create Or Update A Worker Pool
microsoftAzureAppserviceenvironmentsUpdateworkerpool 5 params body → 200202default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metricdefinitions
Microsoft Azure Get Metric Definitions For A Specific Instance Of A Worker Pool Of An App Service Environment
microsoftAzureAppserviceenvironmentsListworkerpoolinstancemetricdefinitions 6 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metricdefinitions
Microsoft Azure Get Metric Definitions For A Worker Pool Of An App Service Environment
microsoftAzureAppserviceenvironmentsListwebworkermetricdefinitions 5 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/skus
Microsoft Azure Get Available Skus For Scaling A Worker Pool
microsoftAzureAppserviceenvironmentsListworkerpoolskus 5 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/usages
Microsoft Azure Get Usage Metrics For A Worker Pool Of An App Service Environment
microsoftAzureAppserviceenvironmentsListwebworkerusages 5 params → 200default

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are StampCapacity (11 properties), WorkerPool (5 properties), VirtualIPMapping (5 properties), EndpointDetail (4 properties). Each schema is shown below with its type and property counts.

OutboundEnvironmentEndpointCollection
object
Collection of Outbound Environment Endpoints
2 properties 1 required
AddressResponse
object
Describes main public IP address and any extra virtual IPs.
1 property
AppServiceEnvironmentResource
object
App Service Environment ARM resource.
1 property
AppServiceEnvironmentCollection
object
Collection of App Service Environments.
2 properties 1 required
EndpointDetail
object
Current TCP connectivity information from the App Service Environment to a single endpoint.
4 properties
AppServiceEnvironmentPatchResource
object
ARM resource for a app service environment.
1 property
StampCapacity
object
Stamp capacity information.
11 properties
InboundEnvironmentEndpointCollection
object
Collection of Inbound Environment Endpoints
2 properties 1 required
WorkerPoolCollection
object
Collection of worker pools.
2 properties 1 required
WorkerPoolResource
object
Worker pool of an App Service Environment ARM resource.
2 properties
SkuInfo
object
SKU discovery information.
3 properties
UsageCollection
object
Collection of usages.
2 properties 1 required
VirtualIPMapping
object
Virtual IP mapping.
5 properties
ResourceMetricDefinition
object
Metadata for the metrics.
1 property
SkuInfoCollection
object
Collection of SKU information.
2 properties 1 required
WorkerPool
object
Worker pool of an App Service Environment.
5 properties
InboundEnvironmentEndpoint
object
The IP Addresses and Ports that require inbound network access to and within the subnet of the App Service Environment.
3 properties
StampCapacityCollection
object
Collection of stamp capacities.
2 properties 1 required
ResourceMetricAvailability
object
Metrics availability and retention.
2 properties
HostingEnvironmentDiagnostics
object
Diagnostics for an App Service Environment.
2 properties
EndpointDependency
object
A domain name that a service is reached at, including details of the current connection status.
2 properties
Usage
object
Usage of the quota resource.
1 property
OutboundEnvironmentEndpoint
object
Endpoints accessed for a common purpose that the App Service Environment requires outbound network access to.
2 properties
ResourceMetricDefinitionCollection
object
Collection of metric definitions.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-appserviceenvironments-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
AE Profile APIs.io
Microsoft Azure Communication Services API
AE Profile APIs.io
Microsoft Azure Event Grid API
AE Profile APIs.io
Microsoft Azure Functions API
AE Profile APIs.io
Microsoft Azure DevOps REST API
AE Profile APIs.io
Microsoft Azure AI Foundry API
AE Profile APIs.io
Microsoft Azure Resource JSON Schema
AE Profile APIs.io
Microsoft Azure JSON-LD Context
AE Profile APIs.io
Microsoft Azure AccessConnector API
AE Profile APIs.io
Microsoft Azure AccessControlRecords API
AE Profile APIs.io
Microsoft Azure AccessPolicies API
AE Profile APIs.io
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
AE Profile APIs.io
#AppServiceEnvironments
← Back to M APIs
API Details
ID
microsoft-azure:microsoft-azure-appserviceenvironments-api
Docs
https://learn.microsoft.com/en-us/rest/api/azure/
Provider
Microsoft Azure
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=microsoft-azure-appserviceenvironments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/microsoft-azure-appserviceenvironments-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Microsoft Azure AppServiceEnvironments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.