Microsoft Azure SDK for Python

This is the Microsoft Azure Service Bus Management Client Library. This package has been tested with Python 3.9+. For a more complete view of Azure libraries, see the azure sdk python release.

Disclaimer

Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691

Getting started

Prerequisites

Python 3.9+ is required to use this package.
Azure subscription

Install the package

pip install azure-mgmt-servicebus
pip install azure-identity

Authentication

By default, Azure Active Directory token authentication depends on correct configuration of the following environment variables.

AZURE_CLIENT_ID for Azure client ID.
AZURE_TENANT_ID for Azure tenant ID.
AZURE_CLIENT_SECRET for Azure client secret.

In addition, Azure subscription ID can be configured via environment variable AZURE_SUBSCRIPTION_ID.

With above configuration, client can be authenticated by following code:

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

sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = ServiceBusManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)

Examples

Code samples for this package can be found at:

Search Service Bus Management on docs.microsoft.com
Azure Python Mgmt SDK Samples Repo

Troubleshooting

Next steps

Provide Feedback

If you encounter any bugs or have suggestions, please file an issue in the Issues section of the project.

Release History

9.0.0 (2025-04-22)

Breaking Changes

Removed subfolders of some unused Api-Versions for smaller package size. If your application requires a specific and non-latest Api-Version, it's recommended to pin this package to the previous released version; If your application always only use latest Api-Version, please ignore this change.
Removed operation group EventHubsOperations
Removed operation group PremiumMessagingRegionsOperations
Removed operation group RegionsOperations

8.2.1 (2024-11-05)

Other Changes

Update dependencies

8.2.0 (2023-02-15)

Features Added

Model SBNamespace has a new parameter premium_messaging_partitions

8.1.0 (2022-08-10)

Features Added

Model SBNamespace has a new parameter minimum_tls_version
Model SBNamespace has a new parameter public_network_access

8.0.0 (2022-08-08)

Features

Model ArmDisasterRecovery has a new parameter location
Model MigrationConfigProperties has a new parameter location
Model NetworkRuleSet has a new parameter location
Model Operation has a new parameter is_data_action
Model Operation has a new parameter origin
Model Operation has a new parameter properties
Model OperationDisplay has a new parameter description
Model PrivateEndpointConnection has a new parameter location
Model Rule has a new parameter location
Model SBAuthorizationRule has a new parameter location
Model SBNamespace has a new parameter alternate_name
Model SBNamespaceUpdateParameters has a new parameter alternate_name
Model SBQueue has a new parameter location
Model SBSubscription has a new parameter location
Model SBTopic has a new parameter location

Breaking changes

Model SBNamespaceUpdateParameters no longer has parameter zone_redundant

7.1.0 (2021-09-23)

Features

Model NetworkRuleSet has a new parameter public_network_access
Model NetworkRuleSet has a new parameter trusted_service_access_enabled
Model SBQueue has a new parameter max_message_size_in_kilobytes
Model SBTopic has a new parameter max_message_size_in_kilobytes
Model SBNamespace has a new parameter status
Model SBNamespace has a new parameter disable_local_auth
Model SBSubscription has a new parameter is_client_affine
Model SBSubscription has a new parameter client_affine_properties
Model SBNamespaceUpdateParameters has a new parameter status
Model SBNamespaceUpdateParameters has a new parameter disable_local_auth

7.0.0 (2021-08-19)

Features

Model Rule has a new parameter system_data
Model SBNamespaceUpdateParameters has a new parameter private_endpoint_connections
Model PrivateEndpointConnection has a new parameter system_data
Model SBTopic has a new parameter system_data
Model Identity has a new parameter user_assigned_identities
Model SBNamespace has a new parameter system_data
Model SBNamespace has a new parameter private_endpoint_connections
Model Encryption has a new parameter require_infrastructure_encryption
Model SBAuthorizationRule has a new parameter system_data
Model SBSubscription has a new parameter system_data
Model KeyVaultProperties has a new parameter key_version
Model KeyVaultProperties has a new parameter identity
Model ArmDisasterRecovery has a new parameter system_data
Model NetworkRuleSet has a new parameter system_data
Model SBQueue has a new parameter system_data
Model MigrationConfigProperties has a new parameter system_data
Added operation NamespacesOperations.list_network_rule_sets

Breaking changes

Parameter id of model Subnet is now required
Removed operation NamespacesOperations.list_virtual_network_rules
Removed operation NamespacesOperations.migrate
Removed operation NamespacesOperations.delete_ip_filter_rule
Removed operation NamespacesOperations.get_virtual_network_rule
Removed operation NamespacesOperations.create_or_update_ip_filter_rule
Removed operation NamespacesOperations.delete_virtual_network_rule
Removed operation NamespacesOperations.get_ip_filter_rule
Removed operation NamespacesOperations.list_ip_filter_rules
Removed operation NamespacesOperations.create_or_update_virtual_network_rule

6.0.0 (2020-11-23)

Features

Model SBNamespaceUpdateParameters has a new parameter zone_redundant
Model SBNamespaceUpdateParameters has a new parameter identity
Model SBNamespaceUpdateParameters has a new parameter encryption
Model SBNamespace has a new parameter zone_redundant
Model SBNamespace has a new parameter identity
Model SBNamespace has a new parameter encryption
Added operation NamespacesOperations.get_ip_filter_rule
Added operation NamespacesOperations.list_ip_filter_rules
Added operation NamespacesOperations.delete_virtual_network_rule
Added operation NamespacesOperations.list_virtual_network_rules
Added operation NamespacesOperations.get_virtual_network_rule
Added operation NamespacesOperations.create_or_update_ip_filter_rule
Added operation NamespacesOperations.delete_ip_filter_rule
Added operation NamespacesOperations.create_or_update_virtual_network_rule
Added operation group PrivateLinkResourcesOperations
Added operation group PrivateEndpointConnectionsOperations

Breaking changes

Operation DisasterRecoveryConfigsOperations.fail_over has a new signature
Model ErrorResponse has a new signature
Removed operation NamespacesOperations.list_network_rule_sets

6.0.0b1 (2020-10-12)

This is beta preview version.

This version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentication and async programming).

General breaking changes

Credential system has been completly revamped:
- azure.common.credentials or msrestazure.azure_active_directory instances are no longer supported, use the azure-identity classes instead: https://pypi.org/project/azure-identity/
- credentials parameter has been renamed credential
The config attribute no longer exists on a client, configuration should be passed as kwarg. Example: MyClient(credential, subscription_id, enable_logging=True). For a complete set of supported options, see the parameters accept in init documentation of azure-core
You can't import a version module anymore, use __version__ instead
Operations that used to return a msrest.polling.LROPoller now returns a azure.core.polling.LROPoller and are prefixed with begin_.
Exceptions tree have been simplified and most exceptions are now azure.core.exceptions.HttpResponseError (CloudError has been removed).
Most of the operation kwarg have changed. Some of the most noticeable:
- raw has been removed. Equivalent feature can be found using cls, a callback that will give access to internal HTTP response for advanced user
- For a complete set of supported options, see the parameters accept in Request documentation of azure-core

General new features

Type annotations support using typing. SDKs are mypy ready.
This client has now stable and official support for async. Check the aio namespace of your package to find the async client.
This client now support natively tracing library like OpenCensus or OpenTelemetry. See this tracing quickstart for an overview.

1.0.0 (2020-09-16)

Features

Model SBNamespace has a new parameter zone_redundant
Model SBNamespace has a new parameter

azure-mgmt-servicebus

Description

Microsoft Azure SDK for Python

Disclaimer

Getting started

Prerequisites

Install the package

Authentication

Examples

Troubleshooting

Next steps

Provide Feedback

Release History

9.0.0 (2025-04-22)

Breaking Changes

8.2.1 (2024-11-05)

Other Changes

8.2.0 (2023-02-15)

Features Added

8.1.0 (2022-08-10)

Features Added

8.0.0 (2022-08-08)

7.1.0 (2021-09-23)

7.0.0 (2021-08-19)

6.0.0 (2020-11-23)

6.0.0b1 (2020-10-12)

1.0.0 (2020-09-16)