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 HostingEnvironments API

The HostingEnvironments API from Microsoft Azure — 33 operation(s) for hostingenvironments.

Documentation Provider Profile APIs.io OpenAPI GitHub

Microsoft Azure HostingEnvironments 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 HostingEnvironments. 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 37 operations across 33 paths, and defines 56 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

37 operations 33 paths 56 schemas 1 DELETE30 GET3 POST3 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 37

Across 33 paths, the API surfaces 37 operations — 1 DELETE, 30 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

HostingEnvironments 37
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
Microsoft Azure Get Properties Of Hostingenvironment App Service Environment
microsoftAzureHostingenvironmentsGethostingenvironment 4 params → 200
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
Microsoft Azure Create Or Update A Hostingenvironment App Service Environment
microsoftAzureHostingenvironmentsCreateorupdatehostingenvironment 4 params body → 200202400404409
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
Microsoft Azure Delete A Hostingenvironment App Service Environment
microsoftAzureHostingenvironmentsDeletehostingenvironment 5 params → 200202400404409
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics
Microsoft Azure Get Diagnostic Information For Hostingenvironment App Service Environment
microsoftAzureHostingenvironmentsGethostingenvironmentdiagnostics 4 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics/{diagnosticsName}
Microsoft Azure Get Diagnostic Information For Hostingenvironment App Service Environment
microsoftAzureHostingenvironmentsGethostingenvironmentdiagnosticsitem 5 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute
Microsoft Azure Get Used, Available, And Total Worker Capacity For Hostingenvironment App Service Environment
microsoftAzureHostingenvironmentsGethostingenvironmentcapacities 4 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip
Microsoft Azure Get Ip Addresses Assigned To The Hostingenvironment App Service Environment
microsoftAzureHostingenvironmentsGethostingenvironmentvips 4 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments
Microsoft Azure Get All Hostingenvironments App Service Environments In A Resource Group
microsoftAzureHostingenvironmentsGethostingenvironments 3 params → 200
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/reboot
Microsoft Azure Reboots All Machines In A Hostingenvironment App Service Environment
microsoftAzureHostingenvironmentsReboothostingenvironment 4 params → 202400404409
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations
Microsoft Azure List All Currently Running Operations On The Hostingenvironment App Service Environment
microsoftAzureHostingenvironmentsGethostingenvironmentoperations 4 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations/{operationId}
Microsoft Azure Get Status Of An Operation On A Hostingenvironment App Service Environment
microsoftAzureHostingenvironmentsGethostingenvironmentoperation 5 params → 200202404500
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metrics
Microsoft Azure Get Global Metrics Of Hostingenvironment App Service Environment
microsoftAzureHostingenvironmentsGethostingenvironmentmetrics 6 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metricdefinitions
Microsoft Azure Get Global Metric Definitions Of Hostingenvironment App Service Environment
microsoftAzureHostingenvironmentsGethostingenvironmentmetricdefinitions 4 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages
Microsoft Azure Get Global Usages Of Hostingenvironment App Service Environment
microsoftAzureHostingenvironmentsGethostingenvironmentusages 5 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metrics
Microsoft Azure Get Metrics For A Multirole Pool Of A Hostingenvironment App Service Environment
microsoftAzureHostingenvironmentsGethostingenvironmentmultirolemetrics 9 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metrics
Microsoft Azure Get Metrics For A Worker Pool Of A Hostingenvironment App Service Environment
microsoftAzureHostingenvironmentsGethostingenvironmentwebworkermetrics 7 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metricdefinitions
Microsoft Azure Get Metric Definitions For A Multirole Pool Of A Hostingenvironment App Service Environment
microsoftAzureHostingenvironmentsGethostingenvironmentmultirolemetricdefinitions 4 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metricdefinitions
Microsoft Azure Get Metric Definitions For A Worker Pool Of A Hostingenvironment App Service Environment
microsoftAzureHostingenvironmentsGethostingenvironmentwebworkermetricdefinitions 5 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/usages
Microsoft Azure Get Usages For A Multirole Pool Of A Hostingenvironment App Service Environment
microsoftAzureHostingenvironmentsGethostingenvironmentmultiroleusages 4 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/usages
Microsoft Azure Get Usages For A Worker Pool Of A Hostingenvironment App Service Environment
microsoftAzureHostingenvironmentsGethostingenvironmentwebworkerusages 5 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites
Microsoft Azure Get All Sites On The Hostingenvironment App Service Environment
microsoftAzureHostingenvironmentsGethostingenvironmentsites 5 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/webhostingplans
Microsoft Azure Get All Serverfarms App Service Plans On The Hostingenvironment App Service Environment
microsoftAzureHostingenvironmentsGethostingenvironmentwebhostingplans 4 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms
Microsoft Azure Get All Serverfarms App Service Plans On The Hostingenvironment App Service Environment
microsoftAzureHostingenvironmentsGethostingenvironmentserverfarms 4 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools
Microsoft Azure Get All Multi Role Pools
microsoftAzureHostingenvironmentsGetmultirolepools 4 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default
Microsoft Azure Get Properties Of A Multirole Pool
microsoftAzureHostingenvironmentsGetmultirolepool 4 params → 200
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default
Microsoft Azure Create Or Update A Multirole Pool
microsoftAzureHostingenvironmentsCreateorupdatemultirolepool 4 params body → 200202400404409
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/skus
Microsoft Azure Get Available Skus For Scaling A Multirole Pool
microsoftAzureHostingenvironmentsGetmultirolepoolskus 4 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools
Microsoft Azure Get All Worker Pools
microsoftAzureHostingenvironmentsGetworkerpools 4 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}
Microsoft Azure Get Properties Of A Worker Pool
microsoftAzureHostingenvironmentsGetworkerpool 5 params → 200
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}
Microsoft Azure Create Or Update A Worker Pool
microsoftAzureHostingenvironmentsCreateorupdateworkerpool 5 params body → 200202400404409
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/skus
Microsoft Azure Get Available Skus For Scaling A Worker Pool
microsoftAzureHostingenvironmentsGetworkerpoolskus 5 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metrics
Microsoft Azure Get Metrics For A Specific Instance Of A Worker Pool Of A Hostingenvironment App Service Environment
microsoftAzureHostingenvironmentsGetworkerpoolinstancemetrics 8 params → 200
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 A Hostingenvironment App Service Environment
microsoftAzureHostingenvironmentsGetworkerpoolinstancemetricdefinitions 6 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metrics
Microsoft Azure Get Metrics For A Specific Instance Of A Multirole Pool Of A Hostingenvironment App Service Environment
microsoftAzureHostingenvironmentsGetmultirolepoolinstancemetrics 6 params → 200
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 Multirole Pool Of A Hostingenvironment App Service Environment
microsoftAzureHostingenvironmentsGetmultirolepoolinstancemetricdefinitions 5 params → 200
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/suspend
Microsoft Azure Suspends The Hostingenvironment
microsoftAzureHostingenvironmentsSuspendhostingenvironment 4 params → 200202
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/resume
Microsoft Azure Resumes The Hostingenvironment
microsoftAzureHostingenvironmentsResumehostingenvironment 4 params → 200202

Schemas 56

The contract defines 56 schemas that model the data the API accepts and returns. The most detailed are StampCapacity (10 properties), CloningInfo (10 properties), RampUpRule (8 properties), ResourceMetric (8 properties). Each schema is shown below with its type and property counts.

VirtualApplication
object
4 properties
ConnStringInfo
object
Represents database connection string information
3 properties 1 required
HostingEnvironmentProfile
object
Specification for a hostingEnvironment (App Service Environment) to use for this resource
3 properties
AddressResponse
object
Describes main public ip address and any extra vips
4 properties
SiteCollection
object
Collection of sites
2 properties
StatusCodesBasedTrigger
object
StatusCodeBasedTrigger
5 properties
Object
object
RampUpRule
object
Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance
8 properties
ResourceMetricName
object
Name of a metric for any resource
2 properties
ResourceMetricCollection
object
Collection of metric responses
2 properties
HostingEnvironment
object
Description of an hostingEnvironment (App Service Environment)
1 property
ResourceMetricValue
object
Value of resource metric
6 properties
Site
object
Represents a web app
1 property
AutoHealRules
object
AutoHealRules - describes the rules which can be defined for auto-heal
2 properties
SiteLimits
object
Represents metric limits set on a web app.
3 properties
AutoHealCustomAction
object
AutoHealCustomAction - Describes the custom action to be executed when an auto heal rule is triggered.
2 properties
SiteConfig
object
Configuration of Azure web site
1 property
NetworkAccessControlEntry
object
4 properties
ServerFarmCollection
object
Collection of serverfarms
2 properties
SkuCapacity
object
Description of the App Service Plan scale options
4 properties
HostingEnvironmentCollection
object
Collection of hosting environments (App Service Environments)
2 properties
MetricDefinition
object
Class representing metadata for the metrics
1 property
IpSecurityRestriction
object
Represents an ip security restriction on a web app.
2 properties
StampCapacity
object
Class containing stamp capacity information
10 properties
SlowRequestsBasedTrigger
object
SlowRequestsBasedTrigger
3 properties
SkuDescription
object
Describes a sku for a scalable resource
5 properties
Experiments
object
Class containing Routing in production experiments
1 property
WorkerPoolCollection
object
Collection of worker pools
2 properties
MetricDefinitionCollection
object
Collection of metric definitions
2 properties
CorsSettings
object
Cross-Origin Resource Sharing (CORS) settings for the web app.
1 property
Resource
object
6 properties 1 required
ServerFarmWithRichSku
object
App Service Plan Model
2 properties
SkuInfo
object
Sku discovery information
3 properties
VirtualNetworkProfile
object
Specification for using a virtual network
4 properties
UsageCollection
object
Collection of usages
2 properties
KeyValuePair_String_String
object
2 properties
VirtualIPMapping
object
Class that represents a VIP mapping
4 properties
HostNameSslState
object
Object that represents a SSL-enabled host name.
5 properties 1 required
SkuInfoCollection
object
Collection of SkuInfos
2 properties
AutoHealActions
object
AutoHealActions - Describes the actions which can be taken by the auto-heal module when a rule is triggered.
3 properties 1 required
WorkerPool
object
Worker pool of a hostingEnvironment (App Service Environment)
2 properties
AutoHealTriggers
object
AutoHealTriggers - describes the triggers for auto-heal.
4 properties
RequestsBasedTrigger
object
RequestsBasedTrigger
2 properties
StampCapacityCollection
object
Collection of stamp capacities
2 properties
ResourceMetric
object
Object representing a metric for any resource
8 properties
VirtualDirectory
object
2 properties
NameValuePair
object
Name value pair
2 properties
ApiDefinitionInfo
object
Information about the formal API definition for the web app.
1 property
LocalizableString
object
LocalizableString object containing the name and a localized value.
2 properties
CloningInfo
object
Represents information needed for cloning operation
10 properties
HostingEnvironmentDiagnostics
object
Diagnostics for a hosting environment (App Service Environment)
2 properties
Usage
object
Class that represents usage of the quota resource.
1 property
CsmUsageQuota
object
Usage of the quota resource
5 properties
HandlerMapping
object
The IIS handler mappings used to define which handler processes HTTP requests with certain extension. For example it is used to configure php-cgi.exe process t…
3 properties
CsmUsageQuotaCollection
object
Collection of csm usage quotas
2 properties
MetricAvailabilily
object
Class representing metrics availability and retention
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-hostingenvironments-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
#HostingEnvironments
← Back to M APIs
API Details
ID
microsoft-azure:microsoft-azure-hostingenvironments-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-hostingenvironments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/microsoft-azure-hostingenvironments-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 HostingEnvironments 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.