Microsoft Azure Functions · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for WebApps API Client App Service Environments API
49 actions
49 updates
phrasing
extends
openapi/microsoft-azure-functions-appserviceenvironments-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Microsoft Azure Functions's API. It is a proposal applied on top of the contract, not a document Microsoft Azure Functions publishes.
What the actions change
x-apievangelist-phrasing
Targets 49 · first 16 shown; the file carries all of them
$.info
$.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Web/hostingEnvironments'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}'].delete
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}'].patch
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/changeVirtualNetwork'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix'].delete
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/networking'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/networking'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics'].get
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for WebApps API Client App Service Environments API
version: 1.0.0
extends: openapi/microsoft-azure-functions-appserviceenvironments-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 48
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Web/hostingEnvironments'].get
update:
x-apievangelist-phrasing:
intent: List all App Service Environments in a subscription
effect: read
questions:
- Which App Service Environments exist across my whole Azure subscription?
- Can I see every ASE in the subscription without picking a resource group first?
instructions:
- text: List every App Service Environment in my subscription.
- text: Show all ASEs across the subscription, regardless of resource group.
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments'].get
update:
x-apievangelist-phrasing:
intent: List App Service Environments in a resource group
effect: read
questions:
- What App Service Environments live in this particular resource group?
- How do I narrow the ASE list down to a single resource group?
instructions:
- text: List the App Service Environments in this resource group only.
- text: Show me the ASEs deployed inside the current resource group.
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}'].get
update:
x-apievangelist-phrasing:
intent: Get an App Service Environment's properties
effect: read
questions:
- What are the current settings and status of one App Service Environment?
- Can I look up the full properties of an ASE by its name?
instructions:
- text: Get the properties of App Service Environment {name}.
slots:
name: path.name
- text: Show me the configuration and provisioning state of ASE {name}.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}'].put
update:
x-apievangelist-phrasing:
intent: Create or replace an App Service Environment
effect: write
questions:
- How do I provision a brand-new App Service Environment?
- Can I replace an existing ASE's full definition with a PUT?
instructions:
- text: Create a new App Service Environment named {name}.
slots:
name: path.name
- text: Provision ASE {name} as kind {kind} with these properties.
slots:
name: path.name
kind: requestBody.kind
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an App Service Environment
effect: destructive
questions:
- How do I tear down an App Service Environment I no longer need?
- Can I force-delete an ASE even if it still hosts apps or plans?
instructions:
- text: Delete App Service Environment {name}.
slots:
name: path.name
- text: Force-delete ASE {name} with forceDelete set to {forceDelete}.
slots:
name: path.name
forceDelete: query.forceDelete
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}'].patch
update:
x-apievangelist-phrasing:
intent: Patch an existing App Service Environment
effect: write
questions:
- Can I change just a few settings on an existing ASE without resending everything?
- What's the way to partially update an App Service Environment I already created?
instructions:
- text: Patch the existing App Service Environment {name} with these property changes.
slots:
name: path.name
- text: Partially update ASE {name}, changing only its kind to {kind}.
slots:
name: path.name
kind: requestBody.kind
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute'].get
update:
x-apievangelist-phrasing:
intent: Get worker compute capacity of an ASE
effect: read
questions:
- How much worker capacity is used versus available in my App Service Environment?
- Is my ASE running out of compute workers?
instructions:
- text: Show the used, available and total worker capacity for ASE {name}.
slots:
name: path.name
- text: Check how much compute capacity is left in App Service Environment {name}.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip'].get
update:
x-apievangelist-phrasing:
intent: Get IP addresses assigned to an ASE
effect: read
questions:
- Which virtual IP addresses are assigned to my App Service Environment?
- What inbound and outbound IPs does an ASE use?
instructions:
- text: Get the IP addresses assigned to App Service Environment {name}.
slots:
name: path.name
- text: List the virtual IPs for ASE {name}.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/changeVirtualNetwork'].post
update:
x-apievangelist-phrasing:
intent: Move an ASE to a different virtual network
effect: write
questions:
- How do I move an App Service Environment to a different VNET?
- Can I point an ASE at another subnet in a new virtual network?
instructions:
- text: Move App Service Environment {name} to the virtual network {id}.
slots:
name: path.name
id: requestBody.id
- text: Change ASE {name} to VNET {id} using subnet {subnet}.
slots:
name: path.name
id: requestBody.id
subnet: requestBody.subnet
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix'].get
update:
x-apievangelist-phrasing:
intent: Get an ASE's custom DNS suffix configuration
effect: read
questions:
- What custom DNS suffix is configured on my App Service Environment?
- Can I check which certificate and suffix an ASE uses for custom DNS?
instructions:
- text: Get the custom DNS suffix configuration of ASE {name}.
slots:
name: path.name
- text: Show the current custom domain suffix settings for App Service Environment {name}.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix'].put
update:
x-apievangelist-phrasing:
intent: Set an ASE's custom DNS suffix configuration
effect: write
questions:
- How do I give my App Service Environment a custom DNS suffix?
- Can I change the DNS suffix an ASE already uses?
instructions:
- text: Set the custom DNS suffix configuration on ASE {name}.
slots:
name: path.name
- text: Update App Service Environment {name} to use this new custom DNS suffix and certificate.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix'].delete
update:
x-apievangelist-phrasing:
intent: Remove an ASE's custom DNS suffix
effect: destructive
questions:
- How do I remove the custom DNS suffix from an App Service Environment?
- Can I revert an ASE to its default domain suffix?
instructions:
- text: Remove the custom DNS suffix configuration from ASE {name}.
slots:
name: path.name
- text: Delete the custom domain suffix set on App Service Environment {name}.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/networking'].get
update:
x-apievangelist-phrasing:
intent: Get an ASE's networking configuration
effect: read
questions:
- What networking settings does my App Service Environment v3 have?
- Is FTP or remote debugging allowed on my ASE's network config?
instructions:
- text: Get the networking configuration of ASE {name}.
slots:
name: path.name
- text: Show the network settings for App Service Environment {name}.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/networking'].put
update:
x-apievangelist-phrasing:
intent: Update an ASE's networking configuration
effect: write
questions:
- How do I change the networking configuration of an App Service Environment?
- Can I turn on new private IP or FTP settings for an ASE's network?
instructions:
- text: Update the networking configuration of ASE {name}.
slots:
name: path.name
- text: Apply these network settings to App Service Environment {name}.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics'].get
update:
x-apievangelist-phrasing:
intent: List diagnostic information for an ASE
effect: read
questions:
- What diagnostic information is available for my App Service Environment?
- Which diagnostics items can I pull for an ASE?
instructions:
- text: List the diagnostics for App Service Environment {name}.
slots:
name: path.name
- text: Show every diagnostic entry collected for ASE {name}.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/inboundNetworkDependenciesEndpoints'].get
update:
x-apievangelist-phrasing:
intent: List inbound network dependencies of an ASE
effect: read
questions:
- Which inbound network endpoints does my App Service Environment depend on?
- What inbound traffic do I need to allow through my firewall for an ASE?
instructions:
- text: Get the inbound network dependency endpoints for ASE {name}.
slots:
name: path.name
- text: List the inbound addresses and ports App Service Environment {name} relies on.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools'].get
update:
x-apievangelist-phrasing:
intent: List the multi-role pools of an ASE
effect: read
questions:
- What multi-role pools does my App Service Environment have?
- Can I list the front-end multi-role pools in an ASE?
instructions:
- text: List all multi-role pools in ASE {name}.
slots:
name: path.name
- text: Show the multi-role pool collection for App Service Environment {name}.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default'].get
update:
x-apievangelist-phrasing:
intent: Get the default multi-role pool of an ASE
effect: read
questions:
- What size and instance count is my ASE's default multi-role pool?
- Can I see the properties of the multi-role pool in an App Service Environment?
instructions:
- text: Get the default multi-role pool for ASE {name}.
slots:
name: path.name
- text: Show the worker size and count of the multi-role pool in App Service Environment {name}.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default'].put
update:
x-apievangelist-phrasing:
intent: Create or replace an ASE's multi-role pool
effect: write
questions:
- How do I define the multi-role pool for a new App Service Environment?
- Can I replace the whole multi-role pool definition including its SKU?
instructions:
- text: Create or replace the multi-role pool of ASE {name}.
slots:
name: path.name
- text: Set the multi-role pool in App Service Environment {name} to SKU {sku}.
slots:
name: path.name
sku: requestBody.sku
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default'].patch
update:
x-apievangelist-phrasing:
intent: Patch an ASE's existing multi-role pool
effect: write
questions:
- Can I scale an existing multi-role pool without redefining it?
- What's the way to patch only some multi-role pool settings on an ASE?
instructions:
- text: Patch the existing multi-role pool of ASE {name} with these changes.
slots:
name: path.name
- text: Partially update the multi-role pool in {name}, changing its SKU to {sku}.
slots:
name: path.name
sku: requestBody.sku
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metricdefinitions'].get
update:
x-apievangelist-phrasing:
intent: List metric definitions for an ASE's multi-role pool
effect: read
questions:
- Which metrics can I track for the multi-role pool of my ASE?
- What metric definitions exist for an App Service Environment's front ends?
instructions:
- text: List the metric definitions for the multi-role pool of ASE {name}.
slots:
name: path.name
- text: Show which metrics are defined for the multi-role pool in App Service Environment {name}.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/skus'].get
update:
x-apievangelist-phrasing:
intent: List SKUs available for scaling a multi-role pool
effect: read
questions:
- What SKUs can I scale my ASE's multi-role pool to?
- Which sizes are available for the multi-role pool of an App Service Environment?
instructions:
- text: List the SKUs available for scaling the multi-role pool of ASE {name}.
slots:
name: path.name
- text: Show the sizes I can move the multi-role pool in {name} to.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/usages'].get
update:
x-apievangelist-phrasing:
intent: Get usage metrics for an ASE's multi-role pool
effect: read
questions:
- How heavily is the multi-role pool of my ASE being used?
- Can I see usage figures for an App Service Environment's front-end pool?
instructions:
- text: Get usage metrics for the multi-role pool of ASE {name}.
slots:
name: path.name
- text: Show current multi-role pool usage in App Service Environment {name}.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations'].get
update:
x-apievangelist-phrasing:
intent: List running operations on an ASE
effect: read
questions:
- What operations are currently running against my App Service Environment?
- Is an upgrade or scale operation still in progress on my ASE?
instructions:
- text: List the operations currently running on ASE {name}.
slots:
name: path.name
- text: Show what in-progress operations App Service Environment {name} has.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/outboundNetworkDependenciesEndpoints'].get
update:
x-apievangelist-phrasing:
intent: List outbound network dependencies of an ASE
effect: read
questions:
- Which outbound endpoints must my App Service Environment be able to reach?
- What egress addresses do I need to allow for an ASE to work?
instructions:
- text: Get the outbound network dependency endpoints for ASE {name}.
slots:
name: path.name
- text: List the outbound destinations App Service Environment {name} depends on.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections'].get
update:
x-apievangelist-phrasing:
intent: List private endpoint connections on an ASE
effect: read
questions:
- Which private endpoints are connected to my App Service Environment?
- Can I see every private endpoint connection on a hosting environment?
instructions:
- text: List the private endpoint connections for ASE {name}.
slots:
name: path.name
- text: Show all private endpoints attached to App Service Environment {name}.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName}'].get
update:
x-apievangelist-phrasing:
intent: Get one private endpoint connection on an ASE
effect: read
questions:
- What is the approval state of a specific private endpoint connection on my ASE?
- Can I look up one private endpoint connection by name?
instructions:
- text: Get private endpoint connection {privateEndpointConnectionName} on ASE {name}.
slots:
privateEndpointConnectionName: path.privateEndpointConnectionName
name: path.name
- text: Show the status of connection {privateEndpointConnectionName} for App Service Environment {name}.
slots:
privateEndpointConnectionName: path.privateEndpointConnectionName
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName}'].put
update:
x-apievangelist-phrasing:
intent: Approve or reject a private endpoint connection
effect: write
questions:
- How do I approve a pending private endpoint request on my App Service Environment?
- Can I reject a private endpoint connection someone requested to my ASE?
instructions:
- text: Approve private endpoint connection {privateEndpointConnectionName} on ASE {name}.
slots:
privateEndpointConnectionName: path.privateEndpointConnectionName
name: path.name
- text: Reject the private endpoint connection {privateEndpointConnectionName} to App Service Environment {name}.
slots:
privateEndpointConnectionName: path.privateEndpointConnectionName
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a private endpoint connection from an ASE
effect: destructive
questions:
- How do I remove a private endpoint connection from an App Service Environment?
- Can I disconnect a private endpoint from my ASE entirely?
instructions:
- text: Delete private endpoint connection {privateEndpointConnectionName} from ASE {name}.
slots:
privateEndpointConnectionName: path.privateEndpointConnectionName
name: path.name
- text: Remove connection {privateEndpointConnectionName} from App Service Environment {name}.
slots:
privateEndpointConnectionName: path.privateEndpointConnectionName
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateLinkResources'].get
update:
x-apievangelist-phrasing:
intent: List private link resources of an ASE
effect: read
questions:
- What private link resources does my App Service Environment expose?
- Which group IDs can a private endpoint target on an ASE?
instructions:
- text: Get the private link resources for ASE {name}.
slots:
name: path.name
- text: List the private-linkable sub-resources of App Service Environment {name}.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/reboot'].post
update:
x-apievangelist-phrasing:
intent: Reboot all machines in an ASE
effect: write
questions:
- How do I reboot every machine in an App Service Environment?
- Can I restart the whole ASE at once to clear a bad state?
instructions:
- text: Reboot all machines in App Service Environment {name}.
slots:
name: path.name
- text: Restart every instance in ASE {name}.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/resume'].post
update:
x-apievangelist-phrasing:
intent: Resume a suspended App Service Environment
effect: write
questions:
- How do I bring a suspended App Service Environment back online?
- Can I resume an ASE that was suspended?
instructions:
- text: Resume App Service Environment {name}.
slots:
name: path.name
- text: Bring suspended ASE {name} back into service.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms'].get
update:
x-apievangelist-phrasing:
intent: List App Service plans hosted in an ASE
effect: read
questions:
- Which App Service plans are hosted inside my App Service Environment?
- What server farms run in a given ASE?
instructions:
- text: List the App Service plans in ASE {name}.
slots:
name: path.name
- text: Show every plan hosted in App Service Environment {name}.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites'].get
update:
x-apievangelist-phrasing:
intent: List apps running in an ASE
effect: read
questions:
- Which web and function apps are running in my App Service Environment?
- Can I limit which properties come back when listing apps in an ASE?
instructions:
- text: List all apps in App Service Environment {name}.
slots:
name: path.name
- text: List apps in ASE {name}, including only the properties {propertiesToInclude}.
slots:
name: path.name
propertiesToInclude: query.propertiesToInclude
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/suspend'].post
update:
x-apievangelist-phrasing:
intent: Suspend an App Service Environment
effect: write
questions:
- How do I suspend an App Service Environment temporarily?
- Can I pause an ASE without deleting it?
instructions:
- text: Suspend App Service Environment {name}.
slots:
name: path.name
- text: Put ASE {name} into a suspended state.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/testUpgradeAvailableNotification'].post
update:
x-apievangelist-phrasing:
intent: Send a test upgrade-available notification
effect: write
questions:
- Can I trigger a test notification saying an upgrade is available for my ASE?
- How can I verify my alerts fire when an App Service Environment upgrade becomes available?
instructions:
- text: Send a test upgrade-available notification for ASE {name}.
slots:
name: path.name
- text: Fire a test upgrade notice for App Service Environment {name} so I can check my alerts.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/upgrade'].post
update:
x-apievangelist-phrasing:
intent: Start an available upgrade of an ASE
effect: write
questions:
- How do I kick off a pending upgrade on my App Service Environment?
- Can I upgrade an ASE manually when an upgrade is available?
instructions:
- text: Upgrade App Service Environment {name} if an upgrade is available.
slots:
name: path.name
- text: Initiate the pending platform upgrade on ASE {name}.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages'].get
update:
x-apievangelist-phrasing:
intent: Get overall usage metrics of an ASE
effect: read
questions:
- What is the overall resource usage of my App Service Environment?
- Can I filter ASE-wide usage metrics by name or time range?
instructions:
- text: Get global usage metrics for ASE {name}.
slots:
name: path.name
- text: Show App Service Environment {name} usages filtered by {filter}.
slots:
name: path.name
filter: query.$filter
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools'].get
update:
x-apievangelist-phrasing:
intent: List worker pools of an ASE
effect: read
questions:
- What worker pools are in my App Service Environment?
- Can I see all the worker pools of an ASE at once?
instructions:
- text: List all worker pools of ASE {name}.
slots:
name: path.name
- text: Show the worker pools configured in App Service Environment {name}.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}'].get
update:
x-apievangelist-phrasing:
intent: Get properties of an ASE worker pool
effect: read
questions:
- What size and worker count does a particular worker pool in my ASE have?
- Can I look up one worker pool by name?
instructions:
- text: Get worker pool {workerPoolName} in ASE {name}.
slots:
workerPoolName: path.workerPoolName
name: path.name
- text: Show the settings of worker pool {workerPoolName} for App Service Environment {name}.
slots:
workerPoolName: path.workerPoolName
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}'].put
update:
x-apievangelist-phrasing:
intent: Create or replace an ASE worker pool
effect: write
questions:
- How do I add a new worker pool to an App Service Environment?
- Can I replace a worker pool's complete definition including SKU?
instructions:
- text: Create worker pool {workerPoolName} in ASE {name}.
slots:
workerPoolName: path.workerPoolName
name: path.name
- text: Define worker pool {workerPoolName} in {name} with SKU {sku}.
slots:
workerPoolName: path.workerPoolName
name: path.name
sku: requestBody.sku
method: generated
generated: '2026-10-01'
# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure-functions/refs/heads/main/overlays/microsoft-azure-functions-appserviceenvironments-api-phrasing-overlay.yaml
Work with this as data
Every overlay here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for openapi overlays
4 MCP tools reach this
find_overlaysBrowse and filter every overlay in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/microsoft-azure-functions-appserviceenvironments-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.