Azure Service Bus Management Client Library

Warnings

• breaking Major versions of Azure Management SDKs, especially from v7 onwards, introduced significant breaking changes. These often include the separation of synchronous and asynchronous clients, changes to method signatures (e.g., keyword-only arguments), and updates to model object structures. Upgrading from versions older than 7.x.x typically requires substantial code modification.
  Fix: Review the official migration guides for your specific previous version. Re-evaluate client instantiation, method calls, and how model objects are accessed. Consider using the `async` clients where appropriate for non-blocking I/O.
• gotcha This library (`azure-mgmt-servicebus`) is strictly for *managing* Service Bus resources (creating namespaces, queues, topics, etc.). It does *not* provide functionality for sending or receiving messages from Service Bus queues or topics. For data plane operations, you need to use the `azure-servicebus` library.
  Fix: If your goal is to send or receive messages, use `pip install azure-servicebus`. If you need to manage the infrastructure, use `azure-mgmt-servicebus`.
• gotcha Authentication mechanisms have evolved. Older examples might use `ServicePrincipalCredentials` directly, which is now deprecated. The recommended approach is `azure-identity` (e.g., `DefaultAzureCredential`), which provides a unified way to authenticate across different Azure environments.
  Fix: Always use `azure-identity` for credential management. Ensure you have the `azure-identity` package installed and replace any direct credential instantiation with `DefaultAzureCredential()` or other appropriate `azure-identity` credential types.
• gotcha Listing operations often return paginated iterators rather than a simple list. While these can often be iterated directly, for scenarios requiring explicit page-by-page processing (e.g., handling large result sets, tracking continuation tokens), you may need to use `by_page()` methods if available or handle the iterator carefully.
  Fix: When iterating over large result sets from list operations, be aware that the iterator might fetch items in batches. For fine-grained control or explicit pagination, consult the method's documentation for `by_page()` or similar options, especially in `async` contexts.

Install

• pip install azure-mgmt-servicebus azure-identity Install with identity provider

Imports

• ServiceBusManagementClient

  from azure.mgmt.servicebus import ServiceBusManagementClient

• DefaultAzureCredential

  from azure.identity import DefaultAzureCredential

  Old credential types are deprecated; use azure-identity for modern authentication.

Quickstart

This quickstart demonstrates how to authenticate with Azure using `DefaultAzureCredential` and then use `ServiceBusManagementClient` to list and retrieve Service Bus namespaces within a specified resource group. Ensure `AZURE_SUBSCRIPTION_ID` and `AZURE_RESOURCE_GROUP_NAME` environment variables are set for authentication and resource context.

import os
from azure.identity import DefaultAzureCredential
from azure.mgmt.servicebus import ServiceBusManagementClient

# Set your Azure Subscription ID and Resource Group in environment variables or replace directly.
subscription_id = os.environ.get('AZURE_SUBSCRIPTION_ID', 'YOUR_SUBSCRIPTION_ID')
resource_group_name = os.environ.get('AZURE_RESOURCE_GROUP_NAME', 'my-servicebus-rg')
namespace_name = os.environ.get('AZURE_SERVICEBUS_NAMESPACE', 'my-servicebus-namespace')

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

# Authenticate using DefaultAzureCredential (looks for env vars, managed identity, etc.)
credential = DefaultAzureCredential()

# Create a Service Bus Management Client
servicebus_client = ServiceBusManagementClient(credential, subscription_id)

try:
    # Example: List all Service Bus namespaces in a resource group
    print(f"Listing Service Bus namespaces in resource group '{resource_group_name}':")
    namespaces = servicebus_client.namespaces.list_by_resource_group(resource_group_name)
    for ns in namespaces:
        print(f"  - {ns.name} (Location: {ns.location}, Status: {ns.status})")

    # Example: Get a specific Service Bus namespace (if it exists)
    print(f"\nGetting Service Bus namespace '{namespace_name}':")
    try:
        ns_details = servicebus_client.namespaces.get(resource_group_name, namespace_name)
        print(f"  Namespace '{ns_details.name}' found. Status: {ns_details.status}")
    except Exception as e:
        print(f"  Namespace '{namespace_name}' not found or error: {e}")

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