Microsoft Azure · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Web/serverfarms'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}'].delete
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}'].patch
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/capabilities'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}'].delete
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/listKeys'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/sites'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionPlanLimits/limit'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionRelays'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/restartSites'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/sites'].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 Plans API
  version: 1.0.0
extends: openapi/microsoft-azure-appserviceplans-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: 27
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Web/serverfarms'].get
  update:
    x-apievangelist-phrasing:
      intent: List App Service plans across a subscription
      effect: read
      questions:
      - Which App Service plans exist anywhere in my Azure subscription?
      - Can I get full plan details instead of summaries when listing every plan in the subscription?
      instructions:
      - text: List every App Service plan in my subscription.
      - text: List all App Service plans in the subscription with detailed set to {detailed}.
        slots:
          detailed: query.detailed
      - text: List all App Service plans in subscription {subscriptionId}.
        slots:
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms'].get
  update:
    x-apievangelist-phrasing:
      intent: List App Service plans in a resource group
      effect: read
      questions:
      - What App Service plans are in one particular resource group?
      - Is there a way to see only the hosting plans belonging to a single resource group?
      instructions:
      - text: Show the App Service plans in resource group {resourceGroupName}.
        slots:
          resourceGroupName: path.resourceGroupName
      - text: List hosting plans that live in {resourceGroupName}.
        slots:
          resourceGroupName: path.resourceGroupName
      - text: List App Service plans in resource group {resourceGroupName} of subscription {subscriptionId}.
        slots:
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one App Service plan
      effect: read
      questions:
      - How do I look up the configuration of a single App Service plan by name?
      - What does Azure report about a specific App Service plan's settings?
      instructions:
      - text: Get App Service plan {name} in resource group {resourceGroupName}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
      - text: Fetch the details of the {name} hosting plan.
        slots:
          name: path.name
      - text: Look up plan {name} in {resourceGroupName} under subscription {subscriptionId}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update an App Service plan
      effect: write
      questions:
      - How do I create a new App Service plan in a specific region?
      - Can I change the SKU of an existing App Service plan?
      instructions:
      - text: Create App Service plan {name} under resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Create or overwrite the whole definition of plan {name} in {resourceGroupName}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an App Service plan
      effect: destructive
      questions:
      - How do I remove an App Service plan I no longer need?
      - Can I delete a hosting plan to stop paying for it?
      instructions:
      - text: Delete App Service plan {name} from resource group {resourceGroupName}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
      - text: Tear down the {name} hosting plan.
        slots:
          name: path.name
      - text: Delete hosting plan {name} in {resourceGroupName} from subscription {subscriptionId}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch properties of an existing App Service plan
      effect: write
      questions:
      - Can I change just some properties of an App Service plan that already exists?
      - What is the way to partially update a hosting plan without resending the whole definition?
      instructions:
      - text: Patch existing App Service plan {name} with properties {properties}.
        slots:
          name: path.name
          properties: requestBody.properties
      - text: Partially update hosting plan {name} in {resourceGroupName}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
      - text: Patch plan {name} in {resourceGroupName} under subscription {subscriptionId}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/capabilities'].get
  update:
    x-apievangelist-phrasing:
      intent: List capabilities of an App Service plan
      effect: read
      questions:
      - What features and capabilities does my App Service plan support?
      - Which capabilities are enabled on a particular hosting plan?
      instructions:
      - text: List the capabilities of App Service plan {name}.
        slots:
          name: path.name
      - text: Show what plan {name} in {resourceGroupName} is capable of.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
      - text: Show capabilities for plan {name} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Hybrid Connection used by a plan
      effect: read
      questions:
      - How can I inspect one Hybrid Connection relay that my App Service plan is using?
      - What are the settings of a specific Hybrid Connection in my plan?
      instructions:
      - text: Get Hybrid Connection relay {relayName} in namespace {namespaceName} for plan {name}.
        slots:
          relayName: path.relayName
          namespaceName: path.namespaceName
          name: path.name
      - text: Show details of relay {relayName} used by App Service plan {name}.
        slots:
          relayName: path.relayName
          name: path.name
      - text: Inspect relay {relayName} on plan {name} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          relayName: path.relayName
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a Hybrid Connection from a plan
      effect: destructive
      questions:
      - How do I detach a Hybrid Connection from my App Service plan?
      - Can I delete a relay-based Hybrid Connection that a plan no longer needs?
      instructions:
      - text: Delete Hybrid Connection {relayName} in namespace {namespaceName} from plan {name}.
        slots:
          relayName: path.relayName
          namespaceName: path.namespaceName
          name: path.name
      - text: Remove relay {relayName} from App Service plan {name} in {resourceGroupName}.
        slots:
          relayName: path.relayName
          name: path.name
          resourceGroupName: path.resourceGroupName
      - text: Detach relay {relayName} from plan {name}, subscription {subscriptionId}.
        slots:
          relayName: path.relayName
          name: path.name
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/listKeys'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the send key for a Hybrid Connection
      effect: read
      questions:
      - Where do I find the send key name and value for a Hybrid Connection?
      - Can I retrieve the key a plan uses to send over a Hybrid Connection relay?
      instructions:
      - text: Get the send key for Hybrid Connection {relayName} in namespace {namespaceName} on plan {name}.
        slots:
          relayName: path.relayName
          namespaceName: path.namespaceName
          name: path.name
      - text: Show the send key name and value for relay {relayName}.
        slots:
          relayName: path.relayName
      - text: Fetch the relay {relayName} send key for plan {name} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          relayName: path.relayName
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/sites'].get
  update:
    x-apievangelist-phrasing:
      intent: List apps using a Hybrid Connection
      effect: read
      questions:
      - Which web apps depend on a particular Hybrid Connection in my plan?
      - Before removing a relay, can I see what apps are still using it?
      instructions:
      - text: List the apps that use Hybrid Connection {relayName} in namespace {namespaceName} on plan {name}.
        slots:
          relayName: path.relayName
          namespaceName: path.namespaceName
          name: path.name
      - text: Show which sites rely on relay {relayName}.
        slots:
          relayName: path.relayName
      - text: Find apps on plan {name} in {resourceGroupName} that use relay {relayName}, subscription {subscriptionId}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
          relayName: path.relayName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionPlanLimits/limit'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Hybrid Connection limit for a plan
      effect: read
      questions:
      - What is the maximum number of Hybrid Connections my App Service plan allows?
      - Have I hit the cap on Hybrid Connections for this plan?
      instructions:
      - text: Get the Hybrid Connection limit for App Service plan {name}.
        slots:
          name: path.name
      - text: Check how many Hybrid Connections plan {name} in {resourceGroupName} can have.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
      - text: Get the max Hybrid Connections for plan {name} in subscription {subscriptionId}.
        slots:
          name: path.name
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionRelays'].get
  update:
    x-apievangelist-phrasing:
      intent: List Hybrid Connections in a plan
      effect: read
      questions:
      - What Hybrid Connections are currently in use by my App Service plan?
      - Can I see every relay a hosting plan is connected through?
      instructions:
      - text: List all Hybrid Connections in App Service plan {name}.
        slots:
          name: path.name
      - text: Show every relay plan {name} in {resourceGroupName} uses.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
      - text: List Hybrid Connection relays for plan {name} in subscription {subscriptionId}.
        slots:
          name: path.name
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/restartSites'].post
  update:
    x-apievangelist-phrasing:
      intent: Restart all apps in an App Service plan
      effect: write
      questions:
      - How do I restart every app hosted on one App Service plan at once?
      - Can I do a soft restart of all the sites on a plan instead of a full one?
      instructions:
      - text: Restart all apps in App Service plan {name}.
        slots:
          name: path.name
      - text: Restart every site on plan {name} with soft restart set to {softRestart}.
        slots:
          name: path.name
          softRestart: query.softRestart
      - text: Restart all sites on plan {name} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/sites'].get
  update:
    x-apievangelist-phrasing:
      intent: List apps hosted on an App Service plan
      effect: read
      questions:
      - Which web apps are running on my App Service plan?
      - Can I filter or page through the apps associated with a hosting plan?
      instructions:
      - text: List the apps on App Service plan {name}.
        slots:
          name: path.name
      - text: Show the first {top} apps on plan {name} matching {filter}.
        slots:
          top: query.$top
          name: path.name
          filter: query.$filter
      - text: List web apps on plan {name} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/skus'].get
  update:
    x-apievangelist-phrasing:
      intent: List SKUs selectable for an App Service plan
      effect: read
      questions:
      - What pricing tiers can I move my App Service plan to?
      - Which SKUs are selectable for scaling up an existing plan?
      instructions:
      - text: List the selectable SKUs for App Service plan {name}.
        slots:
          name: path.name
      - text: Show which tiers plan {name} in {resourceGroupName} can be scaled to.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
      - text: List SKUs plan {name} can switch to in subscription {subscriptionId}.
        slots:
          name: path.name
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/usages'].get
  update:
    x-apievangelist-phrasing:
      intent: Get usage information for an App Service plan
      effect: read
      questions:
      - How much of its quota is my App Service plan using?
      - Can I filter server farm usage metrics down to specific ones?
      instructions:
      - text: Get server farm usage for App Service plan {name}.
        slots:
          name: path.name
      - text: Show usage for plan {name} filtered by {filter}.
        slots:
          name: path.name
          filter: query.$filter
      - text: Report usage for plan {name} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections'].get
  update:
    x-apievangelist-phrasing:
      intent: List virtual networks connected to a plan
      effect: read
      questions:
      - Which virtual networks is my App Service plan connected to?
      - What VNet integrations are configured at the hosting plan level?
      instructions:
      - text: List virtual network connections for App Service plan {name}.
        slots:
          name: path.name
      - text: Show all VNets associated with plan {name} in {resourceGroupName}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
      - text: List VNet connections of plan {name} in subscription {subscriptionId}.
        slots:
          name: path.name
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one virtual network connected to a plan
      effect: read
      questions:
      - How do I check the details of a single VNet connection on my App Service plan?
      - What does one specific virtual network integration on a plan look like?
      instructions:
      - text: Get virtual network connection {vnetName} for App Service plan {name}.
        slots:
          vnetName: path.vnetName
          name: path.name
      - text: Show VNet {vnetName} as seen by plan {name}.
        slots:
          vnetName: path.vnetName
          name: path.name
      - text: Get VNet {vnetName} on plan {name} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          vnetName: path.vnetName
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a virtual network gateway for a plan
      effect: read
      questions:
      - What gateway is my App Service plan's VNet connection using?
      - Can I inspect a specific virtual network gateway attached to a plan's VNet?
      instructions:
      - text: Get gateway {gatewayName} on VNet {vnetName} for App Service plan {name}.
        slots:
          gatewayName: path.gatewayName
          vnetName: path.vnetName
          name: path.name
      - text: Show details of VNet gateway {gatewayName}.
        slots:
          gatewayName: path.gatewayName
      - text: Show gateway {gatewayName} on VNet {vnetName}, plan {name} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          gatewayName: path.gatewayName
          vnetName: path.vnetName
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update the VNet gateway of a plan
      effect: write
      questions:
      - How do I change the VNet gateway settings on my App Service plan?
      - Can I update a gateway other than primary on a server farm VNet?
      instructions:
      - text: Update gateway {gatewayName} for VNet {vnetName} on plan {name}, resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          gatewayName: path.gatewayName
          vnetName: path.vnetName
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Reconfigure primary gateway {gatewayName} of {vnetName} on server farm {name}.
        slots:
          gatewayName: path.gatewayName
          vnetName: path.vnetName
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes'].get
  update:
    x-apievangelist-phrasing:
      intent: List routes for a plan's virtual network
      effect: read
      questions:
      - What routes are defined on a VNet connected to my App Service plan?
      - Which address ranges get routed through a plan's virtual network?
      instructions:
      - text: List routes on VNet {vnetName} for App Service plan {name}.
        slots:
          vnetName: path.vnetName
          name: path.name
      - text: Show all virtual network routes for {vnetName}.
        slots:
          vnetName: path.vnetName
      - text: List routes on VNet {vnetName}, plan {name} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          vnetName: path.vnetName
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one virtual network route in a plan
      effect: read
      questions:
      - How do I view one specific route on my plan's virtual network?
      - What address range does a named VNet route cover?
      instructions:
      - text: Get route {routeName} on VNet {vnetName} for App Service plan {name}.
        slots:
          routeName: path.routeName
          vnetName: path.vnetName
          name: path.name
      - text: Show the details of VNet route {routeName}.
        slots:
          routeName: path.routeName
      - text: Show route {routeName} on VNet {vnetName}, plan {name} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          routeName: path.routeName
          vnetName: path.vnetName
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a VNet route on a plan
      effect: write
      questions:
      - How do I add a new route to a virtual network connection in my App Service plan?
      - Can I fully replace a VNet route definition with a PUT?
      instructions:
      - text: Create route {routeName} for VNet {vnetName} on plan {name}, resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          routeName: path.routeName
          vnetName: path.vnetName
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Replace the full VNet route {routeName} on {vnetName} in server farm {name}.
        slots:
          routeName: path.routeName
          vnetName: path.vnetName
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a virtual network route
      effect: destructive
      questions:
      - How do I remove a route from my plan's virtual network?
      - Can I delete a VNet route I added by mistake?
      instructions:
      - text: Delete route {routeName} from VNet {vnetName} on App Service plan {name}.
        slots:
          routeName: path.routeName
          vnetName: path.vnetName
          name: path.name
      - text: Remove VNet route {routeName}.
        slots:
          routeName: path.routeName
      - text: Delete VNet route {routeName} on {vnetName}, plan {name} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          routeName: path.routeName
          vnetName: path.vnetName
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch an existing VNet route on a plan
      effect: write
      questions:
      - Can I patch just some properties of an existing VNet route on my plan?
      - Is there a partial-update option for a server farm VNet route instead of replacing it?
      instructions:
      - text: Patch VNet route {routeName} on {vnetName} in plan {name}, resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          routeName: path.routeName
          vnetName: path.vnetName
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Partially update existing route {routeName} for {vnetName} on server farm {name}, keeping unchanged fields.
        slots:
          routeName: path.routeName
          vnetName: path.vnetName
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/workers/{workerName}/reboot'].post
  update:
    x-apievangelist-phrasing:
      intent: Reboot a worker machine in a plan
      effect: write
      questions:
      - How do I reboot a single worker VM behind my App Service plan?
      - Can I restart one unhealthy worker machine instead of all the apps?
      instructions:
      - text: Reboot worker {workerName} in App Service plan {name}.
        slots:
          workerName: path.workerName
          name: path.name
      - text: Restart worker machine {workerName} in resource group {resourceGroupName}.
        slots:
          workerName: path.workerName
          resourceGroupName: path.resourceGroupName
      - text: Reboot worker {workerName} on plan {name} in subscription {subscriptionId}.
        slots:
          workerName: path.workerName
          name: path.name
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'

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-appserviceplans-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.