{ "opencollection": "1.0.0", "info": { "name": "WebApps API Client AppServiceEnvironments API", "version": "2025-05-01" }, "items": [ { "info": { "name": "AppServiceEnvironments", "type": "folder" }, "items": [ { "info": { "name": "Get all App Service Environments for a subscription.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/providers/Microsoft.Web/hostingEnvironments" }, "docs": "Description for Get all App Service Environments for a subscription." }, { "info": { "name": "Get all App Service Environments in a resource group.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments" }, "docs": "Description for Get all App Service Environments in a resource group." }, { "info": { "name": "Get the properties of an App Service Environment.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Description for Get the properties of an App Service Environment." }, { "info": { "name": "Create or update an App Service Environment.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Description for Create or update an App Service Environment." }, { "info": { "name": "Create or update an App Service Environment.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Description for Create or update an App Service Environment." }, { "info": { "name": "Delete an App Service Environment.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." }, { "name": "forceDelete", "value": "", "type": "query", "description": "Specify true to force the deletion even if the App Service Environment contains resources. The default is false." } ] }, "docs": "Description for Delete an App Service Environment." }, { "info": { "name": "Get the used, available, and total worker capacity an App Service Environment.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/capacities/compute", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Description for Get the used, available, and total worker capacity an App Service Environment." }, { "info": { "name": "Get IP addresses assigned to an App Service Environment.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/capacities/virtualip", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Description for Get IP addresses assigned to an App Service Environment." }, { "info": { "name": "Move an App Service Environment to a different VNET.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/changeVirtualNetwork", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Description for Move an App Service Environment to a different VNET." }, { "info": { "name": "Get Custom Dns Suffix configuration of an App Service Environment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/configurations/customdnssuffix", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Get Custom Dns Suffix configuration of an App Service Environment" }, { "info": { "name": "Update Custom Dns Suffix configuration of an App Service Environment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/configurations/customdnssuffix", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Update Custom Dns Suffix configuration of an App Service Environment" }, { "info": { "name": "Delete Custom Dns Suffix configuration of an App Service Environment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/configurations/customdnssuffix", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Delete Custom Dns Suffix configuration of an App Service Environment" }, { "info": { "name": "Get networking configuration of an App Service Environment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/configurations/networking", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Description for Get networking configuration of an App Service Environment" }, { "info": { "name": "Update networking configuration of an App Service Environment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/configurations/networking", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Description for Update networking configuration of an App Service Environment" }, { "info": { "name": "Get diagnostic information for an App Service Environment.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/diagnostics", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Description for Get diagnostic information for an App Service Environment." }, { "info": { "name": "Get the network endpoints of all inbound dependencies of an App Service Environment.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/inboundNetworkDependenciesEndpoints", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Description for Get the network endpoints of all inbound dependencies of an App Service Environment." }, { "info": { "name": "Get all multi-role pools.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/multiRolePools", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Description for Get all multi-role pools." }, { "info": { "name": "Get properties of a multi-role pool.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/multiRolePools/default", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Description for Get properties of a multi-role pool." }, { "info": { "name": "Create or update a multi-role pool.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/multiRolePools/default", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Description for Create or update a multi-role pool." }, { "info": { "name": "Create or update a multi-role pool.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/multiRolePools/default", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Description for Create or update a multi-role pool." }, { "info": { "name": "Get metric definitions for a multi-role pool of an App Service Environment.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/multiRolePools/default/metricdefinitions", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Description for Get metric definitions for a multi-role pool of an App Service Environment." }, { "info": { "name": "Get available SKUs for scaling a multi-role pool.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/multiRolePools/default/skus", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Description for Get available SKUs for scaling a multi-role pool." }, { "info": { "name": "Get usage metrics for a multi-role pool of an App Service Environment.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/multiRolePools/default/usages", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Description for Get usage metrics for a multi-role pool of an App Service Environment." }, { "info": { "name": "List all currently running operations on the App Service Environment.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/operations", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Description for List all currently running operations on the App Service Environment." }, { "info": { "name": "Get the network endpoints of all outbound dependencies of an App Service Environment.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/outboundNetworkDependenciesEndpoints", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Description for Get the network endpoints of all outbound dependencies of an App Service Environment." }, { "info": { "name": "Gets the list of private endpoints associated with a hosting environment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/privateEndpointConnections", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Description for Gets the list of private endpoints associated with a hosting environment" }, { "info": { "name": "Gets a private endpoint connection", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/privateEndpointConnections/:privateEndpointConnectionName", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." }, { "name": "privateEndpointConnectionName", "value": "", "type": "path", "description": "Name of the private endpoint connection." } ] }, "docs": "Description for Gets a private endpoint connection" }, { "info": { "name": "Approves or rejects a private endpoint connection", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/privateEndpointConnections/:privateEndpointConnectionName", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." }, { "name": "privateEndpointConnectionName", "value": "", "type": "path", "description": "Name of the private endpoint connection." } ] }, "docs": "Description for Approves or rejects a private endpoint connection" }, { "info": { "name": "Deletes a private endpoint connection", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/privateEndpointConnections/:privateEndpointConnectionName", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." }, { "name": "privateEndpointConnectionName", "value": "", "type": "path", "description": "Name of the private endpoint connection." } ] }, "docs": "Description for Deletes a private endpoint connection" }, { "info": { "name": "Gets the private link resources", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/privateLinkResources", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Description for Gets the private link resources" }, { "info": { "name": "Reboot all machines in an App Service Environment.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/reboot", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Description for Reboot all machines in an App Service Environment." }, { "info": { "name": "Resume an App Service Environment.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/resume", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Description for Resume an App Service Environment." }, { "info": { "name": "Get all App Service plans in an App Service Environment.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/serverfarms", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Description for Get all App Service plans in an App Service Environment." }, { "info": { "name": "Get all apps in an App Service Environment.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/sites", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." }, { "name": "propertiesToInclude", "value": "", "type": "query", "description": "Comma separated list of app properties to include." } ] }, "docs": "Description for Get all apps in an App Service Environment." }, { "info": { "name": "Suspend an App Service Environment.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/suspend", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Description for Suspend an App Service Environment." }, { "info": { "name": "Send a test notification that an upgrade is available for this App Service Environment.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/testUpgradeAvailableNotification", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Send a test notification that an upgrade is available for this App Service Environment." }, { "info": { "name": "Initiate an upgrade of an App Service Environment if one is available.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/upgrade", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Description for Initiate an upgrade of an App Service Environment if one is available." }, { "info": { "name": "Get global usage metrics of an App Service Environment.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/usages", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." }, { "name": "$filter", "value": "", "type": "query", "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'." } ] }, "docs": "Description for Get global usage metrics of an App Service Environment." }, { "info": { "name": "Get all worker pools of an App Service Environment.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/workerPools", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." } ] }, "docs": "Description for Get all worker pools of an App Service Environment." }, { "info": { "name": "Get properties of a worker pool.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/workerPools/:workerPoolName", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." }, { "name": "workerPoolName", "value": "", "type": "path", "description": "Name of the worker pool." } ] }, "docs": "Description for Get properties of a worker pool." }, { "info": { "name": "Create or update a worker pool.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/workerPools/:workerPoolName", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." }, { "name": "workerPoolName", "value": "", "type": "path", "description": "Name of the worker pool." } ] }, "docs": "Description for Create or update a worker pool." }, { "info": { "name": "Create or update a worker pool.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/workerPools/:workerPoolName", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." }, { "name": "workerPoolName", "value": "", "type": "path", "description": "Name of the worker pool." } ] }, "docs": "Description for Create or update a worker pool." }, { "info": { "name": "Get metric definitions for a worker pool of an App Service Environment.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/workerPools/:workerPoolName/metricdefinitions", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." }, { "name": "workerPoolName", "value": "", "type": "path", "description": "Name of the worker pool." } ] }, "docs": "Description for Get metric definitions for a worker pool of an App Service Environment." }, { "info": { "name": "Get available SKUs for scaling a worker pool.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/workerPools/:workerPoolName/skus", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." }, { "name": "workerPoolName", "value": "", "type": "path", "description": "Name of the worker pool." } ] }, "docs": "Description for Get available SKUs for scaling a worker pool." }, { "info": { "name": "Get usage metrics for a worker pool of an App Service Environment.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/hostingEnvironments/:name/workerPools/:workerPoolName/usages", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." }, { "name": "workerPoolName", "value": "", "type": "path", "description": "Name of the worker pool." } ] }, "docs": "Description for Get usage metrics for a worker pool of an App Service Environment." }, { "info": { "name": "Get a diagnostics item for an App Service Environment.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/microsoft.Web/hostingEnvironments/:name/diagnostics/:diagnosticsName", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the app." }, { "name": "diagnosticsName", "value": "", "type": "path" } ] }, "docs": "Description for Get a diagnostics item for an App Service Environment." }, { "info": { "name": "Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/microsoft.Web/hostingEnvironments/:name/multiRolePools/default/instances/:instance/metricdefinitions", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." }, { "name": "instance", "value": "", "type": "path", "description": "Name of the instance in the multi-role pool." } ] }, "docs": "Description for Get metric definitions for a specific instance of a multi-role pool of an App Service Environment." }, { "info": { "name": "Get metric definitions for a specific instance of a worker pool of an App Service Environment.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/microsoft.Web/hostingEnvironments/:name/workerPools/:workerPoolName/instances/:instance/metricdefinitions", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the App Service Environment." }, { "name": "workerPoolName", "value": "", "type": "path", "description": "Name of the worker pool." }, { "name": "instance", "value": "", "type": "path", "description": "Name of the instance in the worker pool." } ] }, "docs": "Description for Get metric definitions for a specific instance of a worker pool of an App Service Environment." } ] } ], "bundled": true }