Description

# Azure Service Bus client library for Python Azure Service Bus is a high performance cloud-managed messaging service for providing real-time and fault-tolerant communication between distributed senders and receivers. Service Bus provides multiple mechanisms for asynchronous highly reliable communication, such as structured first-in-first-out messaging, publish/subscribe capabilities, and the ability to easily scale as your needs grow. Use the Service Bus client library for Python to communicate between applications and services and implement asynchronous messaging patterns. * Create Service Bus namespaces, queues, topics, and subscriptions, and modify their settings. * Send and receive messages within your Service Bus channels. * Utilize message locks, sessions, and dead letter functionality to implement complex messaging patterns. [Source code](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/servicebus/azure-servicebus/) | [Package (PyPi)][pypi] | [Package (Conda)](https://anaconda.org/microsoft/azure-servicebus) | [API reference documentation][api_docs] | [Product documentation][product_docs] | [Samples](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/servicebus/azure-servicebus/samples) | [Changelog](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/servicebus/azure-servicebus/CHANGELOG.md) **NOTE**: If you are using version 0.50 or lower and want to migrate to the latest version of this package please look at our [migration guide to move from Service Bus V0.50 to Service Bus V7][migration_guide]. ## Getting started ### Install the package Install the Azure Service Bus client library for Python with [pip][pip]: ```Bash pip install azure-servicebus ``` ### Prerequisites: To use this package, you must have: * Azure subscription - [Create a free account][azure_sub] * Azure Service Bus - [Namespace and management credentials][service_bus_namespace] * Python 3.9 or later - [Install Python][python] If you need an Azure service bus namespace, you can create it via the [Azure Portal][azure_namespace_creation]. If you do not wish to use the graphical portal UI, you can use the Azure CLI via [Cloud Shell][cloud_shell_bash], or Azure CLI run locally, to create one with this Azure CLI command: ```Bash az servicebus namespace create --resource-group <resource-group-name> --name <servicebus-namespace-name> --location <servicebus-namespace-location> ``` ### Authenticate the client Interaction with Service Bus starts with an instance of the `ServiceBusClient` class. You either need a **connection string with SAS key**, or a **namespace** and one of its **account keys** to instantiate the client object. Please find the samples linked below for demonstration as to how to authenticate via either approach. #### [Create client from connection string][sample_authenticate_client_connstr] - To obtain the required credentials, one can use the [Azure CLI][azure_cli] snippet (Formatted for Bash Shell) at the top of the linked sample to populate an environment variable with the service bus connection string (you can also find these values in the [Azure Portal][azure_portal] by following the step-by-step guide to [Get a service bus connection string][get_servicebus_conn_str]). #### [Create client using the azure-identity library][sample_authenticate_client_aad]: - This constructor takes the fully qualified namespace of your Service Bus instance and a credential that implements the [TokenCredential][token_credential_interface] protocol. There are implementations of the `TokenCredential` protocol available in the [azure-identity package][pypi_azure_identity]. The fully qualified namespace is of the format `<yournamespace.servicebus.windows.net>`. - To use the credential types provided by `azure-identity`, please install the package: ```pip install azure-identity``` - Additionally, to use the async API, you must first install an async transport, such as [`aiohttp`](https://pypi.org/project/aiohttp/): ```pip install aiohttp``` - When using Azure Active Directory, your principal must be assigned a role which allows access to Service Bus, such as the Azure Service Bus Data Owner role. For more information about using Azure Active Directory authorization with Service Bus, please refer to [the associated documentation][servicebus_aad_authentication]. >**Note:** client can be initialized without a context manager, but must be manually closed via client.close() to not leak resources. ## Key concepts Once you've initialized a `ServiceBusClient`, you can interact with the primary resource types within a Service Bus Namespace, of which multiple can exist and on which actual message transmission takes place, the namespace often serving as an application container: * [Queue][queue_concept]: Allows for Sending and Receiving of message. Often used for point-to-point communication. * [Topic][topic_concept]: As opposed to Queues, Topics are better suited to publish/subscribe scenarios. A to