Backup Usage Summaries - List

Service:

Recovery Services - Backup

API Version:

2026-07-01

Fetches the backup management usage summaries of the vault.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupUsageSummaries?api-version=2026-07-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupUsageSummaries?api-version=2026-07-01&$filter={$filter}&$skipToken={$skipToken}

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
vaultName	path	True	string	The name of the recovery services vault.
api-version	query	True	string minLength: 1	The API version to use for this operation.
$filter	query		string	OData filter options.
$skipToken	query		string	skipToken Filter.

Responses

Name	Type	Description
200 OK	BackupManagementUsageList	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

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

Get Protected Containers Usages Summary

Get Protected Items Usages Summary

Get Protected Containers Usages Summary

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/testVault/backupUsageSummaries?api-version=2026-07-01&$filter=type eq 'BackupProtectionContainerCountSummary'

Java

/**
 * Samples for BackupUsageSummaries List.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-07-01/Common/BackupProtectionContainers_UsageSummary_Get.json
     */
    /**
     * Sample code: Get Protected Containers Usages Summary.
     * 
     * @param manager Entry point to RecoveryServicesBackupManager.
     */
    public static void getProtectedContainersUsagesSummary(
        com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
        manager.backupUsageSummaries().list("testVault", "testRG", "type eq 'BackupProtectionContainerCountSummary'",
            null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.recoveryservicesbackup import RecoveryServicesBackupClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-recoveryservicesbackup
# USAGE
    python backup_protection_containers_usage_summary_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = RecoveryServicesBackupClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.backup_usage_summaries.list(
        vault_name="testVault",
        resource_group_name="testRG",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2026-07-01/Common/BackupProtectionContainers_UsageSummary_Get.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armrecoveryservicesbackup_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/recoveryservices/armrecoveryservicesbackup/v5"
)

// Generated from example definition: 2026-07-01/Common/BackupProtectionContainers_UsageSummary_Get.json
func ExampleBackupUsageSummariesClient_NewListPager_getProtectedContainersUsagesSummary() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armrecoveryservicesbackup.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewBackupUsageSummariesClient().NewListPager("testVault", "testRG", &armrecoveryservicesbackup.BackupUsageSummariesClientListOptions{
		Filter: to.Ptr("type eq 'BackupProtectionContainerCountSummary'")})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armrecoveryservicesbackup.BackupUsageSummariesClientListResponse{
		// 	BackupManagementUsageList: armrecoveryservicesbackup.BackupManagementUsageList{
		// 		Value: []*armrecoveryservicesbackup.BackupManagementUsage{
		// 			{
		// 				Name: &armrecoveryservicesbackup.NameInfo{
		// 					LocalizedValue: to.Ptr("Azure Backup Server"),
		// 					Value: to.Ptr("AzureBackupServer"),
		// 				},
		// 				CurrentValue: to.Ptr[int64](2),
		// 				Limit: to.Ptr[int64](-1),
		// 				Unit: to.Ptr(armrecoveryservicesbackup.UsagesUnitCount),
		// 			},
		// 			{
		// 				Name: &armrecoveryservicesbackup.NameInfo{
		// 					LocalizedValue: to.Ptr("Azure Backup Agent"),
		// 					Value: to.Ptr("MAB"),
		// 				},
		// 				CurrentValue: to.Ptr[int64](3),
		// 				Limit: to.Ptr[int64](-1),
		// 				Unit: to.Ptr(armrecoveryservicesbackup.UsagesUnitCount),
		// 			},
		// 			{
		// 				Name: &armrecoveryservicesbackup.NameInfo{
		// 					LocalizedValue: to.Ptr("SQL in Azure VM"),
		// 					Value: to.Ptr("AzureWorkload"),
		// 				},
		// 				CurrentValue: to.Ptr[int64](1),
		// 				Limit: to.Ptr[int64](-1),
		// 				Unit: to.Ptr(armrecoveryservicesbackup.UsagesUnitCount),
		// 			},
		// 		},
		// 	},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { RecoveryServicesBackupClient } = require("@azure/arm-recoveryservicesbackup");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to fetches the backup management usage summaries of the vault.
 *
 * @summary fetches the backup management usage summaries of the vault.
 * x-ms-original-file: 2026-07-01/Common/BackupProtectionContainers_UsageSummary_Get.json
 */
async function getProtectedContainersUsagesSummary() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new RecoveryServicesBackupClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.backupUsageSummaries.list("testVault", "testRG", {
    filter: "type eq 'BackupProtectionContainerCountSummary'",
  })) {
    resArray.push(item);
  }

  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "value": [
    {
      "name": {
        "localizedValue": "Azure Backup Server",
        "value": "AzureBackupServer"
      },
      "currentValue": 2,
      "limit": -1,
      "unit": "Count"
    },
    {
      "name": {
        "localizedValue": "Azure Backup Agent",
        "value": "MAB"
      },
      "currentValue": 3,
      "limit": -1,
      "unit": "Count"
    },
    {
      "name": {
        "localizedValue": "SQL in Azure VM",
        "value": "AzureWorkload"
      },
      "currentValue": 1,
      "limit": -1,
      "unit": "Count"
    }
  ]
}

Get Protected Items Usages Summary

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/testVault/backupUsageSummaries?api-version=2026-07-01&$filter=type eq 'BackupProtectedItemCountSummary'

Java

/**
 * Samples for BackupUsageSummaries List.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-07-01/Common/BackupProtectedItem_UsageSummary_Get.json
     */
    /**
     * Sample code: Get Protected Items Usages Summary.
     * 
     * @param manager Entry point to RecoveryServicesBackupManager.
     */
    public static void getProtectedItemsUsagesSummary(
        com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
        manager.backupUsageSummaries().list("testVault", "testRG", "type eq 'BackupProtectedItemCountSummary'", null,
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.recoveryservicesbackup import RecoveryServicesBackupClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-recoveryservicesbackup
# USAGE
    python backup_protected_item_usage_summary_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = RecoveryServicesBackupClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.backup_usage_summaries.list(
        vault_name="testVault",
        resource_group_name="testRG",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2026-07-01/Common/BackupProtectedItem_UsageSummary_Get.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armrecoveryservicesbackup_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/recoveryservices/armrecoveryservicesbackup/v5"
)

// Generated from example definition: 2026-07-01/Common/BackupProtectedItem_UsageSummary_Get.json
func ExampleBackupUsageSummariesClient_NewListPager_getProtectedItemsUsagesSummary() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armrecoveryservicesbackup.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewBackupUsageSummariesClient().NewListPager("testVault", "testRG", &armrecoveryservicesbackup.BackupUsageSummariesClientListOptions{
		Filter: to.Ptr("type eq 'BackupProtectedItemCountSummary'")})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armrecoveryservicesbackup.BackupUsageSummariesClientListResponse{
		// 	BackupManagementUsageList: armrecoveryservicesbackup.BackupManagementUsageList{
		// 		Value: []*armrecoveryservicesbackup.BackupManagementUsage{
		// 			{
		// 				Name: &armrecoveryservicesbackup.NameInfo{
		// 					LocalizedValue: to.Ptr("Azure Virtual Machine"),
		// 					Value: to.Ptr("AzureIaasVM"),
		// 				},
		// 				CurrentValue: to.Ptr[int64](7),
		// 				Limit: to.Ptr[int64](-1),
		// 				Unit: to.Ptr(armrecoveryservicesbackup.UsagesUnitCount),
		// 			},
		// 			{
		// 				Name: &armrecoveryservicesbackup.NameInfo{
		// 					LocalizedValue: to.Ptr("Azure Backup Agent"),
		// 					Value: to.Ptr("MAB"),
		// 				},
		// 				CurrentValue: to.Ptr[int64](3),
		// 				Limit: to.Ptr[int64](-1),
		// 				Unit: to.Ptr(armrecoveryservicesbackup.UsagesUnitCount),
		// 			},
		// 			{
		// 				Name: &armrecoveryservicesbackup.NameInfo{
		// 					LocalizedValue: to.Ptr("Azure Backup Server"),
		// 					Value: to.Ptr("AzureBackupServer"),
		// 				},
		// 				CurrentValue: to.Ptr[int64](1),
		// 				Limit: to.Ptr[int64](-1),
		// 				Unit: to.Ptr(armrecoveryservicesbackup.UsagesUnitCount),
		// 			},
		// 			{
		// 				Name: &armrecoveryservicesbackup.NameInfo{
		// 					LocalizedValue: to.Ptr("Azure Storage (Azure Files)"),
		// 					Value: to.Ptr("AzureStorage"),
		// 				},
		// 				CurrentValue: to.Ptr[int64](2),
		// 				Limit: to.Ptr[int64](-1),
		// 				Unit: to.Ptr(armrecoveryservicesbackup.UsagesUnitCount),
		// 			},
		// 			{
		// 				Name: &armrecoveryservicesbackup.NameInfo{
		// 					LocalizedValue: to.Ptr("SQL in Azure VM"),
		// 					Value: to.Ptr("AzureWorkload"),
		// 				},
		// 				CurrentValue: to.Ptr[int64](2),
		// 				Limit: to.Ptr[int64](-1),
		// 				Unit: to.Ptr(armrecoveryservicesbackup.UsagesUnitCount),
		// 			},
		// 		},
		// 	},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { RecoveryServicesBackupClient } = require("@azure/arm-recoveryservicesbackup");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to fetches the backup management usage summaries of the vault.
 *
 * @summary fetches the backup management usage summaries of the vault.
 * x-ms-original-file: 2026-07-01/Common/BackupProtectedItem_UsageSummary_Get.json
 */
async function getProtectedItemsUsagesSummary() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new RecoveryServicesBackupClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.backupUsageSummaries.list("testVault", "testRG", {
    filter: "type eq 'BackupProtectedItemCountSummary'",
  })) {
    resArray.push(item);
  }

  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "value": [
    {
      "name": {
        "localizedValue": "Azure Virtual Machine",
        "value": "AzureIaasVM"
      },
      "currentValue": 7,
      "limit": -1,
      "unit": "Count"
    },
    {
      "name": {
        "localizedValue": "Azure Backup Agent",
        "value": "MAB"
      },
      "currentValue": 3,
      "limit": -1,
      "unit": "Count"
    },
    {
      "name": {
        "localizedValue": "Azure Backup Server",
        "value": "AzureBackupServer"
      },
      "currentValue": 1,
      "limit": -1,
      "unit": "Count"
    },
    {
      "name": {
        "localizedValue": "Azure Storage (Azure Files)",
        "value": "AzureStorage"
      },
      "currentValue": 2,
      "limit": -1,
      "unit": "Count"
    },
    {
      "name": {
        "localizedValue": "SQL in Azure VM",
        "value": "AzureWorkload"
      },
      "currentValue": 2,
      "limit": -1,
      "unit": "Count"
    }
  ]
}

Definitions

Name	Description
BackupManagementUsage	Backup management usages of a vault.
BackupManagementUsageList	Backup management usage for vault.
ErrorDetail	Error Detail class which encapsulates Code, Message and Recommendations.
ErrorResponse	Error response
NameInfo	The name of usage.
UsagesUnit	Unit of the usage.

BackupManagementUsage

Object

Backup management usages of a vault.

Name	Type	Description
currentValue	integer (int64)	Current value of usage.
limit	integer (int64)	Limit of usage.
name	NameInfo	Name of usage.
nextResetTime	string (date-time)	Next reset time of usage.
quotaPeriod	string	Quota period of usage.
unit	UsagesUnit	Unit of the usage.

BackupManagementUsageList

Object

Backup management usage for vault.

Name	Type	Description
nextLink	string	The URI to fetch the next page of resources, with each API call returning up to 200 resources per page. Use ListNext() to fetch the next page if the total number of resources exceeds 200.
value	BackupManagementUsage[]	The list of backup management usages for the given vault.

ErrorDetail

Object

Error Detail class which encapsulates Code, Message and Recommendations.

Name	Type	Description
code	string	Error code.
message	string	Error Message related to the Code.
recommendations	string[]	List of recommendation strings.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

NameInfo

Object

The name of usage.

Name	Type	Description
localizedValue	string	Localized value of usage.
value	string	Value of usage.

UsagesUnit

Enumeration

Unit of the usage.

Value	Description
Count
Bytes
Seconds
Percent
CountPerSecond
BytesPerSecond