# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for WebApps API Client App Service Plans API
  version: 1.0.0
extends: openapi/microsoft-azure-functions-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: 30
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Web/serverfarms'].get
  update:
    x-apievangelist-phrasing:
      intent: List App Service plans across a subscription
      effect: read
      questions:
      - What App Service plans exist across my whole Azure subscription?
      - Can I get every property of each plan in the subscription, not just a summary?
      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
      method: generated
      generated: '2026-10-01'
- 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:
      - Which App Service plans live in one particular resource group?
      - How do I see the hosting plans scoped to a single resource group?
      instructions:
      - text: Show the App Service plans in this resource group.
      - text: List only the resource group's App Service plans, not the whole subscription's.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an App Service plan
      effect: read
      questions:
      - How do I look up the details of one App Service plan by name?
      - What SKU and status does a specific App Service plan have?
      instructions:
      - text: Get the App Service plan named {name}.
        slots:
          name: path.name
      - text: Show me the configuration of plan {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace an App Service plan
      effect: write
      questions:
      - How do I create a new App Service plan with a chosen SKU?
      - Can I provision a hosting plan with a managed identity attached?
      instructions:
      - text: Create an App Service plan called {name} on SKU {sku}.
        slots:
          name: path.name
          sku: requestBody.sku
      - text: Provision plan {name} of kind {kind}, replacing it if it already exists.
        slots:
          name: path.name
          kind: requestBody.kind
      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 tear down a hosting plan to stop paying for it?
      instructions:
      - text: Delete the App Service plan {name}.
        slots:
          name: path.name
      - text: Remove hosting plan {name} from the resource group.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- 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 a few settings on an existing App Service plan without resending everything?
      - How do I partially update a plan that is already running?
      instructions:
      - text: Patch the existing plan {name} with properties {properties}.
        slots:
          name: path.name
          properties: requestBody.properties
      - text: Partially update App Service plan {name}, changing its kind to {kind}.
        slots:
          name: path.name
          kind: requestBody.kind
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/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 given plan?
      instructions:
      - text: List the capabilities of App Service plan {name}.
        slots:
          name: path.name
      - text: Show what plan {name} is capable of.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/getrdppassword'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the RDP password for a custom-mode plan
      effect: read
      questions:
      - How do I get the remote desktop password for a custom-mode server farm?
      - Where can I retrieve RDP credentials for an IsCustomMode App Service plan?
      instructions:
      - text: Fetch the RDP password for custom-mode plan {name}.
        slots:
          name: path.name
      - text: Get remote desktop credentials for server farm {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- 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 do I inspect one Hybrid Connection relay that my App Service plan uses?
      - What are the settings of a specific Hybrid Connection on a plan?
      instructions:
      - text: Get Hybrid Connection relay {relayName} in namespace {namespaceName} on plan {name}.
        slots:
          relayName: path.relayName
          namespaceName: path.namespaceName
          name: path.name
      - text: Show the details of relay {relayName} used by plan {name}.
        slots:
          relayName: path.relayName
          name: path.name
      method: generated
      generated: '2026-10-01'
- 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 delete a Hybrid Connection that an App Service plan is using?
      - Can I detach a relay from my plan?
      instructions:
      - text: Delete Hybrid Connection relay {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}.
        slots:
          relayName: path.relayName
          name: path.name
      method: generated
      generated: '2026-10-01'
- 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?
      - How can I retrieve the access key a Hybrid Connection relay uses?
      instructions:
      - text: Get the send key for relay {relayName} in namespace {namespaceName} on plan {name}.
        slots:
          relayName: path.relayName
          namespaceName: path.namespaceName
          name: path.name
      - text: Show the Hybrid Connection keys for relay {relayName}.
        slots:
          relayName: path.relayName
      method: generated
      generated: '2026-10-01'
- 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 apps in my plan depend on a particular Hybrid Connection?
      - Can I find every site that uses a given relay before I remove it?
      instructions:
      - text: List the apps that use relay {relayName} in namespace {namespaceName} on plan {name}.
        slots:
          relayName: path.relayName
          namespaceName: path.namespaceName
          name: path.name
      - text: Find which web apps depend on Hybrid Connection {relayName}.
        slots:
          relayName: path.relayName
      method: generated
      generated: '2026-10-01'
- 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:
      - How many Hybrid Connections is my App Service plan allowed to have?
      - What is the maximum Hybrid Connection count for a plan's tier?
      instructions:
      - text: Get the maximum number of Hybrid Connections allowed on plan {name}.
        slots:
          name: path.name
      - text: Check the Hybrid Connection limit for App Service plan {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionRelays'].get
  update:
    x-apievangelist-phrasing:
      intent: List Hybrid Connections in use by a plan
      effect: read
      questions:
      - What Hybrid Connections are currently in use across an App Service plan?
      - Can I see all relays a plan is connected to?
      instructions:
      - text: List all Hybrid Connections in use by plan {name}.
        slots:
          name: path.name
      - text: Show every relay connected to App Service plan {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/listinstances'].post
  update:
    x-apievangelist-phrasing:
      intent: Get instance details for an App Service plan
      effect: read
      questions:
      - How do I see the individual instances running under an App Service plan?
      - Which worker instances back my plan right now?
      instructions:
      - text: List the instance details for plan {name}.
        slots:
          name: path.name
      - text: Show the worker instances running App Service plan {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- 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 on an App Service plan at once?
      - Can I do a soft restart of all sites in 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
      method: generated
      generated: '2026-10-01'
- 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 hosted on a given App Service plan?
      - Can I page through or filter the apps assigned to a plan?
      instructions:
      - text: List the apps hosted on plan {name}.
        slots:
          name: path.name
      - text: Show the first {top} apps on App Service plan {name}.
        slots:
          top: query.$top
          name: path.name
      - text: List apps on plan {name} matching filter {filter}.
        slots:
          name: path.name
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/skus'].get
  update:
    x-apievangelist-phrasing:
      intent: List selectable SKUs for an App Service plan
      effect: read
      questions:
      - Which pricing tiers can I scale my existing App Service plan to?
      - What SKUs are selectable for a particular plan?
      instructions:
      - text: List the SKUs I can switch plan {name} to.
        slots:
          name: path.name
      - text: Show selectable pricing tiers for App Service plan {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- 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 to specific names?
      instructions:
      - text: Get usage figures for server farm {name}.
        slots:
          name: path.name
      - text: Show plan {name} usage filtered by {filter}.
        slots:
          name: path.name
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/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?
      - How do I list VNet integrations at the plan level?
      instructions:
      - text: List all virtual network connections on plan {name}.
        slots:
          name: path.name
      - text: Show the VNets associated with App Service plan {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a virtual network connected to a plan
      effect: read
      questions:
      - How do I look at one specific VNet connection on an App Service plan?
      - What does a plan's connection to a named virtual network look like?
      instructions:
      - text: Get virtual network {vnetName} connected to plan {name}.
        slots:
          vnetName: path.vnetName
          name: path.name
      - text: Show the VNet connection {vnetName} on App Service plan {name}.
        slots:
          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}/gateways/{gatewayName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a virtual network gateway for a plan
      effect: read
      questions:
      - How do I view the gateway used by a plan's virtual network connection?
      - What is configured on the VNet gateway behind my App Service plan?
      instructions:
      - text: Get gateway {gatewayName} for VNet {vnetName} on plan {name}.
        slots:
          gatewayName: path.gatewayName
          vnetName: path.vnetName
          name: path.name
      - text: Show the virtual network gateway {gatewayName} settings.
        slots:
          gatewayName: path.gatewayName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a virtual network gateway for a plan
      effect: write
      questions:
      - Can I change the gateway configuration for a plan's VNet connection?
      - How do I update the VNet gateway an App Service plan uses?
      instructions:
      - text: Update gateway {gatewayName} on VNet {vnetName} of plan {name} with {properties}.
        slots:
          gatewayName: path.gatewayName
          vnetName: path.vnetName
          name: path.name
          properties: requestBody.properties
      - text: Reconfigure the VNet gateway {gatewayName} for plan {name}.
        slots:
          gatewayName: path.gatewayName
          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 for a virtual network on my App Service plan?
      - How can I see all VNet routes on a plan?
      instructions:
      - text: List routes for VNet {vnetName} on plan {name}.
        slots:
          vnetName: path.vnetName
          name: path.name
      - text: Show every route associated with virtual network {vnetName}.
        slots:
          vnetName: path.vnetName
      method: generated
      generated: '2026-10-01'
- 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 on a plan
      effect: read
      questions:
      - How do I check the address range of one named VNet route on a plan?
      - Can I fetch a single route by name for a plan's virtual network?
      instructions:
      - text: Get route {routeName} for VNet {vnetName} on plan {name}.
        slots:
          routeName: path.routeName
          vnetName: path.vnetName
          name: path.name
      - text: Show the definition of VNet route {routeName}.
        slots:
          routeName: path.routeName
      method: generated
      generated: '2026-10-01'
- 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 virtual network route
      effect: write
      questions:
      - How do I add a new route to a plan's virtual network?
      - Can I define a VNet route on an App Service plan from scratch?
      instructions:
      - text: Create route {routeName} on VNet {vnetName} of plan {name} with {properties}.
        slots:
          routeName: path.routeName
          vnetName: path.vnetName
          name: path.name
          properties: requestBody.properties
      - text: Add a new VNet route named {routeName} to plan {name}.
        slots:
          routeName: path.routeName
          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 from a plan
      effect: destructive
      questions:
      - How do I remove a route from a plan's virtual network?
      - Can I delete a VNet route I added to my App Service plan?
      instructions:
      - text: Delete route {routeName} from VNet {vnetName} on plan {name}.
        slots:
          routeName: path.routeName
          vnetName: path.vnetName
          name: path.name
      - text: Remove VNet route {routeName}.
        slots:
          routeName: path.routeName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch an existing virtual network route
      effect: write
      questions:
      - Can I patch an existing VNet route without recreating it?
      - What is the way to modify a route that already exists on a plan's virtual network?
      instructions:
      - text: Patch existing route {routeName} on VNet {vnetName} of plan {name} with {properties}.
        slots:
          routeName: path.routeName
          vnetName: path.vnetName
          name: path.name
          properties: requestBody.properties
      - text: Modify the existing VNet route {routeName} in place.
        slots:
          routeName: path.routeName
      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 machine in an App Service plan?
      - Can I restart one unhealthy worker instead of all apps?
      instructions:
      - text: Reboot worker {workerName} in plan {name}.
        slots:
          workerName: path.workerName
          name: path.name
      - text: Power-cycle worker machine {workerName}.
        slots:
          workerName: path.workerName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/serverfarms/{name}/workers/{workerName}/recycleinstance'].post
  update:
    x-apievangelist-phrasing:
      intent: Recycle a managed instance worker
      effect: write
      questions:
      - How do I recycle a managed instance worker machine on my plan?
      - Can a managed-instance worker be recycled rather than rebooted?
      instructions:
      - text: Recycle managed instance worker {workerName} on plan {name}.
        slots:
          workerName: path.workerName
          name: path.name
      - text: Recycle the managed worker {workerName}.
        slots:
          workerName: path.workerName
      method: generated
      generated: '2026-10-01'