Microsoft Azure SDK for Python

这是Microsoft Azure Service Bus Management Client Library。此包已在Python 3.7+上进行了测试。要查看Azure库的更完整视图，请参阅azure sdk python发布。

免责声明

Azure SDK Python包对Python 2.7的支持已于2022年1月1日结束。有关更多信息及问题，请参阅https://github.com/Azure/azure-sdk-for-python/issues/20691

入门

先决条件

• 使用此包需要Python 3.7+。
• Azure订阅

安装包

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

身份验证

默认情况下，Azure Active Directory令牌身份验证依赖于以下环境变量的正确配置。

• AZURE_CLIENT_ID用于Azure客户端ID。
• AZURE_TENANT_ID用于Azure租户ID。
• AZURE_CLIENT_SECRET用于Azure客户端密钥。

此外，可以通过环境变量AZURE_SUBSCRIPTION_ID配置Azure订阅ID。

以上配置后，客户端可以通过以下代码进行身份验证

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)

示例

该包的代码示例可以在docs.microsoft.com上的服务总线管理和示例存储库中找到。

故障排除

下一步

提供反馈

如果您遇到任何错误或有任何建议，请在该项目的问题部分提交问题。

版本历史

8.2.0 (2023-02-15)

新增功能

• 模型SBNamespace有一个新的参数premium_messaging_partitions

8.1.0 (2022-08-10)

新增功能

• 模型SBNamespace有一个新的参数minimum_tls_version
• 模型SBNamespace有一个新的参数public_network_access

8.0.0 (2022-08-08)

功能

• 模型ArmDisasterRecovery有一个新的参数location
• 模型MigrationConfigProperties有一个新的参数location
• 模型NetworkRuleSet有一个新的参数location
• 模型Operation有一个新的参数is_data_action
• 模型Operation有一个新的参数origin
• 模型Operation有一个新的参数properties
• 模型OperationDisplay有一个新的参数description
• 模型PrivateEndpointConnection有一个新的参数location
• 模型Rule有一个新的参数location
• 模型SBAuthorizationRule有一个新的参数location
• 模型SBNamespace有一个新的参数alternate_name
• 模型SBNamespaceUpdateParameters有一个新的参数alternate_name
• 模型SBQueue有一个新的参数location
• 模型SBSubscription有一个新的参数location
• 模型SBTopic有一个新的参数location

重大变更

• 模型SBNamespaceUpdateParameters不再有参数zone_redundant

7.1.0 (2021-09-23)

功能

• 模型NetworkRuleSet有一个新的参数public_network_access
• 模型NetworkRuleSet有一个新的参数trusted_service_access_enabled
• 模型SBQueue有一个新的参数max_message_size_in_kilobytes
• 模型SBTopic有一个新的参数max_message_size_in_kilobytes
• 模型SBNamespace有一个新的参数status
• 模型SBNamespace有一个新的参数disable_local_auth
• 模型SBSubscription有一个新的参数is_client_affine
• 模型SBSubscription有一个新的参数client_affine_properties
• 模型SBNamespaceUpdateParameters有一个新的参数status
• 模型SBNamespaceUpdateParameters有一个新的参数disable_local_auth

7.0.0 (2021-08-19)

功能

• 模型Rule有一个新的参数system_data
• 模型SBNamespaceUpdateParameters有一个新的参数private_endpoint_connections
• 模型PrivateEndpointConnection有一个新的参数system_data
• 模型SBTopic有一个新的参数system_data
• 模型Identity有一个新的参数user_assigned_identities
• 模型SBNamespace有一个新的参数system_data
• 模型SBNamespace有一个新的参数private_endpoint_connections
• 模型Encryption有一个新的参数require_infrastructure_encryption
• 模型SBAuthorizationRule有一个新的参数system_data
• 模型SBSubscription有一个新的参数system_data
• 模型KeyVaultProperties有一个新的参数key_version
• 模型KeyVaultProperties有一个新的参数identity
• 模型ArmDisasterRecovery有一个新的参数system_data
• 模型NetworkRuleSet有一个新的参数system_data
• 模型SBQueue有一个新的参数system_data
• 模型MigrationConfigProperties有一个新的参数system_data
• 新增操作NamespacesOperations.list_network_rule_sets

重大变更

• 模型子网参数的ID现在为必填项
• 已移除操作 NamespacesOperations.list_virtual_network_rules
• 已移除操作 NamespacesOperations.migrate
• 已移除操作 NamespacesOperations.delete_ip_filter_rule
• 已移除操作 NamespacesOperations.get_virtual_network_rule
• 已移除操作 NamespacesOperations.create_or_update_ip_filter_rule
• 已移除操作 NamespacesOperations.delete_virtual_network_rule
• 已移除操作 NamespacesOperations.get_ip_filter_rule
• 已移除操作 NamespacesOperations.list_ip_filter_rules
• 已移除操作 NamespacesOperations.create_or_update_virtual_network_rule

6.0.0 (2020-11-23)

功能

• 模型 SBNamespaceUpdateParameters 新增参数 zone_redundant
• 模型 SBNamespaceUpdateParameters 新增参数 identity
• 模型 SBNamespaceUpdateParameters 新增参数 encryption
• 模型 SBNamespace 新增参数 zone_redundant
• 模型 SBNamespace 新增参数 identity
• 模型 SBNamespace 新增参数 encryption
• 新增操作 NamespacesOperations.get_ip_filter_rule
• 新增操作 NamespacesOperations.list_ip_filter_rules
• 新增操作 NamespacesOperations.delete_virtual_network_rule
• 新增操作 NamespacesOperations.list_virtual_network_rules
• 新增操作 NamespacesOperations.get_virtual_network_rule
• 新增操作 NamespacesOperations.create_or_update_ip_filter_rule
• 新增操作 NamespacesOperations.delete_ip_filter_rule
• 新增操作 NamespacesOperations.create_or_update_virtual_network_rule
• 新增操作组 PrivateLinkResourcesOperations
• 新增操作组 PrivateEndpointConnectionsOperations

重大变更

• 操作 DisasterRecoveryConfigsOperations.fail_over 有了新的签名
• 模型 ErrorResponse 有了新的签名
• 已移除操作 NamespacesOperations.list_network_rule_sets

6.0.0b1 (2020-10-12)

这是beta预览版本。

本版本使用下一代代码生成器，引入了重要的不兼容更改，但也引入了重要的新功能（如统一身份验证和异步编程）。

一般性不兼容更改

• 凭证系统已被完全改造

  • azure.common.credentials 或 msrestazure.azure_active_directory 实例不再受支持，请使用 azure-identity 类：[https://pypi.ac.cn/project/azure-identity/](https://pypi.ac.cn/project/azure-identity/)
  • 将 credentials 参数重命名为 credential

• 客户端上的 config 属性不再存在，配置应作为 kwarg 传递。示例：MyClient(credential, subscription_id, enable_logging=True)。有关支持选项的完整集合，请参阅azure-core 初始化文档中的参数接受

• 不能再导入 version 模块，请使用 __version__ 代替

• 以前返回 msrest.polling.LROPoller 的操作现在返回 azure.core.polling.LROPoller，并以 begin_ 前缀。

• 异常树已简化，大多数异常现在都是 azure.core.exceptions.HttpResponseError（《CloudError》已被删除）。

• 大多数操作 kwarg 都已更改。其中一些最引人注目的是

  • raw 已被删除。等效功能可以通过使用 cls 找到，这是一个回调，将为高级用户提供对内部 HTTP 响应的访问
  • 有关支持选项的完整集合，请参阅azure-core 请求文档中的参数接受

一般性新功能

• 支持使用 typing 进行类型注解。SDKs 是 mypy 准备就绪的。
• 此客户端现在提供稳定和官方的异步支持。检查您包中的 aio 命名空间以找到异步客户端。
• 此客户端现在原生支持像 OpenCensus 或 OpenTelemetry 这样的跟踪库。有关概述，请参阅此跟踪快速入门。

1.0.0 (2020-09-16)

功能

• 模型 SBNamespace 新增参数 zone_redundant
• 模型 SBNamespace 新增参数 encryption
• 模型 SBNamespaceUpdateParameters 新增参数 zone_redundant
• 模型 SBNamespaceUpdateParameters 新增参数 identity
• 模型 SBNamespaceUpdateParameters 新增参数 encryption
• 新增操作 NamespacesOperations.create_or_update_virtual_network_rule
• 新增操作 NamespacesOperations.create_or_update_ip_filter_rule
• 新增操作 NamespacesOperations.list_virtual_network_rules
• 新增操作 NamespacesOperations.delete_ip_filter_rule
• 新增操作 NamespacesOperations.list_ip_filter_rules
• 新增操作 NamespacesOperations.get_ip_filter_rule
• 新增操作 NamespacesOperations.get_virtual_network_rule
• 新增操作 NamespacesOperations.delete_virtual_network_rule
• 新增操作组 PrivateLinkResourcesOperations
• 新增操作组 PrivateEndpointConnectionsOperations

重大变更

• 模型 ErrorResponse 有了新的签名

0.6.0 (2019-04-09)

功能

• 新增操作 NamespacesOperations.get_network_rule_set
• 新增操作 NamespacesOperations.migrate
• 新增操作 NamespacesOperations.create_or_update_network_rule_set

0.5.4 (2019-02-15)

功能

• 新增操作 NamespacesOperations.migrate

0.5.3 (2018-10-29)

错误修复

• 修复 0.5.2 中的 sdist 破坏。没有代码更改。

0.5.2 (2018-09-28)

功能

• Model MigrationConfigProperties 添加了新参数 migration_state

注意

• 在 Python 3（基于 PEP420 的命名空间包）上，已不再安装 azure-mgmt-nspkg

0.5.1 (2018-07-09)

功能

• 添加 pending_replication_operations_count

错误修复

• 修复一些 Py3 导入模型

0.5.0 (2018-04-26)

一般破坏性变更

本版本使用下一代代码生成器，可能会引入破坏性变更。

• 模型签名现在只使用关键字参数语法。所有位置参数必须重写为关键字参数。为了在大多数情况下保持自动完成，现在为 Python 2 和 Python 3 生成模型。Python 3 使用 "*" 语法用于关键字仅参数。
• 枚举类型现在使用 "str" 混合（class AzureEnum(str, Enum)）来改善遇到未识别枚举值时的行为。虽然这不是破坏性变更，但区别很重要，这里进行了说明：https://docs.pythonlang.cn/3/library/enum.html#others
  • "is" 完全不应使用。
  • "format" 将返回字符串值，而 "%s" 字符串格式化将返回 NameOfEnum.stringvalue。应优先使用格式化语法。
• 新的长时间运行操作
  • 返回类型从 msrestazure.azure_operation.AzureOperationPoller 更改为 msrest.polling.LROPoller。外部 API 保持不变。
  • 返回类型现在是 始终 msrest.polling.LROPoller，无论使用何种可选参数。
  • 使用 raw=True 时的行为已更改。现在不再返回初始调用结果作为 ClientRawResponse，不进行轮询，而是返回 LROPoller。轮询后，最终资源将作为 ClientRawResponse 返回。
  • 添加了新的 polling 参数。默认行为是 Polling=True，将使用 ARM 算法进行轮询。当 Polling=False 时，将返回初始调用的响应，而不进行轮询。
  • polling 参数接受 msrest.polling.PollingMethod 子类的实例。
  • 在轮询完成后调用 add_done_callback 将不会引发异常，而是立即执行回调。

SDK 功能

• 客户端类可以用作上下文管理器，以保持底层 HTTP 会话打开以提高性能。

ServiceBus 功能

• 添加 dead_lettering_on_filter_evaluation_exceptions
• 将 enable_batched_operations 属性添加到 ServiceBus 队列
• 添加迁移配置操作
• 将 skip 和 top 添加到列表命令
• 将 'properties' 添加到 CorrelationFilter
• 删除已弃用的 'enableSubscriptionPartitioning' 属性

0.4.0 (2017-12-12)

功能

• 将 alternate_name 添加到一些模型（GEO DR 配对）
• 添加 disaster_recovery_configs.check_name_availability_method
• 添加 disaster_recovery_configs.list_authorization_rules
• 添加 disaster_recovery_configs.get_authorization_rule
• 添加 disaster_recovery_configs.list_keys

0.3.1 (2017-12-08)

错误修复

• 添加 missing forward_to, forward_dead_lettered_messages_to
• 对于 create_or_update_authorization_rule 调用的操作，现在 "rights" 是必需的，如预期。

0.3.0 (2017-10-26)

功能

• 添加 disaster_recovery_configs 操作组
• 添加 regions 操作组
• 添加 premium_messgings_regions 操作组
• 添加 event_hubs 操作组
• 添加 Geo DR

0.2.0 (2017-06-26)

• 新的 API 版本 2017-04-01
• 由于客户端不稳定，预计会有破坏性变更。

此轮包是用 azure wheel 扩展构建的。

0.1.0 (2016-10-27)

• 首次发布