Share via

Usages - List By Vaults

  • Reference
Service:
Recovery Services
API Version:
2023-04-01

Fetches the usages of the vault.

GET https://management.azure.com/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/usages?api-version=2023-04-01

URI Parameters

Name In Required Type Description
resourceGroupName
 path True

string

The name of the resource group. The name is case insensitive.
subscriptionId
 path True

string

The ID of the target subscription.
vaultName
 path True

string

The name of the recovery services vault.
api-version
 query True

string

The API version to use for this operation.

Responses

Name Type Description
200 OK

VaultUsageList

OK

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account.

Examples

Gets vault usages

Sample Request

GET https://management.azure.com/Subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample/usages?api-version=2023-04-01

Sample Response

Status code:
200 
{
  "value": [
    {
      "unit": "Count",
      "currentValue": 6,
      "limit": -1,
      "name": {
        "value": "MABContainersCount",
        "localizedValue": "Backup management servers"
      }
    },
    {
      "unit": "Count",
      "currentValue": 3,
      "limit": -1,
      "name": {
        "value": "ProtectedItemCount",
        "localizedValue": "Backup items/Azure virtual machine backup"
      }
    },
    {
      "unit": "Count",
      "currentValue": 0,
      "limit": -1,
      "name": {
        "value": "ProtectedItemCriticalCount",
        "localizedValue": "Critical"
      }
    },
    {
      "unit": "Count",
      "currentValue": 0,
      "limit": -1,
      "name": {
        "value": "ProtectedItemWarningCount",
        "localizedValue": "Warning"
      }
    },
    {
      "unit": "Count",
      "currentValue": 0,
      "limit": -1,
      "name": {
        "value": "IaaSVMProtectedItemCount",
        "localizedValue": "Azure Virtual Machines"
      }
    },
    {
      "unit": "Count",
      "currentValue": 0,
      "limit": -1,
      "name": {
        "value": "IaaSVMProtectedItemCriticalCount",
        "localizedValue": "Critical"
      }
    },
    {
      "unit": "Count",
      "currentValue": 0,
      "limit": -1,
      "name": {
        "value": "IaaSVMProtectedItemWarningCount",
        "localizedValue": "Warning"
      }
    },
    {
      "unit": "Count",
      "currentValue": 0,
      "limit": -1,
      "name": {
        "value": "MABProtectedItemCount",
        "localizedValue": "File-Folders"
      }
    },
    {
      "unit": "Count",
      "currentValue": 1,
      "limit": -1,
      "name": {
        "value": "DPMProtectedItemCount",
        "localizedValue": "DPM Protected Items Count"
      }
    },
    {
      "unit": "Count",
      "currentValue": 2,
      "limit": -1,
      "name": {
        "value": "AzureBackupServerProtectedItemCount",
        "localizedValue": "Azure Backup Server Protected Items Count"
      }
    },
    {
      "unit": "Count",
      "quotaPeriod": "P1D",
      "currentValue": 0,
      "limit": -1,
      "name": {
        "value": "InProgressJobsCount",
        "localizedValue": "In progress"
      }
    },
    {
      "unit": "Count",
      "quotaPeriod": "P1D",
      "currentValue": 0,
      "limit": -1,
      "name": {
        "value": "FailedJobsCount",
        "localizedValue": "Failed"
      }
    },
    {
      "unit": "Bytes",
      "currentValue": 117007930,
      "limit": -1,
      "name": {
        "value": "GRSStorageUsage",
        "localizedValue": "Cloud - GRS"
      }
    },
    {
      "unit": "Bytes",
      "currentValue": 0,
      "limit": -1,
      "name": {
        "value": "LRSStorageUsage",
        "localizedValue": "Cloud - LRS"
      }
    },
    {
      "unit": "Count",
      "currentValue": 5,
      "limit": -1,
      "name": {
        "value": "ManagedInstances",
        "localizedValue": "Protected Instances"
      }
    },
    {
      "unit": "Bytes",
      "currentValue": 0,
      "limit": -1,
      "name": {
        "value": "GRSDedupStorageUsage",
        "localizedValue": "Dedup - GRS"
      }
    },
    {
      "unit": "Bytes",
      "currentValue": 0,
      "limit": -1,
      "name": {
        "value": "LRSDedupStorageUsage",
        "localizedValue": "Dedup - LRS"
      }
    },
    {
      "unit": "Bytes",
      "currentValue": 117851553792,
      "limit": -1,
      "name": {
        "value": "UsedDiskSize",
        "localizedValue": "Backup Engines' Disk Used"
      }
    }
  ]
}

Definitions

Name Description
NameInfo

The name of usage.
UsagesUnit

Unit of the usage.
VaultUsage

Usages of a vault.
VaultUsageList

Usage for vault.

NameInfo

The name of usage.

Name Type Description
localizedValue

string

Localized value of usage.
value

string

Value of usage.

UsagesUnit

Unit of the usage.

Name Type Description
Bytes

string

BytesPerSecond

string

Count

string

CountPerSecond

string

Percent

string

Seconds

string

VaultUsage

Usages of a vault.

Name Type Description
currentValue

integer

Current value of usage.
limit

integer

Limit of usage.
name

NameInfo

Name of usage.
nextResetTime

string

Next reset time of usage.
quotaPeriod

string

Quota period of usage.
unit

UsagesUnit

Unit of the usage.

VaultUsageList

Usage for vault.

Name Type Description
value

VaultUsage[]

The list of usages for the given vault.