Microsoft Azure · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Azure WebSite Management Client Hosting…

38 actions 38 updates phrasing extends openapi/microsoft-azure-hostingenvironments-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 38 · first 16 shown; the file carries all of them

$.info
$.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}/diagnostics'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics/{diagnosticsName}'].get
$.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'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/reboot'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations/{operationId}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metrics'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metricdefinitions'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metrics'].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 WebSite Management Client Hosting…
  version: 1.0.0
extends: openapi/microsoft-azure-hostingenvironments-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 37
- 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 configuration and location does my App Service Environment have?
      - Can I look up a single ASE by its name to see its settings?
      instructions:
      - text: Get App Service Environment {ase} in resource group {rg} of subscription {sub}.
        slots:
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show me the configuration of my ASE called {ase}.
        slots:
          ase: 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 chosen region?
      - Can I change the tags on an existing App Service Environment by re-submitting it?
      instructions:
      - text: Create App Service Environment {ase} in {location} under resource group {rg}, subscription {sub}.
        slots:
          ase: path.name
          location: requestBody.location
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Update the tags on ASE {ase} to {tags}.
        slots:
          ase: path.name
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- 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:
      - What's the way to tear down an App Service Environment I no longer need?
      - Is there a force option for deleting an ASE that still holds resources?
      instructions:
      - text: Delete App Service Environment {ase} from resource group {rg} in subscription {sub}.
        slots:
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Remove ASE {ase} with forceDelete set to {force_delete}.
        slots:
          ase: path.name
          force_delete: query.forceDelete
      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 diagnostics for an App Service Environment
      effect: read
      questions:
      - What diagnostic information is available for my App Service Environment?
      - Which diagnostics can I pull for an ASE when troubleshooting it?
      instructions:
      - text: List the diagnostic reports available for ASE {ase} in {rg}, subscription {sub}.
        slots:
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show every diagnostics entry recorded for {ase}.
        slots:
          ase: 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 App Service Environment
      effect: read
      questions:
      - Can I fetch one specific diagnostics entry for an App Service Environment by name?
      - Where do I read the details of a single named ASE diagnostic?
      instructions:
      - text: Get diagnostic {diag} for App Service Environment {ase} in {rg}, subscription {sub}.
        slots:
          diag: path.diagnosticsName
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Open the {diag} diagnostics item on my ASE {ase}.
        slots:
          diag: path.diagnosticsName
          ase: 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: Check worker capacity of an App Service Environment
      effect: read
      questions:
      - How much worker capacity is used versus available in my App Service Environment?
      - Can I check total compute capacity left in an ASE before scaling?
      instructions:
      - text: Show used, available and total worker capacity for ASE {ase} in {rg}, subscription {sub}.
        slots:
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Check how much compute headroom is left in {ase}.
        slots:
          ase: 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 App Service Environment
      effect: read
      questions:
      - Which IP addresses are assigned to my App Service Environment?
      - Can I look up the virtual IP addresses of an ASE?
      instructions:
      - text: List the IP addresses assigned to ASE {ase} in {rg}, subscription {sub}.
        slots:
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Get the virtual IPs for App Service Environment {ase}.
        slots:
          ase: path.name
      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:
      - Which App Service Environments exist in a given resource group?
      - Is there a way to enumerate every ASE in one resource group?
      instructions:
      - text: List all App Service Environments in resource group {rg} of subscription {sub}.
        slots:
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show every ASE under {rg}.
        slots:
          rg: path.resourceGroupName
      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 App Service Environment
      effect: write
      questions:
      - How do I reboot all the machines in an App Service Environment?
      - Can I restart an ASE's underlying machines without deleting it?
      instructions:
      - text: Reboot every machine in ASE {ase} in {rg}, subscription {sub}.
        slots:
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Restart all machines behind App Service Environment {ase}.
        slots:
          ase: 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 App Service Environment
      effect: read
      questions:
      - What operations are currently running on my App Service Environment?
      - Can I see in-progress work on an ASE before I make changes?
      instructions:
      - text: List the currently running operations on ASE {ase} in {rg}, subscription {sub}.
        slots:
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show what's in progress on App Service Environment {ase} right now.
        slots:
          ase: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations/{operationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an operation's status on an App Service Environment
      effect: read
      questions:
      - Where can I check the status of one specific operation on an App Service Environment?
      - Did the operation I started on my ASE finish yet?
      instructions:
      - text: Get the status of operation {op_id} on ASE {ase} in {rg}, subscription {sub}.
        slots:
          op_id: path.operationId
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Check whether operation {op_id} on {ase} has completed.
        slots:
          op_id: path.operationId
          ase: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get global metrics of an App Service Environment
      effect: read
      questions:
      - What environment-wide metrics does my App Service Environment report?
      - Can I filter the global metrics of an ASE with a filter expression?
      instructions:
      - text: Get global metrics for ASE {ase} in {rg}, subscription {sub}.
        slots:
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Pull environment-wide metrics for {ase} filtered by {filter}.
        slots:
          ase: path.name
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metricdefinitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List global metric definitions of an App Service Environment
      effect: read
      questions:
      - Which metric definitions are available at the environment level for an ASE?
      - Where do I find the list of global metric definitions for an App Service Environment?
      instructions:
      - text: List global metric definitions for ASE {ase} in {rg}, subscription {sub}.
        slots:
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show which environment-level metrics {ase} defines.
        slots:
          ase: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages'].get
  update:
    x-apievangelist-phrasing:
      intent: Get global usages of an App Service Environment
      effect: read
      questions:
      - How much of my App Service Environment's resources are in use overall?
      - Can I filter the environment-wide usage figures for an ASE?
      instructions:
      - text: Get global usages for ASE {ase} in {rg}, subscription {sub}.
        slots:
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show overall usage for {ase} filtered by {filter}.
        slots:
          ase: path.name
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metrics for an ASE's multi-role pool
      effect: read
      questions:
      - What performance metrics does the multi-role pool of my ASE report?
      - Can I get multi-role pool metrics for a time window at a specific time grain?
      instructions:
      - text: Get multi-role pool metrics for ASE {ase} in {rg}, subscription {sub}.
        slots:
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Pull multi-role pool metrics for {ase} from {start} to {end} at {grain} granularity.
        slots:
          ase: path.name
          start: query.startTime
          end: query.endTime
          grain: query.timeGrain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metrics for a worker pool in an ASE
      effect: read
      questions:
      - What does performance look like for one worker pool in my App Service Environment?
      - Can I narrow worker pool metrics with a filter?
      instructions:
      - text: Get metrics for worker pool {pool} of ASE {ase} in {rg}, subscription {sub}.
        slots:
          pool: path.workerPoolName
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Fetch worker pool {pool} metrics on {ase} filtered by {filter}.
        slots:
          pool: path.workerPoolName
          ase: path.name
          filter: query.$filter
      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's multi-role pool
      effect: read
      questions:
      - Which metrics can the multi-role pool of an ASE report on?
      - Where are the metric definitions for an App Service Environment's multi-role pool?
      instructions:
      - text: List metric definitions for the multi-role pool of ASE {ase} in {rg}, subscription {sub}.
        slots:
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show which metrics {ase}'s multi-role pool defines.
        slots:
          ase: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metricdefinitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List metric definitions for a worker pool in an ASE
      effect: read
      questions:
      - What metrics are defined for a worker pool in my ASE?
      - Can I discover the available worker pool metric names before querying them?
      instructions:
      - text: List metric definitions for worker pool {pool} of ASE {ase} in {rg}, subscription {sub}.
        slots:
          pool: path.workerPoolName
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show the metric catalog for worker pool {pool} on {ase}.
        slots:
          pool: path.workerPoolName
          ase: 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 usages for an ASE's multi-role pool
      effect: read
      questions:
      - How much of the multi-role pool is being used in my App Service Environment?
      - Can I see usage figures just for an ASE's multi-role pool?
      instructions:
      - text: Get multi-role pool usages for ASE {ase} in {rg}, subscription {sub}.
        slots:
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show usage of the multi-role pool on {ase}.
        slots:
          ase: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/usages'].get
  update:
    x-apievangelist-phrasing:
      intent: Get usages for a worker pool in an ASE
      effect: read
      questions:
      - What is the current usage of a specific worker pool in my ASE?
      - Can I check usage on one worker pool before scaling it?
      instructions:
      - text: Get usages for worker pool {pool} of ASE {ase} in {rg}, subscription {sub}.
        slots:
          pool: path.workerPoolName
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show how heavily worker pool {pool} on {ase} is used.
        slots:
          pool: path.workerPoolName
          ase: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites'].get
  update:
    x-apievangelist-phrasing:
      intent: List sites hosted on an App Service Environment
      effect: read
      questions:
      - Which web apps are running on my App Service Environment?
      - Can I choose extra properties to include when listing sites on an ASE?
      instructions:
      - text: List all sites hosted on ASE {ase} in {rg}, subscription {sub}.
        slots:
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show the apps on {ase} including properties {props}.
        slots:
          ase: path.name
          props: query.propertiesToInclude
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/webhostingplans'].get
  update:
    x-apievangelist-phrasing:
      intent: List web hosting plans on an App Service Environment
      effect: read
      questions:
      - What web hosting plans are deployed on my App Service Environment?
      - Can I list an ASE's App Service plans through the webhostingplans endpoint?
      instructions:
      - text: List web hosting plans on ASE {ase} in {rg}, subscription {sub}.
        slots:
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show the webhostingplans collection for {ase}.
        slots:
          ase: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms'].get
  update:
    x-apievangelist-phrasing:
      intent: List server farms on an App Service Environment
      effect: read
      questions:
      - Which server farms are running inside my App Service Environment?
      - Is there a server farms view of the plans hosted on an ASE?
      instructions:
      - text: List server farms on ASE {ase} in {rg}, subscription {sub}.
        slots:
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show the serverfarms collection for {ase}.
        slots:
          ase: 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 multi-role pools in an App Service Environment
      effect: read
      questions:
      - What multi-role pools does my App Service Environment have?
      - Can I enumerate every multi-role pool configured on an ASE?
      instructions:
      - text: List multi-role pools in ASE {ase} in {rg}, subscription {sub}.
        slots:
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Enumerate the multi-role pools of {ase}.
        slots:
          ase: 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 the default multi-role pool of an ASE
      effect: read
      questions:
      - What are the properties of the default multi-role pool in my ASE?
      - Can I check the SKU currently set on an ASE's multi-role pool?
      instructions:
      - text: Get the default multi-role pool of ASE {ase} in {rg}, subscription {sub}.
        slots:
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show the properties of {ase}'s multi-role pool.
        slots:
          ase: 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} in {location}.
        slots:
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
          sku: requestBody.sku
          location: requestBody.location
      - text: Set {ase}'s multi-role pool SKU to {sku}.
        slots:
          ase: path.name
          sku: requestBody.sku
      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's multi-role pool
      effect: read
      questions:
      - Which SKUs can I scale my ASE's multi-role pool to?
      - What sizes are available for the multi-role pool of an App Service Environment?
      instructions:
      - text: List available scaling SKUs for the multi-role pool of ASE {ase} in {rg}, subscription {sub}.
        slots:
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show multi-role pool SKU options for {ase}.
        slots:
          ase: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools'].get
  update:
    x-apievangelist-phrasing:
      intent: List worker pools in an App Service Environment
      effect: read
      questions:
      - What worker pools exist in my App Service Environment?
      - Can I list every worker pool in an ASE along with its settings?
      instructions:
      - text: List all worker pools in ASE {ase} in {rg}, subscription {sub}.
        slots:
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Enumerate the worker pools of {ase}.
        slots:
          ase: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a worker pool in an App Service Environment
      effect: read
      questions:
      - What are the properties of a specific worker pool in my ASE?
      - Can I check the SKU of one named worker pool?
      instructions:
      - text: Get worker pool {pool} of ASE {ase} in {rg}, subscription {sub}.
        slots:
          pool: path.workerPoolName
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show the properties of worker pool {pool} on {ase}.
        slots:
          pool: path.workerPoolName
          ase: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a worker pool in an ASE
      effect: write
      questions:
      - How do I add a new worker pool to an App Service Environment?
      - Can I change the SKU of an existing worker pool in my ASE?
      instructions:
      - text: Create or update worker pool {pool} in ASE {ase} ({rg}, subscription {sub}) in {location}.
        slots:
          pool: path.workerPoolName
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
          location: requestBody.location
      - text: Scale worker pool {pool} on {ase} to SKU {sku}.
        slots:
          pool: path.workerPoolName
          ase: path.name
          sku: requestBody.sku
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/skus'].get
  update:
    x-apievangelist-phrasing:
      intent: List SKUs for scaling a worker pool in an ASE
      effect: read
      questions:
      - Which SKUs are available for scaling a worker pool in my ASE?
      - What sizes can a particular worker pool move to?
      instructions:
      - text: List available scaling SKUs for worker pool {pool} of ASE {ase} in {rg}, subscription {sub}.
        slots:
          pool: path.workerPoolName
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show SKU options for worker pool {pool} on {ase}.
        slots:
          pool: path.workerPoolName
          ase: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metrics for one worker pool instance
      effect: read
      questions:
      - Can I get metrics for a single machine instance in a worker pool?
      - How is one worker pool instance in my ASE performing?
      instructions:
      - text: Get metrics for instance {instance} of worker pool {pool} on ASE {ase} in {rg}, subscription {sub}.
        slots:
          instance: path.instance
          pool: path.workerPoolName
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Pull metrics for worker instance {instance} in pool {pool} of {ase}, filtered by {filter}.
        slots:
          instance: path.instance
          pool: path.workerPoolName
          ase: path.name
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metricdefinitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List metric definitions for a worker pool instance
      effect: read
      questions:
      - What metrics are defined for an individual worker pool instance?
      - Which metric names can I query for one worker machine in an ASE?
      instructions:
      - text: List metric definitions for instance {instance} of worker pool {pool} on ASE {ase} in {rg}, subscription {sub}.
        slots:
          instance: path.instance
          pool: path.workerPoolName
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show which metrics worker instance {instance} in pool {pool} on {ase} defines.
        slots:
          instance: path.instance
          pool: path.workerPoolName
          ase: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metrics for one multi-role pool instance
      effect: read
      questions:
      - Can I see metrics for a single instance of my ASE's multi-role pool?
      - How is one multi-role machine in an App Service Environment performing?
      instructions:
      - text: Get metrics for instance {instance} of the multi-role pool on ASE {ase} in {rg}, subscription {sub}.
        slots:
          instance: path.instance
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show per-instance multi-role metrics for {instance} on {ase}.
        slots:
          instance: path.instance
          ase: 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 a multi-role pool instance
      effect: read
      questions:
      - What metrics are defined for one instance of an ASE's multi-role pool?
      - Which metric names can I query for a single multi-role machine?
      instructions:
      - text: Describe the metrics that multi-role machine {instance} of ASE {ase} ({rg}, subscription {sub}) can emit.
        slots:
          instance: path.instance
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show which metrics multi-role instance {instance} on {ase} defines.
        slots:
          instance: path.instance
          ase: path.name
      method: generated
      generated: '2026-09-26'
- 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 so it stops running?
      - Can I pause an ASE temporarily instead of deleting it?
      instructions:
      - text: Suspend ASE {ase} in {rg}, subscription {sub}.
        slots:
          ase: path.name
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Put App Service Environment {ase} into a suspended state.
        slots:
          ase: path.name
      method: generated
      generated: '2026-09-26'


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