Microsoft Azure Client Libraries for Python (Meta-package)

Warnings

• breaking The `azure` meta-package (version 5.0.0 and above) is deprecated. Installing it will not provide the latest SDK versions for individual services and is highly discouraged.
  Fix: Instead of `pip install azure`, install specific client libraries for each Azure service you need (e.g., `pip install azure-storage-blob azure-identity`). This reduces install size and improves dependency management.
• breaking Major architectural changes occurred between older Azure SDKs (often referred to as 'Track 1' or 'v2') and the current generation ('Track 2' or 'v3'). This involved significant changes to package names, class structures, and authentication patterns (e.g., moving from `msrestazure` to `azure-identity`).
  Fix: Refer to official migration guides when upgrading existing codebases. Key changes include using `DefaultAzureCredential` for authentication and importing client objects directly from service-specific packages (e.g., `azure.storage.blob` instead of older `azure.storage`).
• gotcha Authentication should leverage `DefaultAzureCredential` from `azure-identity` for passwordless connections. Using account keys or hardcoding credentials is less secure and not recommended for production.
  Fix: Install `azure-identity` and use `DefaultAzureCredential()` which automatically tries various authentication methods (environment variables, Azure CLI, managed identity, etc.). Ensure your environment is configured for one of these methods.
• gotcha Many Azure client libraries offer both synchronous (default) and asynchronous (`.aio` suffixed packages/modules) APIs. Mixing them or failing to use an async transport can lead to errors or suboptimal performance.
  Fix: For asynchronous operations, install an async transport like `aiohttp` (often via `pip install azure-storage-blob[aio]`) and use the `_aio` suffixed clients/modules (e.g., `BlobServiceClient.from_connection_string(**args, transport=AioHttpTransport())` or directly `from azure.storage.blob.aio import BlobServiceClient`).
• gotcha When using Azure management clients (`azure-mgmt-*`), setting a field to `None` in an update (PUT) operation might interpret `None` as a request to *delete* that field, rather than keeping its existing value.
  Fix: For PUT operations, it's generally safer to first `get` the existing resource, modify only the desired fields, and then call `create_or_update` with the modified object. This ensures fields not explicitly set are preserved.
• breaking The `azure-core` library (a foundational dependency for most Azure SDKs) changed its continuation token format in version 1.38.0. This can break pagination and long-running operations if tokens generated by older versions are used with newer clients or vice-versa.
  Fix: Ensure all client libraries in your application are updated to compatible versions. If you store continuation tokens, they may need to be re-generated with the new SDK version. Update all `azure-*` packages to their latest stable releases to minimize compatibility issues.

Install

• pip install azure==4.0.0 To install the last non-deprecated version (older applications)
• pip install azure-storage-blob azure-identity Recommended: Install specific client libraries (e.g., for Blob Storage and Identity)

Imports

• BlobServiceClient

  from azure.storage.blob import BlobServiceClient

  Modern Azure SDKs import specific client objects directly from their service-specific sub-packages, not from a generic 'azure.storage' which might be from older SDKs or not exist.
• DefaultAzureCredential

  from azure.identity import DefaultAzureCredential

  DefaultAzureCredential is the recommended, passwordless authentication method, replacing older credential types found in msrestazure or azure.common.

Quickstart

This quickstart demonstrates how to connect to Azure Blob Storage using the recommended `DefaultAzureCredential` for authentication and perform basic operations like creating a container, uploading a blob, and downloading its content. It requires the `azure-storage-blob` and `azure-identity` packages. Ensure you have an Azure Storage Account and have configured `DefaultAzureCredential` (e.g., by logging in via Azure CLI: `az login` or setting environment variables like `AZURE_STORAGE_ACCOUNT_NAME`).

import os
from azure.identity import DefaultAzureCredential
from azure.storage.blob import BlobServiceClient

# Replace with your storage account name or retrieve from environment variables
STORAGE_ACCOUNT_NAME = os.environ.get('AZURE_STORAGE_ACCOUNT_NAME', 'yourstorageaccountname')
CONTAINER_NAME = 'my-container'
BLOB_NAME = 'hello_world.txt'

try:
    # Authenticate using DefaultAzureCredential (recommended passwordless approach)
    credential = DefaultAzureCredential()
    
    # Construct the blob service client
    blob_service_client = BlobServiceClient(account_url=f"https://{STORAGE_ACCOUNT_NAME}.blob.core.windows.net/", credential=credential)

    # Get a client to interact with a specific container
    container_client = blob_service_client.get_container_client(CONTAINER_NAME)
    
    # Create the container if it doesn't exist
    try:
        container_client.create_container()
        print(f"Container '{CONTAINER_NAME}' created.")
    except Exception as e:
        if "ContainerAlreadyExists" in str(e): # Specific exception for idempotent create
            print(f"Container '{CONTAINER_NAME}' already exists.")
        else:
            raise

    # Upload data to a blob
    data = "Hello, Azure Blob Storage! This is a test blob."
    blob_client = container_client.get_blob_client(BLOB_NAME)
    blob_client.upload_blob(data, overwrite=True)
    print(f"Blob '{BLOB_NAME}' uploaded to container '{CONTAINER_NAME}'.")

    # Download the blob data
    downloaded_blob = blob_client.download_blob().readall()
    print(f"Downloaded blob content: {downloaded_blob.decode('utf-8')}")

    # Clean up (optional: delete the blob and container)
    # blob_client.delete_blob()
    # print(f"Blob '{BLOB_NAME}' deleted.")
    # container_client.delete_container()
    # print(f"Container '{CONTAINER_NAME}' deleted.")

except Exception as ex:
    print(f"An error occurred: {ex}")