Azure Recovery Services Management

4.0.0 · active · verified Thu Apr 09

The Microsoft Azure Recoveryservices Management Client Library for Python provides programmatic access to manage Azure Recovery Services vaults, backup policies, protected items, and disaster recovery configurations. It allows for automation of tasks like creating and configuring backup vaults, setting up replication, and managing backups. The current version is 4.0.0, and Azure SDKs generally follow an independent and frequent release cadence.

Warnings

breaking The `RecoveryServicesClient` constructor now requires `subscription_id` as the second argument.
Fix: Update client instantiation from `RecoveryServicesClient(credential)` to `RecoveryServicesClient(credential, subscription_id)`.
breaking There are significant API model changes and updates to operation signatures in various sub-clients (e.g., `BackupVaultOperationResults.get`, `RecoveryServices.get_operation_result`).
Fix: Consult the official changelog and API reference for version 4.0.0 for specific resource models and updated operation signatures, especially if upgrading from a 3.x version.
gotcha Authentication with Azure services requires the `azure-identity` library and proper credential setup. `DefaultAzureCredential` attempts various methods (environment variables, managed identity, Azure CLI, etc.).
Fix: Install `azure-identity` (`pip install azure-identity`). Set environment variables like `AZURE_SUBSCRIPTION_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_ID`, `AZURE_CLIENT_SECRET` for service principal authentication, or use `az login` for interactive user authentication.
gotcha Many Azure Management operations are scoped to a specific resource group or subscription. Omitting or providing an incorrect scope will result in errors (e.g., 'ResourceNotFound' or 'Forbidden').
Fix: Always ensure the correct `subscription_id` is passed to the client constructor, and that `resource_group_name` is provided for operations that require it. Verify the principal used for authentication has appropriate permissions (e.g., 'Reader' or 'Recovery Services Contributor').

Install

pip install azure-mgmt-recoveryservices azure-identity Install core library and authentication provider

Imports

RecoveryServicesClient

from azure.mgmt.recoveryservices import RecoveryServicesClient

DefaultAzureCredential
```
from azure.identity import DefaultAzureCredential
```
Required for authentication with Azure services.

Quickstart

This quickstart demonstrates how to instantiate the `RecoveryServicesClient` using `DefaultAzureCredential` for authentication and then lists up to 5 Recovery Services vaults in the specified Azure subscription. Ensure `AZURE_SUBSCRIPTION_ID` is set as an environment variable or that `az login` has been executed.

import os
from azure.identity import DefaultAzureCredential
from azure.mgmt.recoveryservices import RecoveryServicesClient

# For local development, set environment variables:
# AZURE_SUBSCRIPTION_ID, AZURE_TENANT_ID, AZURE_CLIENT_ID, AZURE_CLIENT_SECRET
# Alternatively, use `az login` via Azure CLI for interactive authentication.

# Acquire a credential object
credential = DefaultAzureCredential()

# Retrieve subscription ID from environment variable
# It is crucial to provide a valid subscription ID for client instantiation.
subscription_id = os.environ.get("AZURE_SUBSCRIPTION_ID", "")

if not subscription_id:
    print("WARNING: AZURE_SUBSCRIPTION_ID environment variable not set. Please set it or ensure 'az login' is active.")

# Create the Recovery Services client
client = RecoveryServicesClient(credential, subscription_id)

print(f"Successfully created RecoveryServicesClient for subscription: {subscription_id}")

# Example: List up to 5 Recovery Services vaults in the subscription
try:
    print("\nListing up to 5 Recovery Services vaults in the subscription...")
    vault_count = 0
    for vault in client.vaults.list_by_subscription():
        print(f"  - Vault Name: {vault.name}, Location: {vault.location}")
        vault_count += 1
        if vault_count >= 5:
            break
    if vault_count == 0:
        print("  No Recovery Services vaults found in this subscription (or none in the first 5 pages).")
except Exception as e:
    print(f"\nError listing vaults: {e}")
    print("  Ensure you have 'Reader' or 'Recovery Services Contributor' permissions and AZURE_SUBSCRIPTION_ID is correct.")

view raw JSON →