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 | Package (PyPi) | API reference documentation | Product documentation | Samples | Changelog

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.

Getting started

Install the package

Install the Azure Service Bus client library for Python with pip:

pip install azure-servicebus

Prerequisites:

To use this package, you must have:

• Azure subscription - Create a free account
• Azure Service Bus - Namespace and management credentials
• Python 2.7, 3.6 or later - Install Python

If you need an Azure service bus namespace, you can create it via the Azure Portal. If you do not wish to use the graphical portal UI, you can use the Azure CLI via Cloud Shell, or Azure CLI run locally, to create one with this Azure CLI command:

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

• To obtain the required credentials, one can use the 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 by following the step-by-step guide to Get a service bus connection string).

Create client using the azure-identity library:

• This constructor takes the fully qualified namespace of your Service Bus instance and a credential that implements the TokenCredential protocol. There are implementations of the TokenCredential protocol available in the azure-identity package. 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 supported on Python 3.6+, you must first install an async transport, such as 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.

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: Allows for Sending and Receiving of message. Often used for point-to-point communication.

• Topic: As opposed to Queues, Topics are better suited to publish/subscribe scenarios. A topic can be sent to, but requires a subscription, of which there can be multiple in parallel, to consume from.

• Subscription: The mechanism to consume from a Topic. Each subscription is independent, and receives a copy of each message sent to the topic. Rules and Filters can be used to tailor which messages are received by a specific subscription.

For more information about these resources, see What is Azure Service Bus?.

To interact with these resources, one should be familiar with the following SDK concepts:

• ServiceBusClient: This is the object a user should first initialize to connect to a Service Bus Namespace. To interact with a queue, topic, or subscription, one would spawn a sender or receiver off of this client.

• ServiceBusSender: To send messages to a Queue or Topic, one would use the corresponding get_queue_sender or get_topic_sender method off of a ServiceBusClient instance as seen here.

• ServiceBusReceiver: To receive messages from a Queue or Subscription, one would use the corresponding get_queue_receiver or get_subscription_receiver method off of a ServiceBusClient instance as seen here.

• ServiceBusMessage: When sending, this is the type you will construct to contain your payload. When receiving, this is where you will access the payload.

Examples

The following sections provide several code snippets covering some of the most common Service Bus tasks, including:

• Send messages to a queue
• Receive messages from a queue
• Send and receive a message from a session enabled queue
• Working with topics and subscriptions
• Settle a message after receipt
• Automatically renew Message or Session locks

To perform management tasks such as creating and deleting queues/topics/subscriptions, please utilize the azure-mgmt-servicebus library, available here.

Please find further examples in the samples directory demonstrating common Service Bus scenarios such as sending, receiving, session management and message handling.

Send messages to a queue

NOTE: see reference documentation here.

This example sends single message and array of messages to a queue that is assumed to already exist, created via the Azure portal or az commands.

from azure.servicebus import ServiceBusClient, ServiceBusMessage

import os
connstr = os.environ['SERVICE_BUS_CONNECTION_STR']
queue_name = os.environ['SERVICE_BUS_QUEUE_NAME']

with ServiceBusClient.from_connection_string(connstr) as client:
    with client.get_queue_sender(queue_name) as sender:
        # Sending a single message
        single_message = ServiceBusMessage("Single message")
        sender.send_messages(single_message)

        # Sending a list of messages
        messages = [ServiceBusMessage("First message"), ServiceBusMessage("Second message")]
        sender.send_messages(messages)

NOTE: A message may be scheduled for delayed delivery using the ServiceBusSender.schedule_messages() method, or by specifying ServiceBusMessage.scheduled_enqueue_time_utc before calling ServiceBusSender.send_messages()

For more detail on scheduling and schedule cancellation please see a sample here.

Receive messages from a queue

To receive from a queue, you can either perform an ad-hoc receive via receiver.receive_messages() or receive persistently through the receiver itself.

Receive messages from a queue through iterating over ServiceBusReceiver

from azure.servicebus import ServiceBusClient

import os
connstr = os.environ['SERVICE_BUS_CONNECTION_STR']
queue_name = os.environ['SERVICE_BUS_QUEUE_NAME']

with ServiceBusClient.from_connection_string(connstr) as client:
    # max_wait_time specifies how long the receiver should wait with no incoming messages before stopping receipt.  
    # Default is None; to receive forever.
    with client.get_queue_receiver(queue_name, max_wait_time=30) as receiver:
        for msg in receiver:  # ServiceBusReceiver instance is a generator.
            print(str(msg))
            # If it is desired to halt receiving early, one can break out of the loop here safely.

NOTE: Any message received with receive_mode=PEEK_LOCK (this is the default, with the alternative RECEIVE_AND_DELETE removing the message from the queue immediately on receipt) has a lock that must be renewed via receiver.renew_message_lock before it expires if processing would take longer than the lock duration. See AutoLockRenewer for a helper to perform this in the background automatically. Lock duration is set in Azure on the queue or topic itself.

Receive messages from a queue through ServiceBusReceiver.receive_messages()

NOTE: ServiceBusReceiver.receive_messages() receives a single or constrained list of messages through an ad-hoc method call, as opposed to receiving perpetually from the generator. It always returns a list.

from azure.servicebus import ServiceBusClient

import os
connstr = os.environ['SERVICE_BUS_CONNECTION_STR']
queue_name = os.environ['SERVICE_BUS_QUEUE_NAME']

with ServiceBusClient.from_connection_string(connstr) as client:
    with client.get_queue_receiver(queue_name) as receiver:
        received_message_array = receiver.receive_messages(max_wait_time=10)  # try to receive a single message within 10 seconds
        if received_message_array:
            print(str(received_message_array[0]))

    with client.get_queue_receiver(queue_name) as receiver:
        received_message_array = receiver.receive_messages(max_message_count=5, max_wait_time=10)  # try to receive maximum 5 messages in a batch within 10 seconds
        for message in received_message_array:
            print(str(message))

In this example, max_message_count declares the maximum number of messages to attempt receiving before hitting a max_wait_time as specified in seconds.

NOTE: It should also be noted that ServiceBusReceiver.peek_messages() is subtly different than receiving, as it does not lock the messages being peeked, and thus they cannot be settled.

Send and receive a message from a session enabled queue

NOTE: see reference documentation for session send and receive.

Sessions provide first-in-first-out and single-receiver semantics on top of a queue or subscription. While the actual receive syntax is the same, initialization differs slightly.

from azure.servicebus import ServiceBusClient, ServiceBusMessage

import os
connstr = os.environ['SERVICE_BUS_CONNECTION_STR']
queue_name = os.environ['SERVICE_BUS_QUEUE_NAME']
session_id = os.environ['SERVICE_BUS_SESSION_ID']

with ServiceBusClient.from_connection_string(connstr) as client:
    with client.get_queue_sender(queue_name) as sender:
        sender.send_messages(ServiceBusMessage("Session Enabled Message", session_id=session_id))

    # If session_id is null here, will receive from the first available session.
    with client.get_queue_receiver(queue_name, session_id=session_id) as receiver:
        for msg in receiver:
            print(str(msg))

NOTE: Messages received from a session do not need their locks renewed like a non-session receiver; instead the lock management occurs at the session level with a session lock that may be renewed with receiver.session.renew_lock()

Working with topics and subscriptions

NOTE: see reference documentation for topics and subscriptions.

Topics and subscriptions give an alternative to queues for sending and receiving messages. See documents here for more overarching detail, and of how these differ from queues.

from azure.servicebus import ServiceBusClient, ServiceBusMessage

import os
connstr = os.environ['SERVICE_BUS_CONNECTION_STR']
topic_name = os.environ['SERVICE_BUS_TOPIC_NAME']
subscription_name = os.environ['SERVICE_BUS_SUBSCRIPTION_NAME']

with ServiceBusClient.from_connection_string(connstr) as client:
    with client.get_topic_sender(topic_name) as sender:
        sender.send_messages(ServiceBusMessage("Data"))

    # If session_id is null here, will receive from the first available session.
    with client.get_subscription_receiver(topic_name, subscription_name) as receiver:
        for msg in receiver:
            print(str(msg))

Settle a message after receipt

When receiving from a queue, you have multiple actions you can take on the messages you receive.

NOTE: You can only settle ServiceBusReceivedMessage objects which are received in ServiceBusReceiveMode.PEEK_LOCK mode (this is the default). ServiceBusReceiveMode.RECEIVE_AND_DELETE mode removes the message from the queue on receipt. ServiceBusReceivedMessage messages returned from peek_messages() cannot be settled, as the message lock is not taken like it is in the aforementioned receive methods.

If the message has a lock as mentioned above, settlement will fail if the message lock has expired.
If processing would take longer than the lock duration, it must be maintained via receiver.renew_message_lock before it expires. Lock duration is set in Azure on the queue or topic itself. See AutoLockRenewer for a helper to perform this in the background automatically.

Complete

Declares the message processing to be successfully completed, removing the message from the queue.

from azure.servicebus import ServiceBusClient

import os
connstr = os.environ['SERVICE_BUS_CONNECTION_STR']
queue_name = os.environ['SERVICE_BUS_QUEUE_NAME']

with ServiceBusClient.from_connection_string(connstr) as client:
    with client.get_queue_receiver(queue_name) as receiver:
        for msg in receiver:
            print(str(msg))
            receiver.complete_message(msg)

Abandon

Abandon processing of the message for the time being, returning the message immediately back to the queue to be picked up by another (or the same) receiver.

from azure.servicebus import ServiceBusClient

import os
connstr = os.environ['SERVICE_BUS_CONNECTION_STR']
queue_name = os.environ['SERVICE_BUS_QUEUE_NAME']

with ServiceBusClient.from_connection_string(connstr) as client:
    with client.get_queue_receiver(queue_name) as receiver:
        for msg in receiver:
            print(str(msg))
            receiver.abandon_message(msg)

DeadLetter

Transfer the message from the primary queue into a special "dead-letter sub-queue" where it can be accessed using the ServiceBusClient.get_<queue|subscription>_receiver function with parameter sub_queue=ServiceBusSubQueue.DEAD_LETTER and consumed from like any other receiver. (see sample here)

from azure.servicebus import ServiceBusClient

import os
connstr = os.environ['SERVICE_BUS_CONNECTION_STR']
queue_name = os.environ['SERVICE_BUS_QUEUE_NAME']

with ServiceBusClient.from_connection_string(connstr) as client:
    with client.get_queue_receiver(queue_name) as receiver:
        for msg in receiver:
            print(str(msg))
            receiver.dead_letter_message(msg)

Defer

Defer is subtly different from the prior settlement methods. It prevents the message from being directly received from the queue by setting it aside such that it must be received by sequence number in a call to ServiceBusReceiver.receive_deferred_messages (see sample here)

from azure.servicebus import ServiceBusClient

import os
connstr = os.environ['SERVICE_BUS_CONNECTION_STR']
queue_name = os.environ['SERVICE_BUS_QUEUE_NAME']

with ServiceBusClient.from_connection_string(connstr) as client:
    with client.get_queue_receiver(queue_name) as receiver:
        for msg in receiver:
            print(str(msg))
            receiver.defer_message(msg)

Automatically renew Message or Session locks

NOTE: see reference documentation for auto-lock-renewal.

AutoLockRenewer is a simple method for ensuring your message or session remains locked even over long periods of time, if calling receiver.renew_message_lock/receiver.session.renew_lock is impractical or undesired. Internally, it is not much more than shorthand for creating a concurrent watchdog to do lock renewal if the object is nearing expiry. It should be used as follows:

• Message lock automatic renewing

from azure.servicebus import ServiceBusClient, AutoLockRenewer

import os
connstr = os.environ['SERVICE_BUS_CONNECTION_STR']
queue_name = os.environ['SERVICE_BUS_QUEUE_NAME']

# Can also be called via "with AutoLockRenewer() as renewer" to automate closing.
renewer = AutoLockRenewer()
with ServiceBusClient.from_connection_string(connstr) as client:
    with client.get_queue_receiver(queue_name) as receiver:
        for msg in receiver.receive_messages():
            renewer.register(receiver, msg, max_lock_renewal_duration=60)
            # Do your application logic here
            receiver.complete_message(msg)
renewer.close()

• Session lock automatic renewing

from azure.servicebus import ServiceBusClient, AutoLockRenewer

import os
connstr = os.environ['SERVICE_BUS_CONNECTION_STR']
session_queue_name = os.environ['SERVICE_BUS_SESSION_QUEUE_NAME']
session_id = os.environ['SERVICE_BUS_SESSION_ID']

# Can also be called via "with AutoLockRenewer() as renewer" to automate closing.
renewer = AutoLockRenewer()
with ServiceBusClient.from_connection_string(connstr) as client:
    with client.get_queue_receiver(session_queue_name, session_id=session_id) as receiver:
        renewer.register(receiver, receiver.session, max_lock_renewal_duration=300) # Duration for how long to maintain the lock for, in seconds.

        for msg in receiver.receive_messages():
            # Do your application logic here
            receiver.complete_message(msg)
renewer.close()

If for any reason auto-renewal has been interrupted or failed, this can be observed via the auto_renew_error property on the object being renewed, or by having passed a callback to the on_lock_renew_failure parameter on renewer initialization. It would also manifest when trying to take action (such as completing a message) on the specified object.

Troubleshooting

Logging

• Enable azure.servicebus logger to collect traces from the library.
• Enable uamqp logger to collect traces from the underlying uAMQP library.
• Enable AMQP frame level trace by setting logging_enable=True when creating the client.

Timeouts

There are various timeouts a user should be aware of within the library.

• 10 minute service side link closure: A link, once opened, will be closed after 10 minutes idle to protect the service against resource leakage. This should largely be transparent to a user, but if you notice a reconnect occurring after such a duration, this is why. Performing any operations, including management operations, on the link will extend this timeout.
• max_wait_time: Provided on creation of a receiver or when calling receive_messages(), the time after which receiving messages will halt after no traffic. This applies both to the imperative receive_messages() function as well as the length a generator-style receive will run for before exiting if there are no messages. Passing None (default) will wait forever, up until the 10 minute threshold if no other action is taken.

NOTE: If processing of a message or session is sufficiently long as to cause timeouts, as an alternative to calling receiver.renew_message_lock/receiver.session.renew_lock manually, one can leverage the AutoLockRenewer functionality detailed above.

Common Exceptions

The Service Bus APIs generate the following exceptions in azure.servicebus.exceptions:

• ServiceBusConnectionError: An error occurred in the connection to the service. This may have been caused by a transient network issue or service problem. It is recommended to retry.
• ServiceBusAuthorizationError: An error occurred when authorizing the connection to the service. This may have been caused by the credentials not having the right permission to perform the operation. It is recommended to check the permission of the credentials.
• ServiceBusAuthenticationError: An error occurred when authenticate the connection to the service. This may have been caused by the credentials being incorrect. It is recommended to check the credentials.
• OperationTimeoutError: This indicates that the service did not respond to an operation within the expected amount of time. This may have been caused by a transient network issue or service problem. The service may or may not have successfully completed the request; the status is not known. It is recommended to attempt to verify the current state and retry if necessary.
• MessageSizeExceededError: This indicate that the message content is larger than the service bus frame size. This could happen when too many service bus messages are sent in a batch or the content passed into the body of a Message is too large. It is recommended to reduce the count of messages being sent in a batch or the size of content being passed into a single ServiceBusMessage.
• MessageAlreadySettled: This indicates failure to settle the message. This could happen when trying to settle an already-settled message.
• MessageLockLostError: The lock on the message has expired and it has been released back to the queue. It will need to be received again in order to settle it. You should be aware of the lock duration of a message and keep renewing the lock before expiration in case of long processing time. AutoLockRenewer could help on keeping the lock of the message automatically renewed.
• SessionLockLostError: The lock on the session has expired. All unsettled messages that have been received can no longer be settled. It is recommended to reconnect to the session if receive messages again if necessary. You should be aware of the lock duration of a session and keep renewing the lock before expiration in case of long processing time. AutoLockRenewer could help on keeping the lock of the session automatically renewed.
• MessageNotFoundError: Attempt to receive a message with a particular sequence number. This message isn't found. Make sure the message hasn't been received already. Check the deadletter queue to see if the message has been deadlettered.
• MessagingEntityNotFoundError: Entity associated with the operation doesn't exist or it has been deleted. Please make sure the entity exists.
• MessagingEntityDisabledError: Request for a runtime operation on a disabled entity. Please Activate the entity.
• ServiceBusQuotaExceededError: The messaging entity has reached its maximum allowable size, or the maximum number of connections to a namespace has been exceeded. Create space in the entity by receiving messages from the entity or its subqueues.
• ServiceBusServerBusyError: Service isn't able to process the request at this time. Client can wait for a period of time, then retry the operation.
• ServiceBusCommunicationError: Client isn't able to establish a connection to Service Bus. Make sure the supplied host name is correct and the host is reachable. If your code runs in an environment with a firewall/proxy, ensure that the traffic to the Service Bus domain/IP address and ports isn't blocked.
• SessionCannotBeLockedError: Attempt to connect to a session with a specific session ID, but the session is currently locked by another client. Make sure the session is unlocked by other clients.
• AutoLockRenewFailed: An attempt to renew a lock on a message or session in the background has failed. This could happen when the receiver used by AutoLockRenerer is closed or the lock of the renewable has expired. It is recommended to re-register the renewable message or session by receiving the message or connect to the sessionful entity again.
• AutoLockRenewTimeout: The time allocated to renew the message or session lock has elapsed. You could re-register the object that wants be auto lock renewed or extend the timeout in advance.
• ServiceBusError: All other Service Bus related errors. It is the root error class of all the errors described above.

Please view the exceptions reference docs for detailed descriptions of our common Exception types.

Next steps

More sample code

Please find further examples in the samples directory demonstrating common Service Bus scenarios such as sending, receiving, session management and message handling.

Additional documentation

For more extensive documentation on the Service Bus service, see the Service Bus documentation on docs.microsoft.com.

Management capabilities and documentation

For users seeking to perform management operations against ServiceBus (Creating a queue/topic/etc, altering filter rules, enumerating entities) please see the azure-mgmt-servicebus documentation for API documentation. Terse usage examples can be found here as well.

Building uAMQP wheel from source

azure-servicebus depends on the uAMQP for the AMQP protocol implementation. uAMQP wheels are provided for most major operating systems and will be installed automatically when installing azure-servicebus.

If you're running on a platform for which uAMQP wheels are not provided, please follow the uAMQP Installation guidance to install from source.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Release History

7.1.1 (2021-04-07)

This version and all future versions will require Python 2.7 or Python 3.6+, Python 3.5 is no longer supported.

New Features

• Updated forward_to and forward_dead_lettered_messages_to parameters in create_queue, update_queue, create_subscription, and update_subscription methods on sync and async ServiceBusAdministrationClient to accept entities as well, rather than only full paths. In the case that an entity is passed in, it is assumed that the entity exists within the same namespace used for constructing the ServiceBusAdministrationClient.

Bug Fixes

• Updated uAMQP dependency to 1.3.0.
  • Fixed bug that sending message of large size triggering segmentation fault when the underlying socket connection is lost (#13739, #14543).
  • Fixed bug in link flow control where link credit and delivery count should be calculated based on per message instead of per transfer frame (#16934).

7.1.0 (2021-03-09)

This version will be the last version to officially support Python 3.5, future versions will require Python 2.7 or Python 3.6+.

New Features

• Updated the following methods so that lists and single instances of Mapping representations are accepted for corresponding strongly-typed object arguments (PR #14807, thanks @bradleydamato):
  • update_queue, update_topic, update_subscription, and update_rule on ServiceBusAdministrationClient accept Mapping representations of QueueProperties, TopicProperties, SubscriptionProperties, and RuleProperties, respectively.
  • send_messages and schedule_messages on both sync and async versions of ServiceBusSender accept a list of or single instance of Mapping representations of ServiceBusMessage.
  • add_message on ServiceBusMessageBatch now accepts a Mapping representation of ServiceBusMessage.

BugFixes

• Operations failing due to uamqp.errors.LinkForceDetach caused by no activity on the connection for 10 minutes will now be retried internally except for the session receiver case.
• uamqp.errors.AMQPConnectionError errors with condition code amqp:unknown-error are now categorized into ServiceBusConnectionError instead of the general ServiceBusError.
• The update_* methods on ServiceBusManagementClient will now raise a TypeError rather than an AttributeError in the case of unsupported input type.

7.0.1 (2021-01-12)

BugFixes

• forward_to and forward_dead_lettered_messages_to will no longer cause authorization errors when used in ServiceBusAdministrationClient for queues and subscriptions (#15543).
• Updated uAMQP dependency to 1.2.13.
  • Fixed bug that macOS was unable to detect network error (#15473).
  • Fixed bug that uamqp.ReceiveClient and uamqp.ReceiveClientAsync receive messages during connection establishment (#15555).
  • Fixed bug where connection establishment on macOS with Clang 12 triggering unrecognized selector exception (#15567).
  • Fixed bug in accessing message properties triggering segmentation fault when the underlying C bytes are NULL (#15568).

7.0.0 (2020-11-23)

Note: This is the GA release of the azure-servicebus package, rolling out the official API surface area constructed over the prior preview releases. Users migrating from v0.50 are advised to view the migration guide.

New Features

• sub_queue and receive_mode may now be passed in as a valid string (as defined by their respective enum type) as well as their enum form when constructing ServiceBusReceiver.
• Added support for Distributed Tracing of send, receive, and schedule scenarios.

Breaking Changes

• ServiceBusSender and ServiceBusReceiver are no longer reusable and will raise ValueError when trying to operate on a closed handler.
• Rename ReceiveMode to ServiceBusReceiveMode and SubQueue to ServiceBusSubQueue, and convert their enum values from ints to human-readable strings.
• Rename enum values DeadLetter to DEAD_LETTER, TransferDeadLetter to TRANSFER_DEAD_LETTER, PeekLock to PEEK_LOCK and ReceiveAndDelete to RECEIVE_AND_DELETE to conform to sdk guidelines going forward.
• send_messages, schedule_messages, cancel_scheduled_messages and receive_deferred_messages now performs a no-op rather than raising a ValueError if provided an empty list of messages or an empty batch.
• ServiceBusMessage.amqp_annotated_message has been renamed to ServiceBusMessage.raw_amqp_message to normalize with other SDKs.
• Redesigned error hierarchy based on the service-defined error condition:
  • MessageAlreadySettled now inherits from ValueError instead of ServiceBusMessageError as it's a client-side validation.
  • Removed NoActiveSession which is now replaced by OperationTimeoutError as the client times out when trying to connect to any available session.
  • Removed ServiceBusMessageError as error condition based exceptions provide comprehensive error information.
  • Removed MessageSettleFailed as error condition based exceptions provide comprehensive error information.
  • Removed MessageSendFailed as error condition based exceptions provide comprehensive error information.
  • Renamed MessageContentTooLarge to MessageSizeExceededError to be consistent with the term defined by the service.
  • Renamed MessageLockExpired to MessageLockLostError to be consistent with the term defined by the service.
  • Renamed SessionLockExpired to SessionLockLostError to be consistent with the term defined by the service.
  • Introduced MessageNotFoundError which would be raised when the requested message was not found.
  • Introduced MessagingEntityNotFoundError which would be raised when a Service Bus resource cannot be found by the Service Bus service.
  • Introduced MessagingEntityDisabledError which would be raised when the Messaging Entity is disabled.
  • Introduced MessagingEntityAlreadyExistsError which would be raised when an entity with the same name exists under the same namespace.
  • Introduced ServiceBusQuotaExceededError which would be raised when a Service Bus resource has been exceeded while interacting with the Azure Service Bus service.
  • Introduced ServiceBusServerBusyError which would be raised when the Azure Service Bus service reports that it is busy in response to a client request to perform an operation.
  • Introduced ServiceBusCommunicationError which would be raised when there was a general communications error encountered when interacting with the Azure Service Bus service.
  • Introduced SessionCannotBeLockedError which would be raised when the requested session cannot be locked.
• Introduced new client side validation on certain use cases:
  • ServiceBusMessage will now raise a TypeError when provided an invalid body type. Valid bodies are strings, bytes, and None. Lists are no longer accepted, as they simply concatenated the contents prior.
  • An improper receive_mode value will now raise ValueError instead of TypeError in line with supporting extensible enums.
  • Setting ServiceBusMessage.partition_key to a value different than session_id on the message instance now raises ValueError.
  • ServiceBusClient.get_queue/topic_sender and ServiceBusClient.get_queue/subscription_receiver will now raise ValueError if the queue_name or topic_name does not match the EntityPath in the connection string used to construct the ServiceBusClient.
  • Settling a message that has been peeked will raise ValueError.
  • Settling a message or renewing a lock on a message received in RECEIVE_AND_DELETE receive mode will raise ValueError.
  • Setting session_id, reply_to_session_id, message_id and partition_key on ServiceBusMessage longer than 128 characters will raise ValueError.
• ServiceBusReceiver.get_streaming_message_iter has been made internal for the time being to assess use patterns before committing to back-compatibility; messages may still be iterated over in equivalent fashion by iterating on the receiver itself.

BugFixes

• ServiceBusAdministrationClient.create_rule by default now creates a TrueRuleFilter rule.
• FQDNs and Connection strings are now supported even with strippable whitespace or protocol headers (e.g. 'sb://').
• Using parameter auto_lock_renewer on a sessionful receiver alongside ReceiveMode.ReceiveAndDelete will no longer fail during receipt due to failure to register the message with the renewer.

7.0.0b8 (2020-11-05)

New Features

• Added support for timeout parameter on the following operations:
  • ServiceBusSender: send_messages, schedule_messages and cancel_scheduled_messages
  • ServiceBusReceiver: receive_deferred_messages, peek_messages and renew_message_lock
  • ServiceBusSession: get_state, set_state and renew_lock
• azure.servicebus.exceptions.ServiceBusError now inherits from azure.core.exceptions.AzureError.
• Added a parse_connection_string method which parses a connection string into a properties bag containing its component parts
• Add support for auto_lock_renewer parameter on get_queue_receiver and get_subscription_receiver calls to allow auto-registration of messages and sessions for auto-renewal.

Breaking Changes

• Renamed AutoLockRenew to AutoLockRenewer.
• Removed class ServiceBusSessionReceiver which is now unified within class ServiceBusReceiver.
  • Removed methods ServiceBusClient.get_queue_session_receiver and ServiceBusClient.get_subscription_session_receiver.
  • ServiceBusClient.get_queue_receiver and ServiceBusClient.get_subscription_receiver now take keyword parameter session_id which must be set when getting a receiver for the sessionful entity.
• The parameter inner_exception that ServiceBusError.__init__ takes is now renamed to error.
• Renamed azure.servicebus.exceptions.MessageError to azure.servicebus.exceptions.ServiceBusMessageError
• Removed error azure.servicebus.exceptions.ServiceBusResourceNotFound as azure.core.exceptions.ResourceNotFoundError is now raised when a Service Bus resource does not exist when using the ServiceBusAdministrationClient.
• Renamed Message to ServiceBusMessage.
• Renamed ReceivedMessage to ServiceBusReceivedMessage.
• Renamed BatchMessage to ServiceBusMessageBatch.
  • Renamed method add to add_message on the class.
• Removed class PeekedMessage.
• Removed class ReceivedMessage under module azure.servicebus.aio.
• Renamed ServiceBusSender.create_batch to ServiceBusSender.create_message_batch.
• Exceptions MessageSendFailed, MessageSettleFailed and MessageLockExpired now inherit from azure.servicebus.exceptions.ServiceBusMessageError.
• get_state in ServiceBusSession now returns bytes instead of a string.
• ServiceBusReceiver.receive_messages/get_streaming_message_iter and ServiceBusClient.get_<queue/subscription>_receiver now raises ValueError if the given max_wait_time is less than or equal to 0.
• Message settlement methods are moved from ServiceBusMessage to ServiceBusReceiver:
  • Use ServiceBusReceiver.complete_message instead of ServiceBusReceivedMessage.complete to complete a message.
  • Use ServiceBusReceiver.abandon_message instead of ServiceBusReceivedMessage.abandon to abandon a message.
  • Use ServiceBusReceiver.defer_message instead of ServiceBusReceivedMessage.defer to defer a message.
  • Use ServiceBusReceiver.dead_letter_message instead of ServiceBusReceivedMessage.dead_letter to dead letter a message.
• Message settlement methods (complete_message, abandon_message, defer_message and dead_letter_message) and methods that use amqp management link for request like schedule_messages, received_deferred_messages, etc. now raise more concrete exception other than MessageSettleFailed and ServiceBusError.
• Message renew_lock method is moved from ServiceBusMessage to ServiceBusReceiver:
  • Changed ServiceBusReceivedMessage.renew_lock to ServiceBusReceiver.renew_message_lock
• AutoLockRenewer.register now takes ServiceBusReceiver as a positional parameter.
• Removed encoding support from ServiceBusMessage.
• ServiceBusMessage.amqp_message has been renamed to ServiceBusMessage.amqp_annotated_message for cross-sdk consistency.
• All name parameters in ServiceBusAdministrationClient are now precisely specified ala queue_name or rule_name
• ServiceBusMessage.via_partition_key is no longer exposed, this is pending a full implementation of transactions as it has no external use. If needed, the underlying value can still be accessed in ServiceBusMessage.amqp_annotated_message.annotations.
• ServiceBusMessage.properties has been renamed to ServiceBusMessage.application_properties for consistency with service verbiage.
• Sub-client (ServiceBusSender and ServiceBusReceiver) from_connection_string initializers have been made internal until needed. Clients should be initialized from root ServiceBusClient.
• ServiceBusMessage.label has been renamed to ServiceBusMessage.subject.
• ServiceBusMessage.amqp_annotated_message has had its type renamed from AMQPMessage to AMQPAnnotatedMessage
• AutoLockRenewer timeout parameter is renamed to max_lock_renew_duration
• Attempting to autorenew a non-renewable message, such as one received in ReceiveAndDelete mode, or configure auto-autorenewal on a ReceiveAndDelete receiver, will raise a ValueError.
• The default value of parameter max_message_count on ServiceBusReceiver.receive_messages is now 1 instead of None and will raise ValueError if the given value is less than or equal to 0.

BugFixes

• Updated uAMQP dependency to 1.2.12.
  • Added support for Python 3.9.
  • Fixed bug where amqp message footer and delivery_annotation were not encoded into the outgoing payload.

7.0.0b7 (2020-10-05)

Breaking Changes

• Passing any type other than ReceiveMode as parameter receive_mode now throws a TypeError instead of AttributeError.
• Administration Client calls now take only entity names, not <Entity>Descriptions as well to reduce ambiguity in which entity was being acted on. TypeError will now be thrown on improper parameter types (non-string).
• AMQPMessage (Message.amqp_message) properties are now read-only, changes of these properties would not be reflected in the underlying message. This may be subject to change before GA.

7.0.0b6 (2020-09-10)

New Features

• renew_lock() now returns the UTC datetime that the lock is set to expire at.
• receive_deferred_messages() can now take a single sequence number as well as a list of sequence numbers.
• Messages can now be sent twice in succession.
• Connection strings used with from_connection_string methods now support using the SharedAccessSignature key in leiu of sharedaccesskey and sharedaccesskeyname, taking the string of the properly constructed token as value.
• Internal AMQP message properties (header, footer, annotations, properties, etc) are now exposed via Message.amqp_message

Breaking Changes

• Renamed prefetch to prefetch_count.
• Renamed ReceiveSettleMode enum to ReceiveMode, and respectively the mode parameter to receive_mode.
• retry_total, retry_backoff_factor and retry_backoff_max are now defined at the ServiceBusClient level and inherited by senders and receivers created from it.
• No longer export NEXT_AVAILABLE in azure.servicebus module. A null session_id will suffice.
• Renamed parameter message_count to max_message_count as fewer messages may be present for method peek_messages() and receive_messages().
• Renamed PeekMessage to PeekedMessage.
• Renamed get_session_state() and set_session_state() to get_state() and set_state() accordingly.
• Renamed parameter description to error_description for method dead_letter().
• Renamed properties created_time and modified_time to created_at_utc and modified_at_utc within AuthorizationRule and NamespaceProperties.
• Removed parameter requires_preprocessing from SqlRuleFilter and SqlRuleAction.
• Removed property namespace_type from NamespaceProperties.
• Rename ServiceBusManagementClient to ServiceBusAdministrationClient
• Attempting to call send_messages on something not a Message, BatchMessage, or list of Messages, will now throw a TypeError instead of ValueError
• Sending a message twice will no longer result in a MessageAlreadySettled exception.
• ServiceBusClient.close() now closes spawned senders and receivers.
• Attempting to initialize a sender or receiver with a different connection string entity and specified entity (e.g. queue_name) will result in an AuthenticationError
• Remove is_anonymous_accessible from management entities.
• Remove support_ordering from create_queue and QueueProperties
• Remove enable_subscription_partitioning from create_topic and TopicProperties
• get_dead_letter_[queue,subscription]_receiver() has been removed. To connect to a dead letter queue, utilize the sub_queue parameter of get_[queue,subscription]_receiver() provided with a value from the SubQueue enum
• No longer export ServiceBusSharedKeyCredential
• Rename entity_availability_status to availability_status

7.0.0b5 (2020-08-10)

New Features

• Added new properties to Message, PeekMessage and ReceivedMessage: content_type, correlation_id, label, message_id, reply_to, reply_to_session_id and to. Please refer to the docstring for further information.
• Added new properties to PeekMessage and ReceivedMessage: enqueued_sequence_number, dead_letter_error_description, dead_letter_reason, dead_letter_source, delivery_count and expires_at_utc. Please refer to the docstring for further information.
• Added support for sending received messages via ServiceBusSender.send_messages.
• Added on_lock_renew_failure as a parameter to AutoLockRenew.register, taking a callback for when the lock is lost non-intentially (e.g. not via settling, shutdown, or autolockrenew duration completion).
• Added new supported value types int, float, datetime and timedelta for CorrelationFilter.properties.
• Added new properties parameters and requires_preprocessing to SqlRuleFilter and SqlRuleAction.
• Added an explicit method to fetch the continuous receiving iterator, get_streaming_message_iter() such that max_wait_time can be specified as an override.

Breaking Changes

• Removed/Renamed several properties and instance variables on Message (the changes applied to the inherited Message type PeekMessage and ReceivedMessage).
  • Renamed property user_properties to properties
    • The original instance variable properties which represents the AMQP properties now becomes an internal instance variable _amqp_properties.
  • Removed property enqueue_sequence_number.
  • Removed property annotations.
  • Removed instance variable header.
• Removed several properties and instance variables on PeekMessage and ReceivedMessage.
  • Removed property partition_id on both type.
  • Removed property settled on both type.
  • Removed instance variable received_timestamp_utc on both type.
  • Removed property settled on PeekMessage.
  • Removed property expired on ReceivedMessage.
• AutoLockRenew.sleep_time and AutoLockRenew.renew_period have been made internal as _sleep_time and _renew_period respectively, as it is not expected a user will have to interact with them.
• AutoLockRenew.shutdown is now AutoLockRenew.close to normalize with other equivalent behaviors.
• Renamed QueueDescription, TopicDescription, SubscriptionDescription and RuleDescription to QueueProperties, TopicProperties, SubscriptionProperties, and RuleProperties.
• Renamed QueueRuntimeInfo, TopicRuntimeInfo, and SubscriptionRuntimeInfo to QueueRuntimeProperties, TopicRuntimeProperties, and SubscriptionRuntimeProperties.
• Removed param queue from create_queue, topic from create_topic, subscription from create_subscription and rule from create_rule of ServiceBusManagementClient. Added param name to them and keyword arguments for queue properties, topic properties, subscription properties and rule properties.
• Removed model class attributes related keyword arguments from update_queue and update_topic of ServiceBusManagementClient. This is to encourage utilizing the model class instance instead as returned from a create_*, list_* or get_* operation to ensure it is properly populated. Properties may still be modified.
• Model classes QueueProperties, TopicProperties, SubscriptionProperties and RuleProperties require all arguments to be present for creation. This is to protect against lack of partial updates by requiring all properties to be specified.
• Renamed idle_timeout in get_<queue/subscription>_receiver() to max_wait_time to normalize with naming elsewhere.
• Updated uAMQP dependency to 1.2.10 such that the receiver does not shut down when generator times out, and can be received from again.

7.0.0b4 (2020-07-06)

New Features

• Added support for management of topics, subscriptions, and rules.
• receive_messages() (formerly receive()) now supports receiving a batch of messages (max_batch_size > 1) without the need to set prefetch parameter during ServiceBusReceiver initialization.

BugFixes

• Fixed bug where sync AutoLockRenew does not shutdown itself timely.
• Fixed bug where async AutoLockRenew does not support context manager.

Breaking Changes

• Renamed receive(), peek() schedule() and send() to receive_messages(), peek_messages(), schedule_messages() and send_messages() to align with other service bus SDKs.
• receive_messages() (formerly receive()) no longer raises a ValueError if max_batch_size is less than the prefetch parameter set during ServiceBusReceiver initialization.

7.0.0b3 (2020-06-08)

New Features

• Added support for management of queue entities.
  • Use azure.servicebus.management.ServiceBusManagementClient (azure.servicebus.management.aio.ServiceBusManagementClient for aio) to create, update, delete, list queues and get settings as well as runtime information of queues under a ServiceBus namespace.
• Added methods get_queue_deadletter_receiver and get_subscription_deadletter_receiver in ServiceBusClient to get a ServiceBusReceiver for the dead-letter sub-queue of the target entity.

BugFixes

• Updated uAMQP dependency to 1.2.8.
  • Fixed bug where reason and description were not being set when dead-lettering messages.

7.0.0b2 (2020-05-04)

New Features

• Added method get_topic_sender in ServiceBusClient to get a ServiceBusSender for a topic.
• Added method get_subscription_receiver in ServiceBusClient to get a ServiceBusReceiver for a subscription under specific topic.
• Added support for scheduling messages and scheduled message cancellation.
  • Use ServiceBusSender.schedule(messages, schedule_time_utc) for scheduling messages.
  • Use ServiceBusSender.cancel_scheduled_messages(sequence_numbers) for scheduled messages cancellation.
• ServiceBusSender.send() can now send a list of messages in one call, if they fit into a single batch. If they do not fit a ValueError is thrown.
• BatchMessage.add() and ServiceBusSender.send() would raise MessageContentTooLarge if the content is over-sized.
• ServiceBusReceiver.receive() raises ValueError if its param max_batch_size is greater than param prefetch of ServiceBusClient.
• Added exception classes MessageError, MessageContentTooLarge, ServiceBusAuthenticationError.
  • MessageError: when you send a problematic message, such as an already sent message or an over-sized message.
  • MessageContentTooLarge: when you send an over-sized message. A subclass of ValueError and MessageError.
  • ServiceBusAuthenticationError: on failure to be authenticated by the service.
• Removed exception class InvalidHandlerState.

BugFixes

• Fixed bug where http_proxy and transport_type in ServiceBusClient are not propagated into Sender/Receiver creation properly.
• Updated uAMQP dependency to 1.2.7.
  • Fixed bug in setting certificate of tlsio on MacOS. #7201
  • Fixed bug that caused segmentation fault in network tracing on MacOS when setting logging_enable to True in ServiceBusClient.

Breaking Changes

• Session receivers are now created via their own top level functions, e.g. get_queue_sesison_receiver and get_subscription_session_receiver. Non session receivers no longer take session_id as a paramter.
• ServiceBusSender.send() no longer takes a timeout parameter, as it should be redundant with retry options provided when creating the client.
• Exception imports have been removed from module azure.servicebus. Import from azure.servicebus.exceptions instead.
• ServiceBusSender.schedule() has swapped the ordering of parameters schedule_time_utc and messages for better consistency with send() syntax.

7.0.0b1 (2020-04-06)

Version 7.0.0b1 is a preview of our efforts to create a client library that is user friendly and idiomatic to the Python ecosystem. The reasons for most of the changes in this update can be found in the Azure SDK Design Guidelines for Python. For more information, please visit https://aka.ms/azure-sdk-preview1-python.

• Note: Not all historical functionality exists in this version at this point. Topics, Subscriptions, scheduling, dead_letter management and more will be added incrementally over upcoming preview releases.

New Features

• Added new configuration parameters when creating ServiceBusClient.
  • credential: The credential object used for authentication which implements TokenCredential interface of getting tokens.
  • http_proxy: A dictionary populated with proxy settings.
  • For detailed information about configuration parameters, please see docstring in ServiceBusClient and/or the reference documentation for more information.
• Added support for authentication using Azure Identity credentials.
• Added support for retry policy.
• Added support for http proxy.
• Manually calling reconnect should no longer be necessary, it is now performed implicitly.
• Manually calling open should no longer be necessary, it is now performed implicitly.
  • Note: close()-ing is still required if a context manager is not used, to avoid leaking connections.
• Added support for sending a batch of messages destined for heterogenous sessions.

Breaking changes

• Simplified API and set of clients
  • get_queue no longer exists, utilize get_queue_sender/receiver instead.
  • peek and other queue_client functions have moved to their respective sender/receiver.
  • Renamed fetch_next to receive.
  • Renamed session to session_id to normalize naming when requesting a receiver against a given session.
  • reconnect no longer exists, and is performed implicitly if needed.
  • open no longer exists, and is performed implicitly if needed.
• Normalized top level client parameters with idiomatic and consistent naming.
  • Renamed debug in ServiceBusClient initializer to logging_enable.
  • Renamed service_namespace in ServiceBusClient initializer to fully_qualified_namespace.
• New error hierarchy, with more specific semantics
  • azure.servicebus.exceptions.ServiceBusError
  • azure.servicebus.exceptions.ServiceBusConnectionError
  • azure.servicebus.exceptions.ServiceBusResourceNotFound
  • azure.servicebus.exceptions.ServiceBusAuthorizationError
  • azure.servicebus.exceptions.NoActiveSession
  • azure.servicebus.exceptions.OperationTimeoutError
  • azure.servicebus.exceptions.InvalidHandlerState
  • azure.servicebus.exceptions.AutoLockRenewTimeout
  • azure.servicebus.exceptions.AutoLockRenewFailed
  • azure.servicebus.exceptions.EventDataSendError
  • azure.servicebus.exceptions.MessageSendFailed
  • azure.servicebus.exceptions.MessageLockExpired
  • azure.servicebus.exceptions.MessageSettleFailed
  • azure.servicebus.exceptions.MessageAlreadySettled
  • azure.servicebus.exceptions.SessionLockExpired
• BatchMessage creation is now initiated via create_batch on a Sender, using add() on the batch to add messages, in order to enforce service-side max batch sized limitations.
• Session is now set on the message itself, via session_id parameter or property, as opposed to on Send or get_sender via session. This is to allow sending a batch of messages destined to varied sessions.
• Session management is now encapsulated within a property of a receiver, e.g. receiver.session, to better compartmentalize functionality specific to sessions.
  • To use AutoLockRenew against sessions, one would simply pass the inner session object, instead of the receiver itself.

0.50.2 (2019-12-09)

New Features

• Added support for delivery tag lock tokens

BugFixes

• Fixed bug where Message would pass through invalid kwargs on init when attempting to thread through subject.
• Increments UAMQP dependency min version to 1.2.5, to include a set of fixes, including handling of large messages and mitigation of segfaults.

0.50.1 (2019-06-24)

BugFixes

• Fixed bug where enqueued_time and scheduled_enqueue_time of message being parsed as local timestamp rather than UTC.

0.50.0 (2019-01-17)

Breaking changes

• Introduces new AMQP-based API.
• Original HTTP-based API still available under new namespace: azure.servicebus.control_client
• For full API changes, please see updated reference documentation.

Within the new namespace, the original HTTP-based API from version 0.21.1 remains unchanged (i.e. no additional features or bugfixes) so for those intending to only use HTTP operations - there is no additional benefit in updating at this time.

New Features

• New API supports message send and receive via AMQP with improved performance and stability.
• New asynchronous APIs (using asyncio) for send, receive and message handling.
• Support for message and session auto lock renewal via background thread or async operation.
• Now supports scheduled message cancellation.

0.21.1 (2017-04-27)

This wheel package is now built with the azure wheel extension

0.21.0 (2017-01-13)

New Features

• str messages are now accepted in Python 3 and will be encoded in 'utf-8' (will not raise TypeError anymore)
• broker_properties can now be defined as a dict, and not only a JSON str. datetime, int, float and boolean are converted.
• #902 add send_topic_message_batch operation (takes an iterable of messages)
• #902 add send_queue_message_batch operation (takes an iterable of messages)

Bugfixes

• #820 the code is now more robust to unexpected changes on the SB RestAPI

0.20.3 (2016-08-11)

News

• #547 Add get dead letter path static methods to Python
• #513 Add renew lock

Bugfixes

• #628 Fix custom properties with double quotes

0.20.2 (2016-06-28)

Bugfixes

• New header in Rest API which breaks the SDK #658 #657

0.20.1 (2015-09-14)

News

• Create a requests.Session() if the user doesn't pass one in.

0.20.0 (2015-08-31)

Initial release of this package, from the split of the azure package. See the azure package release note for 1.0.0 for details and previous history on Service Bus.