Microsoft Azure · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Azure API Client App Service Environments API

49 actions 49 updates phrasing extends openapi/microsoft-azure-appserviceenvironments-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Microsoft Azure's API. It is a proposal applied on top of the contract, not a document Microsoft Azure publishes.
View Overlay File View on GitHub Overlay Specification

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

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure API Client App Service Environments API
  version: 1.0.0
extends: openapi/microsoft-azure-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 App Service Environments in a subscription
      effect: read
      questions:
      - Which App Service Environments exist across my whole Azure subscription?
      - Can I see every isolated App Service Environment I own without picking a resource group?
      instructions:
      - text: List all App Service Environments in subscription {sub}.
        slots:
          sub: path.subscriptionId
      - text: Show me every ASE across the subscription, regardless of resource group.
      method: generated
      generated: '2026-09-26'
- 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 one particular resource group?
      - Can I filter my App Service Environments down to a single resource group?
      instructions:
      - text: List the App Service Environments in resource group {rg}.
        slots:
          rg: path.resourceGroupName
      - text: Show which ASEs are deployed under subscription {sub}, resource group {rg}.
        slots:
          rg: path.resourceGroupName
          sub: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- 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:
      - How do I look up the full properties of one App Service Environment?
      - What settings and status does a specific ASE currently have?
      instructions:
      - text: Get the properties of App Service Environment {name} in subscription {sub}, resource group {rg}.
        slots:
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show me the configuration and state of ASE {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update an App Service Environment
      effect: write
      questions:
      - How do I provision a new App Service Environment in a resource group?
      - Can I change an existing App Service Environment's properties by re-submitting it?
      instructions:
      - text: Create App Service Environment {ase} under resource group {rg}, subscription {sub}.
        slots:
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Update the properties of ASE {ase} to {properties}.
        slots:
          ase: path.name
          properties: requestBody.properties
      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:
      - Can I tear down an App Service Environment I no longer need?
      - Is there a way to force delete an ASE even when it still hosts resources?
      instructions:
      - text: Delete App Service Environment {name} from subscription {sub}, resource group {rg}.
        slots:
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Force delete ASE {name} in subscription {sub}, resource group {rg} with forceDelete set to {forceDelete}.
        slots:
          name: path.name
          rg: path.resourceGroupName
          forceDelete: query.forceDelete
          sub: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- 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 only a few properties on an App Service Environment that already exists?
      - What's the way to partially update an ASE without resending its whole definition?
      instructions:
      - text: Patch the existing ASE {name} in subscription {sub}, resource group {rg} with {properties}.
        slots:
          name: path.name
          rg: path.resourceGroupName
          properties: requestBody.properties
          sub: path.subscriptionId
      - text: Apply a partial update to App Service Environment {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an ASE's worker compute capacity
      effect: read
      questions:
      - How much worker capacity is used versus available in my App Service Environment?
      - Is my ASE running out of total compute workers?
      instructions:
      - text: Show the used, available and total worker capacity of ASE {name} in subscription {sub}, resource group {rg}.
        slots:
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Check compute capacity for App Service Environment {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- 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:
      - What IP addresses are assigned to my App Service Environment?
      - Which virtual IPs does an ASE expose for inbound traffic?
      instructions:
      - text: List the IP addresses assigned to ASE {name} in subscription {sub}, resource group {rg}.
        slots:
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show the virtual IP info for App Service Environment {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- 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:
      - Can I move an App Service Environment onto another VNET?
      - Is it possible to relocate an ASE to a different virtual network after it's created?
      instructions:
      - text: Move App Service Environment {name} in subscription {sub}, resource group {rg} to a different VNET.
        slots:
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Change the virtual network of ASE {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- 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 whether an ASE uses a custom domain suffix?
      instructions:
      - text: Show the custom DNS suffix configuration of ASE {name} in subscription {sub}, resource group {rg}.
        slots:
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Get the DNS suffix settings for App Service Environment {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an ASE's custom DNS suffix configuration
      effect: write
      questions:
      - How do I set a custom DNS suffix on an App Service Environment?
      - Can I change the domain suffix my ASE apps are served under?
      instructions:
      - text: Update the custom DNS suffix configuration of ASE {name} in subscription {sub}, resource group {rg}.
        slots:
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Set a new custom DNS suffix on App Service Environment {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- 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 configuration
      effect: destructive
      questions:
      - Can I remove the custom DNS suffix from an App Service Environment?
      - What happens if I clear an ASE's custom domain suffix setting?
      instructions:
      - text: Delete the custom DNS suffix configuration from ASE {name} in subscription {sub}, resource group {rg}.
        slots:
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Remove the custom DNS suffix on App Service Environment {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- 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 configuration does my App Service Environment v3 have?
      - Can I review the network settings applied to an ASE?
      instructions:
      - text: Show the networking configuration of ASE {name} in subscription {sub}, resource group {rg}.
        slots:
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Get network settings for App Service Environment {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- 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:
      - Can I change the networking configuration of an existing App Service Environment?
      - Is there an API to adjust ASE network settings after deployment?
      instructions:
      - text: Update the networking configuration of ASE {name} in subscription {sub}, resource group {rg}.
        slots:
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Change network settings on App Service Environment {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- 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?
      - Can I pull the list of diagnostics items an ASE reports?
      instructions:
      - text: List diagnostic information for ASE {name} in subscription {sub}, resource group {rg}.
        slots:
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show all diagnostics for App Service Environment {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics/{diagnosticsName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one diagnostics item for an ASE
      effect: read
      questions:
      - How do I read a single named diagnostics item from an App Service Environment?
      - Can I drill into one specific ASE diagnostic by its name?
      instructions:
      - text: Get diagnostics item {diagnosticsName} for ASE {name} in subscription {sub}, resource group {rg}.
        slots:
          diagnosticsName: path.diagnosticsName
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show the {diagnosticsName} diagnostic for App Service Environment {name}.
        slots:
          diagnosticsName: path.diagnosticsName
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/inboundNetworkDependenciesEndpoints'].get
  update:
    x-apievangelist-phrasing:
      intent: List an ASE's inbound network dependency endpoints
      effect: read
      questions:
      - Which inbound network endpoints does my App Service Environment depend on?
      - What inbound traffic sources must I allow for an ASE to work?
      instructions:
      - text: List inbound network dependency endpoints for ASE {name} in subscription {sub}, resource group {rg}.
        slots:
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show the inbound dependencies of App Service Environment {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools'].get
  update:
    x-apievangelist-phrasing:
      intent: List an ASE's multi-role pools
      effect: read
      questions:
      - What multi-role pools does an App Service Environment have?
      - Can I enumerate the front-end multi-role pools in my ASE?
      instructions:
      - text: List all multi-role pools in ASE {name} in subscription {sub}, resource group {rg}.
        slots:
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show multi-role pools for App Service Environment {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an ASE's default multi-role pool
      effect: read
      questions:
      - What are the properties of the default multi-role pool in my ASE?
      - How big is the multi-role pool in an App Service Environment right now?
      instructions:
      - text: Get the default multi-role pool properties of ASE {name} in subscription {sub}, resource group {rg}.
        slots:
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show the multi-role pool details for App Service Environment {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update an ASE's multi-role pool
      effect: write
      questions:
      - How do I scale the multi-role pool of an App Service Environment to a different SKU?
      - Can I create or reconfigure an ASE's multi-role pool?
      instructions:
      - text: Update the multi-role pool of ASE {ase} in {rg}, subscription {sub} to SKU {sku}.
        slots:
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
          sku: requestBody.sku
      - text: Set {ase}'s multi-role pool SKU to {sku}.
        slots:
          ase: 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 multi-role pool
      effect: write
      questions:
      - Can I scale an existing multi-role pool without redefining it?
      - Is a partial update possible on the multi-role pool of my ASE?
      instructions:
      - text: Patch the existing multi-role pool of ASE {name} in subscription {sub}, resource group {rg} to SKU {sku}.
        slots:
          name: path.name
          rg: path.resourceGroupName
          sku: requestBody.sku
          sub: path.subscriptionId
      - text: Partially update multi-role pool properties {properties} on ASE {name}.
        slots:
          properties: requestBody.properties
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metricdefinitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List metric definitions for one multi-role pool instance
      effect: read
      questions:
      - What metrics can I query for a single instance of an ASE multi-role pool?
      - Which metric definitions apply to one specific multi-role instance?
      instructions:
      - text: Pull per-instance metric definitions for multi-role instance {instance} on ASE {name}, subscription {sub}, group {rg}.
        slots:
          instance: path.instance
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show available metrics for multi-role instance {instance} on ASE {name}.
        slots:
          instance: path.instance
          name: path.name
      method: generated
      generated: '2026-09-26'
- 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 multi-role pool
      effect: read
      questions:
      - Which metrics are defined for the multi-role pool as a whole?
      - What can I monitor on an App Service Environment's multi-role pool?
      instructions:
      - text: List metric definitions for the multi-role pool of ASE {name} in subscription {sub}, resource group {rg}.
        slots:
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show pool-level multi-role metric definitions for ASE {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/skus'].get
  update:
    x-apievangelist-phrasing:
      intent: List SKUs for scaling an ASE multi-role pool
      effect: read
      questions:
      - What SKUs can I scale my ASE multi-role pool to?
      - Which sizes are available for the multi-role pool of an App Service Environment?
      instructions:
      - text: List SKUs available for scaling the multi-role pool of ASE {name} in subscription {sub}, resource group {rg}.
        slots:
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show multi-role pool scaling options for ASE {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- 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 that an ASE upgrade is available?
      - How do I check that my upgrade alerts for an App Service Environment actually fire?
      instructions:
      - text: Send a test upgrade-available notification for ASE {name} in subscription {sub}, resource group {rg}.
        slots:
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Fire a test upgrade notification for App Service Environment {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/upgrade'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an App Service Environment upgrade
      effect: write
      questions:
      - Can I kick off an ASE upgrade myself when one is available?
      - Is there a way to start upgrading an App Service Environment on demand?
      instructions:
      - text: Initiate an upgrade of ASE {name} in subscription {sub}, resource group {rg} if one is available.
        slots:
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Upgrade App Service Environment {name} now.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- 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 multi-role pool
      effect: read
      questions:
      - How heavily is the multi-role pool of my ASE being used?
      - Can I see usage numbers specifically for the multi-role pool?
      instructions:
      - text: Show usage metrics for the multi-role pool of ASE {name} in subscription {sub}, resource group {rg}.
        slots:
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Get multi-role pool usage for App Service Environment {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- 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 on my App Service Environment?
      - Is anything still in progress on an ASE before I make changes?
      instructions:
      - text: List currently running operations on ASE {name} in subscription {sub}, resource group {rg}.
        slots:
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show in-progress operations for App Service Environment {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/outboundNetworkDependenciesEndpoints'].get
  update:
    x-apievangelist-phrasing:
      intent: List an ASE's outbound network dependency endpoints
      effect: read
      questions:
      - Which outbound endpoints does my App Service Environment need to reach?
      - What outbound destinations must my firewall allow for an ASE?
      instructions:
      - text: List outbound network dependency endpoints for ASE {name} in subscription {sub}, resource group {rg}.
        slots:
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show the outbound dependencies of App Service Environment {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- 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 private endpoint connections for ASE {name} in subscription {sub}, resource group {rg}.
        slots:
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show all private endpoints attached to App Service Environment {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- 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?
      - How do I inspect a single private endpoint connection by name?
      instructions:
      - text: Get private endpoint connection {connection} on ASE {name} in subscription {sub}, resource group {rg}.
        slots:
          connection: path.privateEndpointConnectionName
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show details of private endpoint connection {connection} for ASE {name}.
        slots:
          connection: path.privateEndpointConnectionName
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Approve or reject an ASE private endpoint connection
      effect: write
      questions:
      - Can I approve a pending private endpoint request on my App Service Environment?
      - How do I reject a private endpoint connection someone requested to my ASE?
      instructions:
      - text: Approve private endpoint connection {connection} on ASE {name} in subscription {sub}, resource group {rg}.
        slots:
          connection: path.privateEndpointConnectionName
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Reject private endpoint connection {connection} on App Service Environment {name}.
        slots:
          connection: path.privateEndpointConnectionName
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an ASE private endpoint connection
      effect: destructive
      questions:
      - Can I remove a private endpoint connection from an App Service Environment?
      - What's the way to disconnect a private endpoint from my ASE entirely?
      instructions:
      - text: Delete private endpoint connection {connection} from ASE {name} in subscription {sub}, resource group {rg}.
        slots:
          connection: path.privateEndpointConnectionName
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Remove private endpoint connection {connection} on ASE {name}.
        slots:
          connection: path.privateEndpointConnectionName
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateLinkResources'].get
  update:
    x-apievangelist-phrasing:
      intent: List private link resources for an ASE
      effect: read
      questions:
      - Which private link resources can I target on my App Service Environment?
      - What group IDs does an ASE expose for Private Link?
      instructions:
      - text: List private link resources for ASE {name} in subscription {sub}, resource group {rg}.
        slots:
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show the Private Link resources of App Service Environment {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- 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:
      - Can I restart every machine in an App Service Environment at once?
      - How do I reboot an ASE that seems stuck?
      instructions:
      - text: Reboot all machines in ASE {name} in subscription {sub}, resource group {rg}.
        slots:
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Restart App Service Environment {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- 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:
      - Can I bring a suspended App Service Environment back online?
      - What do I call to resume an ASE after it was suspended?
      instructions:
      - text: Resume App Service Environment {name} in subscription {sub}, resource group {rg}.
        slots:
          name: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Bring suspended ASE {name} back up.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'


# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/overlays/microsoft-azure-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.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/microsoft-azure-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.