swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector BackupUsageSummaries API
schemes:
- https
tags:
- name: BackupUsageSummaries
paths:
  ? /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupUsageSummaries
  : get:
      tags:
      - BackupUsageSummaries
      description: Fetches the backup management usage summaries of the vault.
      operationId: microsoftAzureBackupusagesummariesList
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/VaultName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: $filter
        in: query
        description: OData filter options.
        required: false
        type: string
      - name: $skipToken
        in: query
        description: skipToken Filter.
        required: false
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/BackupManagementUsageList'
      x-ms-odata: '#/definitions/BMSBackupSummariesQueryObject'
      x-ms-pageable:
        nextLinkName: null
      x-ms-examples:
        Get Protected Items Usages Summary:
          $ref: ./examples/Common/BackupProtectedItem_UsageSummary_Get.json
        Get Protected Containers Usages Summary:
          $ref: ./examples/Common/BackupProtectionContainers_UsageSummary_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupusagesummaries
definitions:
  BackupManagementUsage:
    description: Backup management usages of a vault.
    type: object
    properties:
      unit:
        description: Unit of the usage.
        enum:
        - Count
        - Bytes
        - Seconds
        - Percent
        - CountPerSecond
        - BytesPerSecond
        type: string
        x-ms-enum:
          name: UsagesUnit
          modelAsString: true
      quotaPeriod:
        description: Quota period of usage.
        type: string
      nextResetTime:
        format: date-time
        description: Next reset time of usage.
        type: string
      currentValue:
        format: int64
        description: Current value of usage.
        type: integer
      limit:
        format: int64
        description: Limit of usage.
        type: integer
      name:
        $ref: '#/definitions/NameInfo'
        description: Name of usage.
  NameInfo:
    description: The name of usage.
    type: object
    properties:
      value:
        description: Value of usage.
        type: string
      localizedValue:
        description: Localized value of usage.
        type: string
  BackupManagementUsageList:
    description: Backup management usage for vault.
    type: object
    properties:
      value:
        description: The list of backup management usages for the given vault.
        type: array
        items:
          $ref: '#/definitions/BackupManagementUsage'
        x-ms-identifiers: []
parameters:
  ResourceGroupName:
    name: resourceGroupName
    in: path
    description: The name of the resource group where the recovery services vault is present.
    required: true
    type: string
    x-ms-parameter-location: method
  VaultName:
    name: vaultName
    in: path
    description: The name of the recovery services vault.
    required: true
    type: string
    x-ms-parameter-location: method
  ApiVersion:
    name: api-version
    in: query
    description: Client Api Version.
    required: true
    type: string
  SubscriptionId:
    name: subscriptionId
    in: path
    description: The subscription Id.
    required: true
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'