Azure Storage Management Client Library for Python

Warnings

• breaking The credential system was completely revamped. Old `azure.common.credentials` or `msrestazure.azure_active_directory` instances are no longer supported. Users must migrate to `azure-identity` classes (e.g., `DefaultAzureCredential`). Additionally, the `credentials` parameter was renamed to `credential` in client constructors.
  Fix: Replace legacy credential imports and objects with classes from `azure.identity`. Update client constructor parameter from `credentials` to `credential`.
• breaking The `StorageManagementClient` can no longer be imported from `azure.mgmt.storage.storage_management_client`. It must be imported directly from the top-level `azure.mgmt.storage` package.
  Fix: Change import statement from `from azure.mgmt.storage.storage_management_client import StorageManagementClient` to `from azure.mgmt.storage import StorageManagementClient`.
• breaking As of v24.0.0, the package primarily targets only the *latest* API-Version available on Azure, removing APIs of other versions. If your application relies on a specific older (non-latest) API-Version, it is recommended to pin the `azure-mgmt-storage` package to a previous major version that supported that API.
  Fix: For applications requiring a specific, non-latest API version, explicitly pin the `azure-mgmt-storage` package to a previous version (e.g., `azure-mgmt-storage==21.2.1` for API version '2023-05-01') in your `requirements.txt` or `setup.py`.
• gotcha This library (`azure-mgmt-storage`) is for *management plane* operations (e.g., creating storage accounts, managing keys, policies). For *data plane* operations (e.g., uploading blobs, reading files, sending queue messages), you need the specific data client libraries like `azure-storage-blob`, `azure-storage-file-share`, `azure-storage-queue`, etc.
  Fix: Ensure you are using the correct library for your task: `azure-mgmt-storage` for management and `azure-storage-*` libraries for data operations.
• gotcha Users upgrading to the latest beta or even some generally available versions of the Azure Storage SDKs (including management libraries) might encounter `InvalidHeaderValue` error messages in rare scenarios. This could be due to internal SDK changes.
  Fix: If this issue occurs, downgrade to the previous generally available version of the SDK to see if it resolves. If the problem persists or downgrading is not feasible, open a support ticket with Microsoft.
• gotcha Newer API versions, which the `azure-mgmt-storage` package now targets by default, might not be immediately available in all Azure regions, particularly in sovereign clouds like Azure China. This can lead to deployment failures if trying to use the latest API version in an unsupported region.
  Fix: Check the Azure documentation for API version availability in your target region. If the latest API is not supported, pin `azure-mgmt-storage` to an older package version that uses a supported API version for your region.

Install

• pip install azure-mgmt-storage azure-identity Install with pip

Imports

• StorageManagementClient

  from azure.mgmt.storage import StorageManagementClient

  As of version 24.0.0, importing from `azure.mgmt.storage.storage_management_client` no longer works. The client should be imported directly from `azure.mgmt.storage`.
• DefaultAzureCredential

  from azure.identity import DefaultAzureCredential

Quickstart

This quickstart demonstrates how to initialize the `StorageManagementClient` using `DefaultAzureCredential` for authentication and then list all storage accounts within your Azure subscription. Ensure you have the `AZURE_SUBSCRIPTION_ID` environment variable set, and authenticate via Azure CLI (`az login`) or by setting service principal environment variables (`AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`).

import os
from azure.identity import DefaultAzureCredential
from azure.mgmt.storage import StorageManagementClient

# Set environment variables for authentication and subscription
# AZURE_SUBSCRIPTION_ID
# AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET (for Service Principal)
# Or use 'az login' for Azure CLI credential

try:
    subscription_id = os.environ['AZURE_SUBSCRIPTION_ID']
except KeyError:
    print("Please set the AZURE_SUBSCRIPTION_ID environment variable.")
    exit(1)

# Acquire a credential object
credential = DefaultAzureCredential()

# Initialize the Storage Management client
storage_client = StorageManagementClient(credential, subscription_id)

# List all storage accounts in the subscription
print("Listing storage accounts...")
for account in storage_client.storage_accounts.list():
    print(f"  Name: {account.name}, Location: {account.location}")