Microsoft Azure Functions Subscriptions API

The Subscriptions API from Microsoft Azure Functions — 15 operation(s) for subscriptions.

OpenAPI Specification

microsoft-azure-functions-subscriptions-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  title: WebApps API Client AppServiceEnvironments Subscriptions 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: Subscriptions
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Web/aseRegions:
    get:
      operationId: ListAseRegions
      summary: Get a list of available ASE regions and its supported Skus.
      description: Description for get a list of available ASE regions and its supported Skus.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/AseRegionCollection'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
      x-ms-examples:
        List aseregions:
          $ref: ./examples/ListAseRegions.json
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Subscriptions
  /subscriptions/{subscriptionId}/providers/Microsoft.Web/billingMeters:
    get:
      operationId: ListBillingMeters
      summary: Gets a list of meters for a given location.
      description: Description for Gets a list of meters for a given location.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - name: billingLocation
        in: query
        description: Azure Location of billable resource
        required: false
        type: string
      - name: osType
        in: query
        description: App Service OS type meters used for
        required: false
        type: string
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/BillingMeterCollection'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Subscriptions
  /subscriptions/{subscriptionId}/providers/Microsoft.Web/checknameavailability:
    post:
      operationId: CheckNameAvailability
      summary: Check if a resource name is available.
      description: Description for Check if a resource name is available.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - name: request
        in: body
        description: The request body
        required: true
        schema:
          $ref: '#/definitions/ResourceNameAvailabilityRequest'
        x-ms-client-flatten: true
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/ResourceNameAvailability'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
      tags:
      - Subscriptions
  /subscriptions/{subscriptionId}/providers/Microsoft.Web/customhostnameSites:
    get:
      operationId: ListCustomHostNameSites
      summary: Get custom hostnames under this subscription
      description: Get custom hostnames under this subscription
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - name: hostname
        in: query
        description: Specific hostname
        required: false
        type: string
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/CustomHostnameSitesCollection'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
      x-ms-examples:
        Get custom hostnames under subscription:
          $ref: ./examples/ListCustomHostNameSites.json
        Get specific custom hostname under subscription:
          $ref: ./examples/ListCustomSpecificHostNameSites.json
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Subscriptions
  /subscriptions/{subscriptionId}/providers/Microsoft.Web/deploymentLocations:
    get:
      operationId: GetSubscriptionDeploymentLocations
      summary: Gets list of available geo regions plus ministamps
      description: Description for Gets list of available geo regions plus ministamps
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/DeploymentLocations'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
      tags:
      - Subscriptions
  /subscriptions/{subscriptionId}/providers/Microsoft.Web/geoRegions:
    get:
      operationId: ListGeoRegions
      summary: Get a list of available geographical regions.
      description: Description for Get a list of available geographical regions.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - name: sku
        in: query
        description: Name of SKU used to filter the regions.
        required: false
        type: string
        enum:
        - Free
        - Shared
        - Basic
        - Standard
        - Premium
        - Dynamic
        - Isolated
        - IsolatedV2
        - PremiumV2
        - PremiumV3
        - PremiumContainer
        - ElasticPremium
        - ElasticIsolated
        - FlexConsumption
        x-ms-enum:
          name: SkuName
          modelAsString: true
          values:
          - name: Free
            value: Free
          - name: Shared
            value: Shared
          - name: Basic
            value: Basic
          - name: Standard
            value: Standard
          - name: Premium
            value: Premium
          - name: Dynamic
            value: Dynamic
          - name: Isolated
            value: Isolated
          - name: IsolatedV2
            value: IsolatedV2
          - name: PremiumV2
            value: PremiumV2
          - name: PremiumV3
            value: PremiumV3
          - name: PremiumContainer
            value: PremiumContainer
          - name: ElasticPremium
            value: ElasticPremium
          - name: ElasticIsolated
            value: ElasticIsolated
          - name: FlexConsumption
            value: FlexConsumption
      - name: linuxWorkersEnabled
        in: query
        description: Specify <code>true</code> if you want to filter to only regions that support Linux workers.
        required: false
        type: boolean
      - name: xenonWorkersEnabled
        in: query
        description: Specify <code>true</code> if you want to filter to only regions that support Xenon workers.
        required: false
        type: boolean
      - name: linuxDynamicWorkersEnabled
        in: query
        description: Specify <code>true</code> if you want to filter to only regions that support Linux Consumption Workers.
        required: false
        type: boolean
      - name: customModeWorkersEnabled
        in: query
        description: Specify <code>true</code> if you want to filter to only regions that support App Service Plans with <code>IsCustomMode</code> set to <code>true</code>.
        required: false
        type: boolean
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/GeoRegionCollection'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Subscriptions
  /subscriptions/{subscriptionId}/providers/Microsoft.Web/listSitesAssignedToHostName:
    post:
      operationId: ListSiteIdentifiersAssignedToHostName
      summary: List all apps that are assigned to a hostname.
      description: Description for List all apps that are assigned to a hostname.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - name: nameIdentifier
        in: body
        description: The request body
        required: true
        schema:
          $ref: '#/definitions/NameIdentifier'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/IdentifierCollection'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Subscriptions
  /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/checknameavailability:
    post:
      operationId: RegionalCheckNameAvailability
      summary: Check if a resource name is available for DNL sites.
      description: Check if a resource name is available for DNL sites.
      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/LocationParameter
      - name: request
        in: body
        description: The request body
        required: true
        schema:
          $ref: '#/definitions/DnlResourceNameAvailabilityRequest'
        x-ms-client-flatten: true
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/DnlResourceNameAvailability'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
      tags:
      - Subscriptions
  /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/usages:
    get:
      operationId: GetUsagesInLocation_list
      summary: Lists subscription core usages for all skus used in a location, for a given type of quota.
      description: List usages in cores for all skus used by a subscription in a given location, for a specific quota type.
      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/LocationParameter
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/CsmUsageQuotaCollection'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
      x-ms-examples:
        Get usages in location for subscription:
          $ref: ./examples/GetUsagesInLocation.json
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Subscriptions
  /subscriptions/{subscriptionId}/providers/Microsoft.Web/premieraddonoffers:
    get:
      operationId: ListPremierAddOnOffers
      summary: List all premier add-on offers.
      description: Description for List all premier add-on offers.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/PremierAddOnOfferCollection'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Subscriptions
  /subscriptions/{subscriptionId}/providers/Microsoft.Web/skus:
    get:
      operationId: ListSkus
      summary: List all SKUs.
      description: Description for List all SKUs.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/SkuInfos'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
      tags:
      - Subscriptions
  /subscriptions/{subscriptionId}/providers/Microsoft.Web/verifyHostingEnvironmentVnet:
    post:
      operationId: VerifyHostingEnvironmentVnet
      summary: Verifies if this VNET is compatible with an App Service Environment by analyzing the Network Security Group rules.
      description: Description for Verifies if this VNET is compatible with an App Service Environment by analyzing the Network Security Group rules.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - name: parameters
        in: body
        description: The request body
        required: true
        schema:
          $ref: '#/definitions/VnetParameters'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/VnetValidationFailureDetails'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
      x-ms-examples:
        VerifyHostingEnvironmentVnet:
          $ref: ./examples/VerifyHostingEnvironmentVnet.json
      tags:
      - Subscriptions
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/moveResources:
    post:
      operationId: Move
      summary: Move resources between resource groups.
      description: Description for Move resources between resource groups.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - name: moveResourceEnvelope
        in: body
        description: Object that represents the resource to move.
        required: true
        schema:
          $ref: '#/definitions/CsmMoveResourceEnvelope'
      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'
      tags:
      - Subscriptions
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/validate:
    post:
      operationId: Validate
      summary: Validate if a resource can be created.
      description: Description for Validate if a resource can be created.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - name: validateRequest
        in: body
        description: Request with the resources to validate.
        required: true
        schema:
          $ref: '#/definitions/ValidateRequest'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/ValidateResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DefaultErrorResponse'
      tags:
      - Subscriptions
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/validateMoveResources:
    post:
      operationId: ValidateMove
      summary: Validate whether a resource can be moved.
      description: Description for Validate whether a resource can be moved.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - name: moveResourceEnvelope
        in: body
        description: Object that represents the resource to move.
        required: true
        schema:
          $ref: '#/definitions/CsmMoveResourceEnvelope'
      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'
      tags:
      - Subscriptions
definitions:
  HostingEnvironmentStatus:
    type: string
    description: Current status of the App Service Environment.
    enum:
    - Preparing
    - Ready
    - Scaling
    - Deleting
    x-ms-enum:
      name: HostingEnvironmentStatus
      modelAsString: false
  CsmUsageQuota:
    type: object
    description: Usage of the quota resource.
    properties:
      unit:
        type: string
        description: Units of measurement for the quota resource.
      nextResetTime:
        type: string
        format: date-time
        description: Next reset time for the resource counter.
      currentValue:
        type: integer
        format: int64
        description: The current value of the resource counter.
      limit:
        type: integer
        format: int64
        description: The resource limit.
      name:
        $ref: '#/definitions/LocalizableString'
        description: Quota name.
  CustomHostnameSitesCollection:
    type: object
    description: Collection of custom hostname sites
    properties:
      value:
        type: array
        description: The CustomHostnameSites items on this page
        items:
          $ref: '#/definitions/CustomHostnameSites'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  AseV3NetworkingConfiguration:
    type: object
    description: Full view of networking configuration for an ASE.
    properties:
      properties:
        $ref: '#/definitions/AseV3NetworkingConfigurationProperties'
        description: AseV3NetworkingConfiguration resource specific properties
        x-ms-client-flatten: true
      kind:
        type: string
        description: Kind of resource.
    allOf:
    - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
  DnlResourceNameAvailabilityRequest:
    type: object
    properties:
      resourceGroupName:
        type: string
        description: Resource group name
      autoGeneratedDomainNameLabelScope:
        type: string
        description: 'Indicates the endpoint name reuse scope.The default value is TenantReuse.

          Supported values are TenantReuse, SubscriptionReuse, ResourceGroupReuse, NoReuse'
      name:
        type: string
        description: Resource name to verify.
      type:
        $ref: '#/definitions/CheckNameResourceTypes'
        description: Resource type used for verification.
    required:
    - name
    - type
  ValidateResponse:
    type: object
    description: Describes the result of resource validation.
    properties:
      status:
        type: string
        description: Result of validation.
      error:
        $ref: '#/definitions/ValidateResponseError'
        description: Error details for the case when validation fails.
  UpgradeAvailability:
    type: string
    description: Whether an upgrade is available for this App Service Environment.
    enum:
    - None
    - Ready
    x-ms-enum:
      name: UpgradeAvailability
      modelAsString: true
      values:
      - name: None
        value: None
        description: No upgrade is currently available for this App Service Environment
      - name: Ready
        value: Ready
        description: An upgrade is ready to be manually initiated on this App Service Environment
  AseRegion:
    type: object
    description: ASE region.
    properties:
      properties:
        $ref: '#/definitions/AseRegionProperties'
        description: ASE region resource specific properties
        x-ms-client-flatten: true
    allOf:
    - $ref: '#/definitions/ProxyOnlyResource'
  InAvailabilityReasonType:
    type: string
    description: <code>Invalid</code> indicates the name provided does not match Azure App Service naming requirements. <code>AlreadyExists</code> indicates that the name is already in use and is therefore unavailable.
    enum:
    - Invalid
    - AlreadyExists
    x-ms-enum:
      name: InAvailabilityReasonType
      modelAsString: true
      values:
      - name: Invalid
        value: Invalid
      - name: AlreadyExists
        value: AlreadyExists
  SkuInfos:
    type: object
    description: Collection of SKU information.
    properties:
      resourceType:
        type: string
        description: Resource type that this SKU applies to.
      skus:
        type: array
        description: List of SKUs the subscription is able to use.
        items:
          $ref: '#/definitions/GlobalCsmSkuDescription'
        x-ms-identifiers:
        - name
  VnetParameters:
    type: object
    description: The required set of inputs to validate a VNET
    properties:
      properties:
        $ref: '#/definitions/VnetParametersProperties'
        description: VnetParameters resource specific properties
        x-ms-client-flatten: true
    allOf:
    - $ref: '#/definitions/ProxyOnlyResource'
  PremierAddOnOffer:
    type: object
    description: Premier add-on offer.
    properties:
      properties:
        $ref: '#/definitions/PremierAddOnOfferProperties'
        description: PremierAddOnOffer resource specific properties
        x-ms-client-flatten: true
    allOf:
    - $ref: '#/definitions/ProxyOnlyResource'
  Identifier:
    type: object
    description: A domain specific resource identifier.
    properties:
      properties:
        $ref: '#/definitions/IdentifierProperties'
        description: Identifier resource specific properties
        x-ms-client-flatten: true
      kind:
        type: string
        description: Kind of resource.
    allOf:
    - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
  AppServicePlanRestrictions:
    type: string
    description: App Service plans this offer is restricted to.
    enum:
    - None
    - Free
    - Shared
    - Basic
    - Standard
    - Premium
    x-ms-enum:
      name: AppServicePlanRestrictions
      modelAsString: false
  BillingMeter:
    type: object
    description: App Service billing entity that contains information about meter which the Azure billing system utilizes to charge users for services.
    properties:
      properties:
        $ref: '#/definitions/BillingMeterProperties'
        description: BillingMeter resource specific properties
        x-ms-client-flatten: true
    allOf:
    - $ref: '#/definitions/ProxyOnlyResource'
  CsmUsageQuotaCollection:
    type: object
    description: Paged collection of CsmUsageQuota items
    properties:
      value:
        type: array
        description: The CsmUsageQuota items on this page
        items:
          $ref: '#/definitions/CsmUsageQuota'
        x-ms-identifiers:
        - name
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  CsmMoveResourceEnvelope:
    type: object
    description: Object with a list of the resources that need to be moved and the resource group they should be moved to.
    properties:
      targetResourceGroup:
        type: string
        minLength: 1
        maxLength: 90
        pattern: ' ^[-\w\._\(\)]+[^\.]$'
      resources:
        type: array
        items:
          type: string
  VnetValidationFailureDetailsProperties:
    type: object
    description: VnetValidationFailureDetails resource specific properties
    properties:
      message:
        type: string
        description: Text describing the validation outcome.
      failed:
        type: boolean
        description: A flag describing whether or not validation failed.
      failedTests:
        type: array
        description: A list of tests that failed in the validation.
        items:
          $ref: '#/definitions/VnetValidationTestFailure'
      warnings:
        type: array
        description: A list of warnings generated during validation.
        items:
          $ref: '#/definitions/VnetValidationTestFailure'
  ProvisioningState:
    type: string
    description: Provisioning state of the App Service Plan.
    enum:
    - Succeeded
    - Failed
    - Canceled
    - InProgress
    - Deleting
    x-ms-enum:
      name: ProvisioningState
      modelAsString: false
  DefaultErrorResponse:
    type: object
    description: App Service error response.
    properties:
      error:
        $ref: '#/definitions/DefaultErrorResponseError'
        description: Error model.
        readOnly: true
  SkuCapacity:
    type: object
    description: Description of the App Service plan scale options.
    properties:
      minimum:
        type: integer
        format: int32
        description: Minimum number of workers for this App Service plan SKU.
      maximum:
        type: integer
        format: int32
        description: Maximum number of workers for this App Service plan SKU.
      elasticMaximum:
        type: integer
        format: int32
        description: Maximum number of Elastic workers for this App Service plan SKU.
      default:
        type: integer
        format: int32
        description: Default number of workers for this App Service plan SKU.
      scaleType:
        type: string
        description: Available scale configurations for an App Service plan.
  ValidateResourceTypes:
    type: string
    description: Resource type used for verification.
    enum:
    - ServerFarm
    - Site
    - Microsoft.Web/hostingEnvironments
    x-ms-enum:
      name: ValidateResourceTypes
      modelAsString: true
      values:
      - name: ServerFarm
        value: ServerFarm
      - name: Site
        value: Site
      - name: Microsoft.Web/hostingEnvironments
        value: Microsoft.Web/hostingEnvironments
  DnlResourceNameAvailability:
    type: object
    description: Information regarding availability of a resource name for DNL apps with regionalized default hostnames.
    properties:
      hostName:
        type: string
      nameAvailable:
        type: boolean
        description: <code>true</code> indicates name is valid and available. <code>false</code> indicates the name is invalid, unavailable, or both.
      reason:
        $ref: '#/definitions/InAvailabilityReasonType'
        description: <code>Invalid</code> indicates the name provided does not match Azure App Service naming requirements. <code>AlreadyExists</code> indicates that the name is already in use and is therefore unavailable.
      message:
        type: string
        description: If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name.
  GeoRegionCollection:
    type: object
    description: Collection of geographical regions.
    properties:
      value:
        type: array
        description: The GeoRegion items on this page
        items:
          $ref: '#/definitions/GeoRegion'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  HostingEnvironmentDeploymentInfo:
    type: object
    description: Information needed to create resources on an App Service Environment.
    properties:
      name:
        type: string
        description: Name of the App Service Environment.
      location:
        type: string
        description: Location of the App Service Environment.
  DefaultErrorResponseErrorDetailsItem:
    type: object
    description: Detailed errors.
    properties:
      code:
        type: string
        description: Standardized string to programmatically identify the error.
        readOnly: true
      message:
        type: string
        description: Detailed error description and debugging information.
        readOnly: true
      target:
        type: string
        description: Detailed error description and debugging information.
        readOnly: true
  NameValuePair:
    type: object
    description: Name value pair.
    properties:
      name:
        type: string
        description: Pair name.
      value:
        type: string
        description: Pair value.
  IdentifierProperties:
    type: object
    description: Identifier resource specific properties
    properties:
      id:
        type: string
        description: String representation of the identity.
        x-ms-client-name: value
  PremierAddOnOfferProperties:
    type: object
    description: PremierAddOnOffer resource specific properties
    properties:
      sku:
        type: string
        description: Premier add on SKU.
      product:
        type: string
        description: Premier add on offer Product.
      vendor:
        type: string
        description: Premier add on offer Vendor.
      promoCodeRequired:
        type: boolean
        description: <code>true</code> if promotion code is required; otherwise, <code>false</code>.
      quota:
        type: integer
        format: int32
        description: Premier add on offer Quota.
      webHostingPlanRestrictions:
        $ref: '#/definitions/AppServicePlanRestrictions'
        description: App Service plans this offer is restricted to.
      privacyPolicyUrl:
        type: string
        description: Privacy policy URL.
      legalTermsUrl:
        type: string
        description: Legal terms URL.
      marketplacePublisher:
        type: string
        description: Marketplace publisher.
      marketplaceOffer:
        type: string
        description: Marketplace offer.
  VnetValidationFailureDetails:
    type: object
    description: A class that describes the reason for a validation failure.
    properties:
      properties:
        $ref: '#/definitions/VnetValidationFailureDetailsProperties'
        description: VnetValidationFailureDetails resource specific properties
        x-ms-client-flatten: true
    allOf:
    - $ref: '#/definitions/ProxyOnlyResource'
  ValidateResponseError:
    

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