# 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 Server Farms API
  version: 1.0.0
extends: openapi/microsoft-azure-serverfarms-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: 19
- 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 do I have in a given resource group?
      - How do I see every App Service plan under one resource group in my subscription?
      instructions:
      - text: List the App Service plans in resource group {resourceGroupName} of subscription {subscriptionId}.
        slots:
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show all server farms in {resourceGroupName}.
        slots:
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one App Service plan
      effect: read
      questions:
      - What SKU and settings does a specific App Service plan have?
      - Can I look up a single App Service plan by its name?
      instructions:
      - text: Get App Service plan {name} in resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show me the configuration of plan {name}.
        slots:
          name: path.name
      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} in {location} under resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          name: path.name
          location: requestBody.location
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Update plan {name} in {resourceGroupName} to use SKU {sku}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
          sku: requestBody.sku
      method: generated
      generated: '2026-09-26'
- 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:
      - Can I remove an App Service plan I no longer use?
      - What do I need to supply to delete a server farm?
      instructions:
      - text: Delete App Service plan {name} from resource group {resourceGroupName} in subscription {subscriptionId}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Tear down server farm {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Query usage metrics for an App Service plan
      effect: read
      questions:
      - What CPU and memory metrics is my App Service plan reporting?
      - Can I break plan metrics down per instance?
      instructions:
      - text: Get metrics for App Service plan {name} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Query plan {name} metrics matching filter {filter}, broken down per instance.
        slots:
          name: path.name
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/metricdefinitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List metric definitions available for a plan
      effect: read
      questions:
      - Which metrics can I actually query for an App Service plan?
      - What metric names and units are defined for my server farm?
      instructions:
      - text: List the queryable metric definitions for plan {name} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show what metrics are available to query on server farm {name}.
        slots:
          name: path.name
      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?
      - Can I see all VNet connections on a server farm at once?
      instructions:
      - text: List VNet connections for App Service plan {name} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show every virtual network attached to plan {name}.
        slots:
          name: path.name
      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 VNet connection of a plan
      effect: read
      questions:
      - What are the details of a specific virtual network connection on my plan?
      - Can I inspect one named VNet linked to an App Service plan?
      instructions:
      - text: Get VNet {vnetName} connected to plan {name} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          vnetName: path.vnetName
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show the connection details for virtual network {vnetName} on server farm {name}.
        slots:
          vnetName: path.vnetName
          name: path.name
      method: generated
      generated: '2026-09-26'
- 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 VNet connection
      effect: read
      questions:
      - Which routes are defined on a VNet connection in my App Service plan?
      - How do I see all routes for one virtual network on a server farm?
      instructions:
      - text: List routes for VNet {vnetName} on plan {name} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          vnetName: path.vnetName
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show all network routes configured for virtual network {vnetName} in plan {name}.
        slots:
          vnetName: path.vnetName
          name: path.name
      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 a single route on a plan's VNet
      effect: read
      questions:
      - What address range does a specific VNet route in my plan cover?
      - Can I look up one named route on a server farm's virtual network?
      instructions:
      - text: Get route {routeName} on VNet {vnetName} of plan {name} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          routeName: path.routeName
          vnetName: path.vnetName
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show the details of VNet route {routeName} for {vnetName} on server farm {name}.
        slots:
          routeName: path.routeName
          vnetName: path.vnetName
          name: path.name
      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} in {location} for VNet {vnetName} on plan {name}, resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          routeName: path.routeName
          location: requestBody.location
          vnetName: path.vnetName
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Replace VNet route {routeName} on {vnetName} in server farm {name} with properties {properties}.
        slots:
          routeName: path.routeName
          vnetName: path.vnetName
          name: path.name
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a route from a plan's VNet
      effect: destructive
      questions:
      - Can I remove a route from a VNet connection on my App Service plan?
      - What identifies the route I want to delete from a server farm VNet?
      instructions:
      - text: Delete route {routeName} from VNet {vnetName} on plan {name} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          routeName: path.routeName
          vnetName: path.vnetName
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Remove VNet route {routeName} from {vnetName} on server farm {name}.
        slots:
          routeName: path.routeName
          vnetName: path.vnetName
          name: path.name
      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}, location {location}.
        slots:
          routeName: path.routeName
          vnetName: path.vnetName
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
          location: requestBody.location
      - text: Partially update existing route {routeName} for {vnetName} on server farm {name} with {properties}.
        slots:
          routeName: path.routeName
          vnetName: path.vnetName
          name: path.name
          properties: requestBody.properties
      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 the VNet gateway of a plan's connection
      effect: read
      questions:
      - What gateway is configured for a virtual network on my App Service plan?
      - Can I read the primary VNet gateway settings for a server farm?
      instructions:
      - text: Get gateway {gatewayName} for VNet {vnetName} on plan {name} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          gatewayName: path.gatewayName
          vnetName: path.vnetName
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show the primary gateway {gatewayName} of virtual network {vnetName} on server farm {name}.
        slots:
          gatewayName: path.gatewayName
          vnetName: path.vnetName
          name: path.name
      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} in {location} for VNet {vnetName} on plan {name}, resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          gatewayName: path.gatewayName
          location: requestBody.location
          vnetName: path.vnetName
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Apply gateway properties {properties} to primary gateway {gatewayName} of {vnetName} on server farm {name}.
        slots:
          properties: requestBody.properties
          gatewayName: path.gatewayName
          vnetName: path.vnetName
          name: path.name
      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 web apps hosted on an App Service plan
      effect: read
      questions:
      - Which web apps are running on a particular App Service plan?
      - Can I list only the apps on a plan that are currently running?
      instructions:
      - text: List the apps hosted on plan {name} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show {top} web apps per page on server farm {name}, filtered by {filter}.
        slots:
          top: query.$top
          name: path.name
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- 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 server farm
      effect: write
      questions:
      - Can I reboot a single worker machine behind my App Service plan?
      - What worker name do I pass to restart one server farm instance?
      instructions:
      - text: Reboot worker {workerName} in server farm {name}, resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          workerName: path.workerName
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Submit a reboot request for worker machine {workerName} on {name}.
        slots:
          workerName: path.workerName
          name: path.name
      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 web apps on an App Service plan
      effect: write
      questions:
      - How do I restart every app on an App Service plan in one go?
      - Can I do a soft restart that only reapplies configuration when needed?
      instructions:
      - text: Restart all web apps on plan {name} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Soft-restart the apps on server farm {name} with softRestart set to {softRestart}.
        slots:
          name: path.name
          softRestart: query.softRestart
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/operationresults/{operationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the result of a server farm operation
      effect: read
      questions:
      - Has my long-running server farm operation finished yet?
      - What is the status of a specific operation on my App Service plan?
      instructions:
      - text: Get the result of operation {operationId} on server farm {name} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          operationId: path.operationId
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Check whether operation {operationId} on plan {name} completed.
        slots:
          operationId: path.operationId
          name: path.name
      method: generated
      generated: '2026-09-26'