Azure Subscription Management Client Library for Python

3.1.1 · active · verified Fri Apr 10

The `azure-mgmt-subscription` library provides Python APIs for managing Azure subscriptions. It allows developers to programmatically interact with Azure to get subscription details, list available locations, manage subscription aliases, and perform other subscription-related operations. The current stable version is 3.1.1. The Azure SDK for Python generally follows an active release cadence for its management libraries, with updates addressing bug fixes, new features, and breaking changes across major versions.

Warnings

breaking Version 3.0.0 introduced significant breaking changes, including a new code generator. Operations that returned `msrest.polling.LROPoller` now return `azure.core.polling.LROPoller` and are prefixed with `begin_`. `CloudError` was removed and most exceptions are now `azure.core.exceptions.HttpResponseError`. It also introduced stable and official support for async programming.
Fix: Review the migration guide if upgrading from pre-3.0.0 versions. Update long-running operation calls to use `begin_` prefix and `azure.core.polling.LROPoller`. Handle `HttpResponseError` instead of `CloudError`.
breaking Import paths for `SubscriptionClient` and `SubscriptionClientConfiguration` changed. They can no longer be imported from `azure.mgmt.subscription.subscription_client`. Model classes also shifted from sub-modules (e.g., `azure.mgmt.subscription.models.my_class`) to direct import from `azure.mgmt.subscription.models`.
Fix: Update import statements: `from azure.mgmt.subscription import SubscriptionClient` and `from azure.mgmt.subscription.models import ModelName`.
gotcha The `azure-mgmt-subscription` library (and other Azure SDK Python packages) officially ended support for Python 2.7 on January 1, 2022. Version 3.1.1 requires Python 3.7+. Newer management libraries often require Python 3.9+.
Fix: Ensure your Python environment is running Python 3.7 or newer. For new projects, consider Python 3.9+.
gotcha When moving an Azure subscription to a different tenant, both the source and destination subscriptions must reside within the same Microsoft Entra (formerly Azure Active Directory) tenant. This is a crucial prerequisite for successful transfers.
Fix: Before initiating a subscription transfer, verify and if necessary, adjust the Microsoft Entra tenant association for both subscriptions to match.
gotcha Azure resources created using the classic deployment model cannot be moved between subscriptions. All resources in the source subscription must be migrated to the Azure Resource Manager (ARM) model before a subscription transfer can occur.
Fix: Migrate any classic resources to Azure Resource Manager before attempting to move the subscription. This can be a complex process depending on the resources involved.
gotcha Version 3.1.0 had a bug where the `api_version` was missing for some operations (e.g., `list_locations`), causing exceptions. This was fixed in version 3.1.1.
Fix: Upgrade to `azure-mgmt-subscription==3.1.1` or newer. If stuck on 3.1.0, you might need to explicitly pass the `api_version` keyword argument to affected operations.

Install

pip install azure-mgmt-subscription azure-identity Install stable version with authentication library

Imports

SubscriptionClient
```
from azure.mgmt.subscription import SubscriptionClient
```
As of v3.0.0, the SubscriptionClient class was moved directly under the `azure.mgmt.subscription` package.
Subscription
```
from azure.mgmt.subscription.models import Subscription
```
Model classes should be imported directly from `azure.mgmt.subscription.models`, not from sub-modules within `models`.

DefaultAzureCredential

from azure.identity import DefaultAzureCredential

Quickstart

This quickstart demonstrates how to authenticate with Azure using `DefaultAzureCredential` and then use `SubscriptionClient` to list all accessible subscriptions, retrieve details for a specific subscription, and list available locations within that subscription.

import os
from azure.identity import DefaultAzureCredential
from azure.mgmt.subscription import SubscriptionClient

# Ensure AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET are set as environment variables
# for DefaultAzureCredential to work in non-interactive environments.
# For local development, Azure CLI or VS Code authentication might be used, removing the need for explicit env vars.

subscription_id = os.environ.get('AZURE_SUBSCRIPTION_ID', 'YOUR_SUBSCRIPTION_ID')

if not subscription_id or subscription_id == 'YOUR_SUBSCRIPTION_ID':
    raise ValueError("Please set the AZURE_SUBSCRIPTION_ID environment variable or replace 'YOUR_SUBSCRIPTION_ID'.")

try:
    # Authenticate using DefaultAzureCredential
    credential = DefaultAzureCredential()

    # Create a SubscriptionClient
    subscription_client = SubscriptionClient(credential)

    # List all subscriptions accessible by the credential
    print("Listing all subscriptions...")
    for subscription in subscription_client.subscriptions.list():
        print(f"Subscription ID: {subscription.subscription_id}, Display Name: {subscription.display_name}, State: {subscription.state}")

    # Get details for a specific subscription
    print(f"\nGetting details for subscription ID: {subscription_id}")
    specific_subscription = subscription_client.subscriptions.get(subscription_id)
    print(f"Display Name: {specific_subscription.display_name}, State: {specific_subscription.state}")

    # List locations for the specific subscription
    print(f"\nListing locations for subscription ID: {subscription_id}")
    for location in subscription_client.subscriptions.list_locations(subscription_id):
        print(f"Location: {location.display_name} ({location.name})")

except Exception as e:
    print(f"An error occurred: {e}")
    print("Ensure you are logged into Azure (e.g., via `az login`) or environment variables are set correctly.")

view raw JSON →