Microsoft Azure

Azure App Service: App Service Environments

Azure App Service: App Service Environments endpoints from Microsoft Azure

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Azure App Service: App Service Environments endpoints from Microsoft Azure

Endpoints 48

AppServiceEnvironments

  • GETGet all App Service Environments for a subscription./subscriptions/:subscriptionId/providers/Microsoft.Web/hostingEnvironments?api-version=stringDescription for Get all App Service Environments for a subscription.
  • GETGet all App Service Environments in a resource group./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments?api-version=stringDescription for Get all App Service Environments in a resource group.
  • GETGet the properties of an App Service Environment./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name?api-version=stringDescription for Get the properties of an App Service Environment.
  • PUTCreate or update an App Service Environment./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name?api-version=stringDescription for Create or update an App Service Environment.
  • DELETEDelete an App Service Environment./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name?forceDelete=true&api-version=stringDescription for Delete an App Service Environment.
  • PATCHCreate or update an App Service Environment./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name?api-version=stringDescription for Create or update an App Service Environment.
  • GETGet the used, available, and total worker capacity an App Service Environment./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/capacities/compute?api-version=stringDescription for Get the used, available, and total worker capacity an App Service Environment.
  • GETGet IP addresses assigned to an App Service Environment./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/capacities/virtualip?api-version=stringDescription for Get IP addresses assigned to an App Service Environment.
  • POSTMove an App Service Environment to a different VNET./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/changeVirtualNetwork?api-version=stringDescription for Move an App Service Environment to a different VNET.
  • GETGet Custom Dns Suffix configuration of an App Service Environment/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/configurations/customdnssuffix?api-version=string
  • PUTUpdate Custom Dns Suffix configuration of an App Service Environment/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/configurations/customdnssuffix?api-version=string
  • DELETEDelete Custom Dns Suffix configuration of an App Service Environment/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/configurations/customdnssuffix?api-version=string
  • GETGet networking configuration of an App Service Environment/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/configurations/networking?api-version=stringDescription for Get networking configuration of an App Service Environment
  • PUTUpdate networking configuration of an App Service Environment/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/configurations/networking?api-version=stringDescription for Update networking configuration of an App Service Environment
  • GETGet diagnostic information for an App Service Environment./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/diagnostics?api-version=stringDescription for Get diagnostic information for an App Service Environment.
  • GETGet a diagnostics item for an App Service Environment./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/diagnostics/:diagnosticsName?api-version=stringDescription for Get a diagnostics item for an App Service Environment.
  • GETGet the network endpoints of all inbound dependencies of an App Service Environment./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/inboundNetworkDependenciesEndpoints?api-version=stringDescription for Get the network endpoints of all inbound dependencies of an App Service Environment.
  • GETGet all multi-role pools./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/multiRolePools?api-version=stringDescription for Get all multi-role pools.
  • GETGet properties of a multi-role pool./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/multiRolePools/default?api-version=stringDescription for Get properties of a multi-role pool.
  • PUTCreate or update a multi-role pool./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/multiRolePools/default?api-version=stringDescription for Create or update a multi-role pool.
  • PATCHCreate or update a multi-role pool./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/multiRolePools/default?api-version=stringDescription for Create or update a multi-role pool.
  • GETGet metric definitions for a specific instance of a multi-role pool of an App Service Environment./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/multiRolePools/default/instances/:instance/metricdefinitions?api-version=stringDescription for Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.
  • GETGet metric definitions for a multi-role pool of an App Service Environment./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/multiRolePools/default/metricdefinitions?api-version=stringDescription for Get metric definitions for a multi-role pool of an App Service Environment.
  • GETGet available SKUs for scaling a multi-role pool./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/multiRolePools/default/skus?api-version=stringDescription for Get available SKUs for scaling a multi-role pool.
  • POSTSend a test notification that an upgrade is available for this App Service Environment./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/testUpgradeAvailableNotification?api-version=string
  • POSTInitiate an upgrade of an App Service Environment if one is available./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/upgrade?api-version=stringDescription for Initiate an upgrade of an App Service Environment if one is available.
  • GETGet usage metrics for a multi-role pool of an App Service Environment./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/multiRolePools/default/usages?api-version=stringDescription for Get usage metrics for a multi-role pool of an App Service Environment.
  • GETList all currently running operations on the App Service Environment./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/operations?api-version=stringDescription for List all currently running operations on the App Service Environment.
  • GETGet the network endpoints of all outbound dependencies of an App Service Environment./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/outboundNetworkDependenciesEndpoints?api-version=stringDescription for Get the network endpoints of all outbound dependencies of an App Service Environment.
  • GETGets the list of private endpoints associated with a hosting environment/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/privateEndpointConnections?api-version=stringDescription for Gets the list of private endpoints associated with a hosting environment
  • GETGets a private endpoint connection/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/privateEndpointConnections/:privateEndpointConnectionName?api-version=stringDescription for Gets a private endpoint connection
  • PUTApproves or rejects a private endpoint connection/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/privateEndpointConnections/:privateEndpointConnectionName?api-version=stringDescription for Approves or rejects a private endpoint connection
  • DELETEDeletes a private endpoint connection/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/privateEndpointConnections/:privateEndpointConnectionName?api-version=stringDescription for Deletes a private endpoint connection
  • GETGets the private link resources/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/privateLinkResources?api-version=stringDescription for Gets the private link resources
  • POSTReboot all machines in an App Service Environment./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/reboot?api-version=stringDescription for Reboot all machines in an App Service Environment.
  • POSTResume an App Service Environment./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/resume?api-version=stringDescription for Resume an App Service Environment.
  • GETGet all App Service plans in an App Service Environment./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/serverfarms?api-version=stringDescription for Get all App Service plans in an App Service Environment.
  • GETGet all apps in an App Service Environment./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/sites?propertiesToInclude=string&api-version=stringDescription for Get all apps in an App Service Environment.
  • POSTSuspend an App Service Environment./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/suspend?api-version=stringDescription for Suspend an App Service Environment.
  • GETGet global usage metrics of an App Service Environment./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/usages?api-version=string&$filter=stringDescription for Get global usage metrics of an App Service Environment.
  • GETGet all worker pools of an App Service Environment./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/workerPools?api-version=stringDescription for Get all worker pools of an App Service Environment.
  • GETGet properties of a worker pool./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/workerPools/:workerPoolName?api-version=stringDescription for Get properties of a worker pool.
  • PUTCreate or update a worker pool./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/workerPools/:workerPoolName?api-version=stringDescription for Create or update a worker pool.
  • PATCHCreate or update a worker pool./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/workerPools/:workerPoolName?api-version=stringDescription for Create or update a worker pool.
  • GETGet metric definitions for a specific instance of a worker pool of an App Service Environment./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/workerPools/:workerPoolName/instances/:instance/metricdefinitions?api-version=stringDescription for Get metric definitions for a specific instance of a worker pool of an App Service Environment.
  • GETGet metric definitions for a worker pool of an App Service Environment./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/workerPools/:workerPoolName/metricdefinitions?api-version=stringDescription for Get metric definitions for a worker pool of an App Service Environment.
  • GETGet available SKUs for scaling a worker pool./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/workerPools/:workerPoolName/skus?api-version=stringDescription for Get available SKUs for scaling a worker pool.
  • GETGet usage metrics for a worker pool of an App Service Environment./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/workerPools/:workerPoolName/usages?api-version=stringDescription for Get usage metrics for a worker pool of an App Service Environment.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
48 operations on 36 pathsGET 30PUT 6POST 6PATCH 3DELETE 3
Main resources
AppServiceEnvironments 48
Response formats
application/json
Description format
Swagger 2.0, API version 2024-11-01

How to test the Azure App Service: App Service Environments in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure App Service: App Service Environments collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get all App Service Environments for a subscription.” (GET /subscriptions/:subscriptionId/providers/Microsoft.Web/hostingEnvironments?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure App Service: App Service Environments?

Azure App Service: App Service Environments endpoints from Microsoft Azure It is listed under Developer tools and has 48 endpoints.

Who publishes the Azure App Service: App Service Environments?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure App Service: App Service Environments?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure App Service: App Service Environments?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure App Service: App Service Environments have?

48 operations on 36 paths (30 GET, 6 PUT, 6 POST, 3 PATCH, 3 DELETE). The largest groups are AppServiceEnvironments.

Is forking the Azure App Service: App Service Environments free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.