Microsoft Azure Functions AppServicePlans API

swagger: '2.0'
info:
  title: WebApps API Client AppServiceEnvironments AppServicePlans API
  version: '2025-05-01'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
host: management.azure.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- azure_auth:
  - user_impersonation
tags:
- name: AppServicePlans
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Web/serverfarms:
    get:
      operationId: AppServicePlans_List
      tags:
      - AppServicePlans
      summary: Get all App Service plans for a subscription.
      description: Description for Get all App Service plans for a subscription.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - 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.

          Retrieval of all properties may increase the API latency.'
        required: false
        type: boolean
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/AppServicePlanCollection'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/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:
      operationId: AppServicePlans_ListByResourceGroup
      tags:
      - AppServicePlans
      summary: Get all App Service plans in a resource group.
      description: Description for Get all App Service plans in a resource group.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/AppServicePlanCollection'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/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:
      operationId: AppServicePlans_Get
      tags:
      - AppServicePlans
      summary: Get an App Service plan.
      description: Description for Get an App Service plan.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/AppServicePlan'
        '404':
          description: The server cannot find the requested resource.
          x-ms-error-response: true
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
      x-ms-examples:
        Get App Service plan:
          $ref: ./examples/GetAppServicePlan.json
    put:
      operationId: AppServicePlans_CreateOrUpdate
      tags:
      - AppServicePlans
      summary: Creates or updates an App Service Plan.
      description: Description for Creates or updates an App Service Plan.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/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/AppServicePlan'
      responses:
        '200':
          description: Resource 'AppServicePlan' update operation succeeded
          schema:
            $ref: '#/definitions/AppServicePlan'
        '202':
          description: The request has been accepted for processing, but processing has not yet completed.
          schema:
            $ref: '#/definitions/AppServicePlan'
          headers:
            Location:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
      x-ms-examples:
        Create Or Update App Service plan:
          $ref: ./examples/CreateOrUpdateAppServicePlan.json
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/AppServicePlan'
      x-ms-long-running-operation: true
    patch:
      operationId: AppServicePlans_Update
      tags:
      - AppServicePlans
      summary: Creates or updates an App Service Plan.
      description: Description for Creates or updates an App Service Plan.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/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'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/AppServicePlan'
        '202':
          description: The request has been accepted for processing, but processing has not yet completed.
          schema:
            $ref: '#/definitions/AppServicePlan'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
      x-ms-examples:
        Patch Service plan:
          $ref: ./examples/PatchAppServicePlan.json
    delete:
      operationId: AppServicePlans_Delete
      tags:
      - AppServicePlans
      summary: Delete an App Service plan.
      description: Description for Delete an App Service plan.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      responses:
        '200':
          description: Resource deleted successfully.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
      x-ms-examples:
        Delete App Service plan:
          $ref: ./examples/DeleteAppServicePlan.json
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/capabilities:
    get:
      operationId: AppServicePlans_ListCapabilities
      tags:
      - AppServicePlans
      summary: List all capabilities of an App Service plan.
      description: Description for List all capabilities of an App Service plan.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            type: array
            items:
              $ref: '#/definitions/Capability'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/getrdppassword
  : post:
      operationId: AppServicePlans_GetServerFarmRdpPassword
      tags:
      - AppServicePlans
      summary: Get the RDP password for an IsCustomMode ServerFarm.
      description: Description for Get the RDP password for an IsCustomMode ServerFarm.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/ServerFarmRdpDetails'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
  : get:
      operationId: AppServicePlans_GetHybridConnection
      tags:
      - AppServicePlans
      summary: 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.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/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
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/HybridConnection'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
    delete:
      operationId: AppServicePlans_DeleteHybridConnection
      tags:
      - AppServicePlans
      summary: 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.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/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
      responses:
        '200':
          description: Resource deleted successfully.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/listKeys
  : post:
      operationId: AppServicePlans_ListHybridConnectionKeys
      tags:
      - AppServicePlans
      summary: 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.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/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
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/HybridConnectionKey'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/sites
  : get:
      operationId: AppServicePlans_ListWebAppsByHybridConnection
      tags:
      - AppServicePlans
      summary: 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.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/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
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/ResourceCollection'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionPlanLimits/limit
  : get:
      operationId: AppServicePlans_GetHybridConnectionPlanLimit
      tags:
      - AppServicePlans
      summary: 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.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/HybridConnectionLimits'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionRelays
  : get:
      operationId: AppServicePlans_ListHybridConnections
      tags:
      - AppServicePlans
      summary: 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.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/HybridConnectionCollection'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/listinstances
  : post:
      operationId: AppServicePlans_GetServerFarmInstanceDetails
      tags:
      - AppServicePlans
      summary: Get the instance details for an app service plan.
      description: Description for Get the instance details for an app service plan.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/ServerFarmInstanceDetails'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/restartSites:
    post:
      operationId: AppServicePlans_RestartWebApps
      tags:
      - AppServicePlans
      summary: Restart all apps in an App Service plan.
      description: Description for Restart all apps in an App Service plan.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/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
        required: false
        type: boolean
      responses:
        '204':
          description: There is no content to send for this request, but the headers may be useful.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/sites:
    get:
      operationId: AppServicePlans_ListWebApps
      tags:
      - AppServicePlans
      summary: Get all apps associated with an App Service plan.
      description: Description for Get all apps associated with an App Service plan.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      - 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
        required: false
        type: string
      - name: $filter
        in: query
        description: 'Supported filter: $filter=state eq running. Returns only web apps that are currently running'
        required: false
        type: string
      - name: $top
        in: query
        description: List page size. If specified, results are paged.
        required: false
        type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/WebAppCollection'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/skus:
    get:
      operationId: AppServicePlans_GetServerFarmSkus
      tags:
      - AppServicePlans
      summary: Gets all selectable SKUs for a given App Service Plan
      description: Description for Gets all selectable SKUs for a given App Service Plan
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          schema: {}
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/usages:
    get:
      operationId: AppServicePlans_ListUsages
      tags:
      - AppServicePlans
      summary: Gets server farm usage information
      description: Description for Gets server farm usage information
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      - 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'').'
        required: false
        type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/CsmUsageQuotaCollection'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections
  : get:
      operationId: AppServicePlans_ListVnets
      tags:
      - AppServicePlans
      summary: Get all Virtual Networks associated with an App Service plan.
      description: Description for Get all Virtual Networks associated with an App Service plan.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: name
        in: path
        description: Name of the App Service plan.
        required: true
        type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            type: array
            items:
              $ref: '#/definitions/VnetInfoResource'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}
  : get:
      operationId: AppServicePlans_GetVnetFromServerFarm
      tags:
      - AppServicePlans
      summary: Get a Virtual Network associated with an App Service plan.
      description: Description for Get a Virtual Network associated with an App Service plan.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/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
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/VnetInfoResource'
        '404':
          description: The server cannot find the requested resource.
          x-ms-error-response: true
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
  : get:
      operationId: AppServicePlans_GetVnetGateway
      tags:
      - AppServicePlans
      summary: Get a Virtual Network gateway.
      description: Description for Get a Virtual Network gateway.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/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
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/VnetGateway'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
    put:
      operationId: AppServicePlans_UpdateVnetGateway
      tags:
      - AppServicePlans
      summary: Update a Virtual Network gateway.
      description: Description for Update a Virtual Network gateway.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/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: '#/definitions/VnetGateway'
      responses:
        '200':
          description: Resource 'VnetGateway' update operation succeeded
          schema:
            $ref: '#/definitions/VnetGateway'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes
  : get:
      operationId: AppServicePlans_ListRoutes

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