swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector CheckResourceUsage API
schemes:
- https
tags:
- name: CheckResourceUsage
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Cdn/checkResourceUsage:
    post:
      tags:
      - CheckResourceUsage
      description: Check the quota and actual usage of the CDN profiles under the given subscription.
      operationId: microsoftAzureResourceusageList
      x-ms-examples:
        ResourceUsage_List:
          $ref: ./examples/ResourceUsage_List.json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/ResourceUsageListResult'
        default:
          description: CDN error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Cdn Checkresourceusage
definitions:
  ErrorResponse:
    title: Error response
    description: Error response indicates Azure Front Door Standard or Azure Front Door Premium or CDN service is not able to process the incoming request. The reason is provided in the error message.
    type: object
    properties:
      error:
        $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail
  ResourceUsageListResult:
    description: Output of check resource usage API.
    properties:
      value:
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/ResourceUsage'
        x-ms-identifiers:
        - resourceType
        description: List of resource usages.
      nextLink:
        type: string
        description: URL to get the next set of custom domain objects if there are any.
  ResourceUsage:
    description: Output of check resource usage API.
    type: object
    properties:
      resourceType:
        type: string
        readOnly: true
        description: Resource type for which the usage is provided.
      unit:
        type: string
        readOnly: true
        description: Unit of the usage. e.g. count.
        enum:
        - count
        x-ms-enum:
          name: ResourceUsageUnit
          modelAsString: true
      currentValue:
        type: integer
        format: int32
        readOnly: true
        description: Actual value of usage on the specified resource type.
      limit:
        type: integer
        format: int32
        readOnly: true
        description: Quota of the specified resource type.
parameters:
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: Azure Subscription ID.
    required: true
    type: string
  apiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Version of the API to be used with the client request. Current version is 2023-05-01.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'