Replication Usages - List

Service:

Recovery Services

API Version:

2025-02-01

Fetches the replication usages of the vault.

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

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.

Responses

Name	Type	Description
200 OK	ReplicationUsageList	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 Replication usages of vault

Sample request

HTTP

GET https://management.azure.com/Subscriptions/6808dbbc-98c7-431f-a1b1-9580902423b7/resourceGroups/avrai7517RG1/providers/Microsoft.RecoveryServices/vaults/avrai7517Vault1/replicationUsages?api-version=2025-02-01

Java

/**
 * Samples for ReplicationUsages List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2025-02-01/examples/
     * ListReplicationUsages.json
     */
    /**
     * Sample code: Gets Replication usages of vault.
     * 
     * @param manager Entry point to RecoveryServicesManager.
     */
    public static void
        getsReplicationUsagesOfVault(com.azure.resourcemanager.recoveryservices.RecoveryServicesManager manager) {
        manager.replicationUsages().list("avrai7517RG1", "avrai7517Vault1", 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.recoveryservices import RecoveryServicesClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-recoveryservices
# USAGE
    python list_replication_usages.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 = RecoveryServicesClient(
        credential=DefaultAzureCredential(),
        subscription_id="6808dbbc-98c7-431f-a1b1-9580902423b7",
    )

    response = client.replication_usages.list(
        resource_group_name="avrai7517RG1",
        vault_name="avrai7517Vault1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2025-02-01/examples/ListReplicationUsages.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 armrecoveryservices_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/recoveryservices/armrecoveryservices/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82e9c6f9fbfa2d6d47d5e2a6a11c0ad2eb345c43/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2025-02-01/examples/ListReplicationUsages.json
func ExampleReplicationUsagesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armrecoveryservices.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewReplicationUsagesClient().NewListPager("avrai7517RG1", "avrai7517Vault1", nil)
	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.ReplicationUsageList = armrecoveryservices.ReplicationUsageList{
		// 	Value: []*armrecoveryservices.ReplicationUsage{
		// 		{
		// 			JobsSummary: &armrecoveryservices.JobsSummary{
		// 				FailedJobs: to.Ptr[int32](0),
		// 				InProgressJobs: to.Ptr[int32](0),
		// 				SuspendedJobs: to.Ptr[int32](0),
		// 			},
		// 			MonitoringSummary: &armrecoveryservices.MonitoringSummary{
		// 				DeprecatedProviderCount: to.Ptr[int32](0),
		// 				EventsCount: to.Ptr[int32](0),
		// 				SupportedProviderCount: to.Ptr[int32](0),
		// 				UnHealthyProviderCount: to.Ptr[int32](0),
		// 				UnHealthyVMCount: to.Ptr[int32](0),
		// 				UnsupportedProviderCount: to.Ptr[int32](0),
		// 			},
		// 			ProtectedItemCount: to.Ptr[int32](2),
		// 			RecoveryPlanCount: to.Ptr[int32](1),
		// 			RegisteredServersCount: to.Ptr[int32](2),
		// 	}},
		// }
	}
}

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 { RecoveryServicesClient } = require("@azure/arm-recoveryservices");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Fetches the replication usages of the vault.
 *
 * @summary Fetches the replication usages of the vault.
 * x-ms-original-file: specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2025-02-01/examples/ListReplicationUsages.json
 */
async function getsReplicationUsagesOfVault() {
  const subscriptionId =
    process.env["RECOVERYSERVICES_SUBSCRIPTION_ID"] || "6808dbbc-98c7-431f-a1b1-9580902423b7";
  const resourceGroupName = process.env["RECOVERYSERVICES_RESOURCE_GROUP"] || "avrai7517RG1";
  const vaultName = "avrai7517Vault1";
  const credential = new DefaultAzureCredential();
  const client = new RecoveryServicesClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.replicationUsages.list(resourceGroupName, vaultName)) {
    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": [
    {
      "monitoringSummary": {
        "unHealthyVmCount": 0,
        "unHealthyProviderCount": 0,
        "eventsCount": 0,
        "deprecatedProviderCount": 0,
        "supportedProviderCount": 0,
        "unsupportedProviderCount": 0
      },
      "jobsSummary": {
        "failedJobs": 0,
        "suspendedJobs": 0,
        "inProgressJobs": 0
      },
      "protectedItemCount": 2,
      "registeredServersCount": 2,
      "recoveryPlanCount": 1
    }
  ]
}

Definitions

Name	Description
JobsSummary	Summary of the replication job data for this vault.
MonitoringSummary	Summary of the replication monitoring data for this vault.
ReplicationUsage	Replication usages of a vault.
ReplicationUsageList	Replication usages for vault.

JobsSummary

Object

Summary of the replication job data for this vault.

Name	Type	Description
failedJobs	integer	Count of failed jobs.
inProgressJobs	integer	Count of in-progress jobs.
suspendedJobs	integer	Count of suspended jobs.

MonitoringSummary

Object

Summary of the replication monitoring data for this vault.

Name	Type	Description
deprecatedProviderCount	integer	Count of all deprecated recovery service providers.
eventsCount	integer	Count of all critical warnings.
supportedProviderCount	integer	Count of all the supported recovery service providers.
unHealthyProviderCount	integer	Count of unhealthy replication providers.
unHealthyVmCount	integer	Count of unhealthy VMs.
unsupportedProviderCount	integer	Count of all the unsupported recovery service providers.

ReplicationUsage

Object

Replication usages of a vault.

Name	Type	Description
jobsSummary	JobsSummary	Summary of the replication jobs data for this vault.
monitoringSummary	MonitoringSummary	Summary of the replication monitoring data for this vault.
protectedItemCount	integer	Number of replication protected items for this vault.
recoveryPlanCount	integer	Number of replication recovery plans for this vault.
recoveryServicesProviderAuthType	integer	The authentication type of recovery service providers in the vault.
registeredServersCount	integer	Number of servers registered to this vault.

ReplicationUsageList

Object

Replication usages for vault.

Name	Type	Description
value	ReplicationUsage[]	The list of replication usages for the given vault.