Microsoft Azure AppServicePlans API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector AppServicePlans API
schemes:
- https
tags:
- name: AppServicePlans
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Web/serverfarms:
    get:
      tags:
      - AppServicePlans
      summary: Microsoft Azure Get All App Service Plans For A Subscription
      description: Description for Get all App Service plans for a subscription.
      operationId: microsoftAzureAppserviceplansList
      parameters:
      - name: detailed
        in: query
        description: "Specify <code>true</code> to return all App Service plan properties. The default is <code>false</code>, which returns a subset of the properties.\n Retrieval of all properties may increase the API latency."
        type: boolean
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: ./CommonDefinitions.json#/definitions/AppServicePlanCollection
        default:
          description: App Service error response.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse
      x-ms-examples:
        List App Service plans:
          $ref: ./examples/ListAppServicePlans.json
      x-ms-pageable:
        nextLinkName: nextLink
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms:
    get:
      tags:
      - AppServicePlans
      summary: Microsoft Azure Get All App Service Plans In A Resource Group
      description: Description for Get all App Service plans in a resource group.
      operationId: microsoftAzureAppserviceplansListbyresourcegroup
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: ./CommonDefinitions.json#/definitions/AppServicePlanCollection
        default:
          description: App Service error response.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse
      x-ms-examples:
        List App Service plans by resource group:
          $ref: ./examples/ListAppServicePlansByResourceGroup.json
      x-ms-pageable:
        nextLinkName: nextLink
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}:
    get:
      tags:
      - AppServicePlans
      summary: Microsoft Azure Get An App Service Plan
      description: Description for Get an App Service plan.
      operationId: microsoftAzureAppserviceplansGet
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/AppServicePlan
        '404':
          description: Not found.
          x-ms-error-response: true
        default:
          description: App Service error response.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse
      x-ms-examples:
        Get App Service plan:
          $ref: ./examples/GetAppServicePlan.json
    put:
      tags:
      - AppServicePlans
      summary: Microsoft Azure Creates Or Updates An App Service Plan
      description: Description for Creates or updates an App Service Plan.
      operationId: microsoftAzureAppserviceplansCreateorupdate
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      - name: appServicePlan
        in: body
        description: Details of the App Service plan.
        required: true
        schema:
          $ref: ./CommonDefinitions.json#/definitions/AppServicePlan
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/AppServicePlan
        '202':
          description: Operation is in progress.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/AppServicePlan
        default:
          description: App Service error response.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse
      x-ms-examples:
        Create Or Update App Service plan:
          $ref: ./examples/CreateOrUpdateAppServicePlan.json
      x-ms-long-running-operation: true
    delete:
      tags:
      - AppServicePlans
      summary: Microsoft Azure Delete An App Service Plan
      description: Description for Delete an App Service plan.
      operationId: microsoftAzureAppserviceplansDelete
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK.
        '204':
          description: OK.
        default:
          description: App Service error response.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse
      x-ms-examples:
        Delete App Service plan:
          $ref: ./examples/DeleteAppServicePlan.json
    patch:
      tags:
      - AppServicePlans
      summary: Microsoft Azure Creates Or Updates An App Service Plan
      description: Description for Creates or updates an App Service Plan.
      operationId: microsoftAzureAppserviceplansUpdate
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      - name: appServicePlan
        in: body
        description: Details of the App Service plan.
        required: true
        schema:
          $ref: '#/definitions/AppServicePlanPatchResource'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/AppServicePlan
        '202':
          description: Operation is in progress.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/AppServicePlan
        default:
          description: App Service error response.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse
      x-ms-examples:
        Patch Service plan:
          $ref: ./examples/PatchAppServicePlan.json
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/capabilities:
    get:
      tags:
      - AppServicePlans
      summary: Microsoft Azure List All Capabilities Of An App Service Plan
      description: Description for List all capabilities of an App Service plan.
      operationId: microsoftAzureAppserviceplansListcapabilities
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: ./CommonDefinitions.json#/definitions/Capability
        default:
          description: App Service error response.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
  : get:
      tags:
      - AppServicePlans
      summary: Microsoft Azure Retrieve A Hybrid Connection In Use In An App Service Plan
      description: Description for Retrieve a Hybrid Connection in use in an App Service plan.
      operationId: microsoftAzureAppserviceplansGethybridconnection
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      - name: namespaceName
        in: path
        description: Name of the Service Bus namespace.
        required: true
        type: string
      - name: relayName
        in: path
        description: Name of the Service Bus relay.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: ./CommonDefinitions.json#/definitions/HybridConnection
        default:
          description: App Service error response.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse
    delete:
      tags:
      - AppServicePlans
      summary: Microsoft Azure Delete A Hybrid Connection In Use In An App Service Plan
      description: Description for Delete a Hybrid Connection in use in an App Service plan.
      operationId: microsoftAzureAppserviceplansDeletehybridconnection
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      - name: namespaceName
        in: path
        description: Name of the Service Bus namespace.
        required: true
        type: string
      - name: relayName
        in: path
        description: Name of the Service Bus relay.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully deleted hybrid connection
        '204':
          description: Hybrid connection does not exist
        default:
          description: App Service error response.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/listKeys
  : post:
      tags:
      - AppServicePlans
      summary: Microsoft Azure Get The Send Key Name And Value Of A Hybrid Connection
      description: Description for Get the send key name and value of a Hybrid Connection.
      operationId: microsoftAzureAppserviceplansListhybridconnectionkeys
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      - name: namespaceName
        in: path
        description: The name of the Service Bus namespace.
        required: true
        type: string
      - name: relayName
        in: path
        description: The name of the Service Bus relay.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/HybridConnectionKey'
        default:
          description: App Service error response.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/sites
  : get:
      tags:
      - AppServicePlans
      summary: Microsoft Azure Get All Apps That Use A Hybrid Connection In An App Service Plan
      description: Description for Get all apps that use a Hybrid Connection in an App Service Plan.
      operationId: microsoftAzureAppserviceplansListwebappsbyhybridconnection
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      - name: namespaceName
        in: path
        description: Name of the Hybrid Connection namespace.
        required: true
        type: string
      - name: relayName
        in: path
        description: Name of the Hybrid Connection relay.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ResourceCollection'
        default:
          description: App Service error response.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionPlanLimits/limit
  : get:
      tags:
      - AppServicePlans
      summary: Microsoft Azure Get The Maximum Number Of Hybrid Connections Allowed In An App Service Plan
      description: Description for Get the maximum number of Hybrid Connections allowed in an App Service plan.
      operationId: microsoftAzureAppserviceplansGethybridconnectionplanlimit
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/HybridConnectionLimits'
        default:
          description: App Service error response.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionRelays
  : get:
      tags:
      - AppServicePlans
      summary: Microsoft Azure Retrieve All Hybrid Connections In Use In An App Service Plan
      description: Description for Retrieve all Hybrid Connections in use in an App Service plan.
      operationId: microsoftAzureAppserviceplansListhybridconnections
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/HybridConnectionCollection'
        default:
          description: App Service error response.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/restartSites:
    post:
      tags:
      - AppServicePlans
      summary: Microsoft Azure Restart All Apps In An App Service Plan
      description: Description for Restart all apps in an App Service plan.
      operationId: microsoftAzureAppserviceplansRestartwebapps
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      - name: softRestart
        in: query
        description: Specify <code>true</code> to perform a soft restart, applies the configuration settings and restarts the apps if necessary. The default is <code>false</code>, which always restarts and reprovisions the apps
        type: boolean
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '204':
          description: No Content
        default:
          description: App Service error response.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/sites:
    get:
      tags:
      - AppServicePlans
      summary: Microsoft Azure Get All Apps Associated With An App Service Plan
      description: Description for Get all apps associated with an App Service plan.
      operationId: microsoftAzureAppserviceplansListwebapps
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      - name: $skipToken
        in: query
        description: Skip to a web app in the list of webapps associated with app service plan. If specified, the resulting list will contain web apps starting from (including) the skipToken. Otherwise, the resulting list contains web apps from the start of the list
        type: string
      - name: $filter
        in: query
        description: 'Supported filter: $filter=state eq running. Returns only web apps that are currently running'
        type: string
        x-ms-skip-url-encoding: true
      - name: $top
        in: query
        description: List page size. If specified, results are paged.
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: ./CommonDefinitions.json#/definitions/WebAppCollection
        default:
          description: App Service error response.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/skus:
    get:
      tags:
      - AppServicePlans
      summary: Microsoft Azure Gets All Selectable Skus For A Given App Service Plan
      description: Description for Gets all selectable SKUs for a given App Service Plan
      operationId: microsoftAzureAppserviceplansGetserverfarmskus
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: name
        in: path
        description: Name of App Service Plan
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            type: object
        default:
          description: App Service error response.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/usages:
    get:
      tags:
      - AppServicePlans
      summary: Microsoft Azure Gets Server Farm Usage Information
      description: Description for Gets server farm usage information
      operationId: microsoftAzureAppserviceplansListusages
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: name
        in: path
        description: Name of App Service Plan
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      - name: $filter
        in: query
        description: 'Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq ''Metric1'' or name.value eq ''Metric2'').'
        type: string
        x-ms-skip-url-encoding: true
      responses:
        '200':
          description: OK
          schema:
            $ref: ./CommonDefinitions.json#/definitions/CsmUsageQuotaCollection
        default:
          description: App Service error response.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections
  : get:
      tags:
      - AppServicePlans
      summary: Microsoft Azure Get All Virtual Networks Associated With An App Service Plan
      description: Description for Get all Virtual Networks associated with an App Service plan.
      operationId: microsoftAzureAppserviceplansListvnets
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: ./CommonDefinitions.json#/definitions/VnetInfoResource
        default:
          description: App Service error response.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}
  : get:
      tags:
      - AppServicePlans
      summary: Microsoft Azure Get A Virtual Network Associated With An App Service Plan
      description: Description for Get a Virtual Network associated with an App Service plan.
      operationId: microsoftAzureAppserviceplansGetvnetfromserverfarm
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      - name: vnetName
        in: path
        description: Name of the Virtual Network.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/VnetInfoResource
        '404':
          description: Virtual network could not be found.
          x-ms-error-response: true
        default:
          description: App Service error response.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
  : get:
      tags:
      - AppServicePlans
      summary: Microsoft Azure Get A Virtual Network Gateway
      description: Description for Get a Virtual Network gateway.
      operationId: microsoftAzureAppserviceplansGetvnetgateway
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      - name: vnetName
        in: path
        description: Name of the Virtual Network.
        required: true
        type: string
      - name: gatewayName
        in: path
        description: Name of the gateway. Only the 'primary' gateway is supported.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: ./CommonDefinitions.json#/definitions/VnetGateway
        default:
          description: App Service error response.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse
    put:
      tags:
      - AppServicePlans
      summary: Microsoft Azure Update A Virtual Network Gateway
      description: Description for Update a Virtual Network gateway.
      operationId: microsoftAzureAppserviceplansUpdatevnetgateway
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      - name: vnetName
        in: path
        description: Name of the Virtual Network.
        required: true
        type: string
      - name: gatewayName
        in: path
        description: Name of the gateway. Only the 'primary' gateway is supported.
        required: true
        type: string
      - name: connectionEnvelope
        in: body
        description: Definition of the gateway.
        required: true
        schema:
          $ref: ./CommonDefinitions.json#/definitions/VnetGateway
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: ./CommonDefinitions.json#/definitions/VnetGateway
        default:
          description: App Service error response.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes
  : get:
      tags:
      - AppServicePlans
      summary: Microsoft Azure Get All Routes That Are Associated With A Virtual Network In An App Service Plan
      description: Description for Get all routes that are associated with a Virtual Network in an App Service plan.
      operationId: microsoftAzureAppserviceplansListroutesforvnet
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      - name: vnetName
        in: path
        description: Name of the Virtual Network.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: ./CommonDefinitions.json#/definitions/VnetRoute
        default:
          description: App Service error response.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}
  : get:
      tags:
      - AppServicePlans
      summary: Microsoft Azure Get A Virtual Network Route In An App Service Plan
      description: Description for Get a Virtual Network route in an App Service plan.
      operationId: microsoftAzureAppserviceplansGetrouteforvnet
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      - name: vnetName
        in: path
        description: Name of the Virtual Network.
        required: true
        type: string
      - name: routeName
        in: path
        description: Name of the Virtual Network route.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK.
          schema:
            type: array
            items:
              $ref: ./CommonDefinitions.json#/definitions/VnetRoute
        '404':
          description: Specified route does not exist.
          x-ms-error-response: true
        default:
          description: App Service error response.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse
    put:
      tags:
      - AppServicePlans
      summary: Microsoft Azure Create Or Update A Virtual Network Route In An App Service Plan
      description: Description for Create or update a Virtual Network route in an App Service plan.
      operationId: microsoftAzureAppserviceplansCreateorupdatevnetroute
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      - name: vnetName
        in: path
        description: Name of the Virtual Network.
        required: true
        type: string
      - name: routeName
        in: path
        description: Name of the Virtual Network route.
        required: true
        type: string
      - name: route
        in: body
        description: Definition of the Virtual Network route.
        required: true
        schema:
          $ref: ./CommonDefinitions.json#/definitions/VnetRoute
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/VnetRoute
        '400':
          description: Invalid request. Ensure that required parameters are given, and that addresses and address spaces are valid.
          x-ms-error-response: true
        '404':
          description: Route not found.
          x-ms-error-response: true
        default:
          description: App Service error response.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse
    delete:
      tags:
      - AppServicePlans
      summary: Microsoft Azure Delete A Virtual Network Route In An App Service Plan
      description: Description for Delete a Virtual Network route in an App Service plan.
      operationId: microsoftAzureAppserviceplansDeletevnetroute
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      - name: vnetName
        in: path
        description: Name of the Virtual Network.
        required: true
        type: string
      - name: routeName
        in: path
        description: Name of the Virtual Network route.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully deleted Virtual Network route.
        '404':
          description: Specified Virtual Network route does not exist.
          x-ms-error-response: true
        default:
          description: App Service error response.
          schema:
            $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse
    patch:
      tags:
      - AppServicePlans
      summary: Microsoft Azure Create Or Update A Virtual Network Route In An App Service Plan
      description: Description for Create or update a Virtual Network route in an App Service plan.
      operationId: microsoftAzureAppserviceplansUpdatevnetroute
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      - name: vnetName
        in: path
        description: Name of the Virtual Network.
        required: true
        type: string
      - name: routeName
        in: path
        description: Name of the Virtual Network route.
        required: true
        type: string
      - name: route
        in: body
        description: Definition of the Virtual

# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-appserviceplans-api-openapi.yml