swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector UsagesInformation API
schemes:
- https
tags:
- name: UsagesInformation
paths:
  /{scope}/providers/Microsoft.Quota/usages/{resourceName}:
    get:
      tags:
      - UsagesInformation
      description: Get the current usage of a resource.
      operationId: microsoftAzureUsagesGet
      x-ms-examples:
        Quotas_UsagesRequest_ForNetwork:
          $ref: ./examples/getNetworkOneSkuUsages.json
        Quotas_UsagesRequest_ForCompute:
          $ref: ./examples/getComputeOneSkuUsages.json
      parameters:
      - $ref: '#/parameters/ResourceNameInParameters'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/ScopeInPath'
      responses:
        '200':
          description: OK. The usage information will be returned in the response.
          schema:
            $ref: '#/definitions/CurrentUsagesBase'
          headers:
            ETag:
              description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ExceptionResponse'
      summary: Microsoft Azure Get Scope Providers Microsoft Quota Usages Resourcename
  /{scope}/providers/Microsoft.Quota/usages:
    get:
      tags:
      - UsagesInformation
      description: Get a list of current usage for all resources for the scope specified.
      operationId: microsoftAzureUsagesList
      x-ms-examples:
        Quotas_listUsagesForNetwork:
          $ref: ./examples/getNetworkUsages.json
        Quotas_listUsagesForCompute:
          $ref: ./examples/getComputeUsages.json
        Quotas_listUsagesMachineLearningServices:
          $ref: ./examples/getMachineLearningServicesUsages.json
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/ScopeInPath'
      responses:
        '200':
          description: OK. Usage information will be returned in the response with pagination.
          schema:
            $ref: '#/definitions/UsagesLimits'
          headers:
            ETag:
              description: Current entity state version. It should be treated as opaque and used to make conditional HTTP requests.
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ExceptionResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Scope Providers Microsoft Quota Usages
definitions:
  UsagesObject:
    description: The resource usages value.
    type: object
    properties:
      value:
        type: integer
        format: int32
        description: The usages value.
      usagesType:
        $ref: '#/definitions/UsagesTypes'
    required:
    - value
  UsagesLimits:
    type: object
    description: Quota limits.
    properties:
      value:
        description: List of quota limits.
        type: array
        items:
          $ref: '#/definitions/CurrentUsagesBase'
      nextLink:
        description: The URI used to fetch the next page of quota limits. When there are no more pages, this is null.
        type: string
  CurrentUsagesBase:
    type: object
    description: Resource usage.
    x-ms-azure-resource: true
    properties:
      id:
        description: The resource ID.
        type: string
        readOnly: true
      type:
        description: The resource type.
        type: string
        readOnly: true
      name:
        description: The resource name.
        type: string
        readOnly: true
      properties:
        description: Usage properties for the specified resource.
        $ref: '#/definitions/UsagesProperties'
  ResourceTypesName:
    description: Resource types. For extensibility, it is a string. Optional field.
    readOnly: false
    type: string
  ResourceName:
    type: object
    description: Name of the resource provided by the resource Provider. When requesting quota, use this property name.
    properties:
      value:
        description: Resource name.
        type: string
        readOnly: false
      localizedValue:
        description: Resource display name.
        type: string
        readOnly: true
  UsagesProperties:
    description: Usage properties for the specified resource.
    type: object
    properties:
      usages:
        description: The quota limit properties for this resource.
        $ref: '#/definitions/UsagesObject'
      unit:
        description: ' The units for the quota usage, such as Count and Bytes. When requesting quota, use the **unit** value returned in the GET response in the request body of your PUT operation.'
        type: string
        readOnly: true
      name:
        description: Resource name provided by the resource provider. Use this property name when requesting quota.
        $ref: '#/definitions/ResourceName'
      resourceType:
        description: The name of the resource type. Optional field.
        $ref: '#/definitions/ResourceTypesName'
      quotaPeriod:
        description: "The time period for the summary of the quota usage values. For example:\r\n*P1D (per one day)\n*PT1M (per one minute)\n*PT1S (per one second).\r\nThis parameter is optional because it is not relevant for all resources such as compute."
        type: string
        readOnly: true
      isQuotaApplicable:
        description: States if quota can be requested for this resource.
        type: boolean
        readOnly: true
      properties:
        description: Additional properties for the specific resource provider.
        type: object
  ServiceErrorDetail:
    description: Error details.
    type: object
    properties:
      code:
        type: string
        readOnly: true
        description: Error code.
      message:
        type: string
        readOnly: true
        description: Error message.
  UsagesTypes:
    description: The quota or usages limit types.
    enum:
    - Individual
    - Combined
    type: string
    x-ms-enum:
      name: usagesTypes
      modelAsString: true
  ServiceError:
    description: API error details.
    type: object
    properties:
      code:
        type: string
        description: Error code.
      message:
        type: string
        description: Error message.
      details:
        type: array
        items:
          $ref: '#/definitions/ServiceErrorDetail'
        x-ms-identifiers:
        - code
        description: List of error details.
        readOnly: true
  ExceptionResponse:
    type: object
    properties:
      error:
        $ref: '#/definitions/ServiceError'
        description: API error details.
    description: Error.
parameters:
  ScopeInPath:
    name: scope
    description: The target Azure resource URI. For example, `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/qms-test/providers/Microsoft.Batch/batchAccounts/testAccount/`. This is the target Azure resource URI for the List GET operation. If a `{resourceName}` is added after `/quotas`, then it's the target Azure resource URI in the GET operation for the specific resource.
    in: path
    required: true
    type: string
    x-ms-parameter-location: method
    x-ms-skip-url-encoding: true
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: The API version to use for this operation.
    minLength: 1
  ResourceNameInParameters:
    name: resourceName
    in: path
    required: true
    type: string
    description: "Resource name for a given resource provider. For example:\r\n- SKU name for Microsoft.Compute\r\n- SKU or TotalLowPriorityCores for Microsoft.MachineLearningServices\r\n For Microsoft.Network PublicIPAddresses."
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'