Microsoft Azure Service Bus SDK for Python¶
NOTE: With the GA release of version 7.0.0, this package has been deprecated. Users can transition to the current version by installing or upgrading via
pip install azure-servicebusand reviewing our migration guide
This is the Microsoft Azure Service Bus Client Library. This package has been tested with Python 2.7, 3.4, 3.5, 3.6 and 3.7.
Microsoft Azure Service Bus supports a set of cloud-based, message-oriented middleware technologies including reliable message queuing and durable publish/subscribe messaging.
What’s new in v0.50.3?¶
As of version 0.50.3 a new AMQP-based API is available for sending and receiving messages. This update involves breaking changes. Please read Migration from 0.21.1 to 0.50.3 to determine if upgrading is right for you at this time.
The new AMQP-based API offers improved message passing reliability, performance and expanded feature support going forward. The new API also offers support for asynchronous operations (based on asyncio) for sending, receiving and handling messages.
For documentation on the legacy HTTP-based operations please see Using HTTP-based operations of the legacy API.
pip install azure-servicebus
Migration from 0.21.1 to 0.50.3¶
Major breaking changes were introduced in version 0.50.3.
The original HTTP-based API is still available in v0.50.3 - however it now exists under a new namesapce:
Should I upgrade?¶
The new package (v0.50.3) offers no improvements in HTTP-based operations over v0.21.1. The HTTP-based API is identical except that it now
exists under a new namespace. For this reason if you only wish to use HTTP-based operations (
delete_queue etc) - there will be
no additional benefit in upgrading at this time.
How do I migrate my code to the new version?¶
Code written against v0.21.0 can be ported to version 0.50.3 by simply changing the import namespace:
# from azure.servicebus import ServiceBusService <- This will now raise an ImportError from azure.servicebus.control_client import ServiceBusService key_name = 'RootManageSharedAccessKey' # SharedAccessKeyName from Azure portal key_value = '' # SharedAccessKey from Azure portal sbs = ServiceBusService(service_namespace, shared_access_key_name=key_name, shared_access_key_value=key_value)
If you encounter any bugs or have suggestions, please file an issue in the Issues section of the project.
Indices and tables¶
- azure.servicebus package
- azure.servicebus.aio package
- azure.servicebus.common package
- azure.servicebus.control_client package
- azure.servicebus.base_handler module
- azure.servicebus.receive_handler module
- azure.servicebus.send_handler module
- azure.servicebus.servicebus_client module