Microsoft Azure SDK for Python

这是Microsoft Azure事件中心管理客户端库。此包已在Python 3.8+上进行测试。要查看Azure库的完整视图，请参阅azure sdk python release。

免责声明

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

入门

先决条件

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

安装包

pip install azure-mgmt-eventhub
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.eventhub import EventHubManagementClient
import os

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

示例

此包的代码示例可在以下位置找到

• 在 docs.microsoft.com 上搜索事件中心管理
• Azure Python 管理 SDK 示例存储库

故障排除

下一步

提供反馈

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

版本历史记录

11.1.0 (2024-09-02)

新增功能

• 模型集群有一个新的参数 provisioning_state
• 模型目标有一个新的参数 identity
• 模型事件中心有一个新的参数 user_metadata
• 模型网络安全边界的配置有一个新的参数 applicable_features
• 模型网络安全边界的配置有一个新的参数 is_backing_resource
• 模型网络安全边界的配置有一个新的参数 location
• 模型网络安全边界的配置有一个新的参数 parent_association_name
• 模型网络安全边界的配置有一个新的参数 source_resource_id

11.0.0 (2023-04-14)

新增功能

• 模型事件中心有一个新的参数 retention_description

破坏性更改

• 模型网络安全边界的配置不再有参数 location
• 模型网络安全边界的配置不再有参数 tags

11.0.0b1 (2023-02-14)

新增功能

• 模型事件中心有一个新的参数 retention_description

破坏性更改

• 模型网络安全边界的配置不再有参数 location
• 模型网络安全边界的配置不再有参数 tags

10.1.0 (2022-06-22)

功能

• 添加了操作组 ApplicationGroupOperations
• 添加了操作组 NetworkSecurityPerimeterConfigurationOperations
• 添加了操作组 NetworkSecurityPerimeterConfigurationsOperations
• 模型集群有一个新的参数 supports_scaling
• 模型 EHNamespace 有一个新参数 minimum_tls_version
• 模型 EHNamespace 有一个新参数 public_network_access

10.0.0 (2021-11-01)

功能

• 模型 ErrorResponse 有一个新参数 error
• 模型 NetworkRuleSet 有一个新参数 location
• 模型 Eventhub 有一个新参数 location
• 模型 ConsumerGroup 有一个新参数 location
• 模型 ArmDisasterRecovery 有一个新参数 location
• 模型 Operation 有一个新参数 is_data_action
• 模型 Operation 有一个新参数 origin
• 模型 Operation 有一个新参数 properties
• 模型 PrivateEndpointConnection 有一个新参数 location
• 模型目标有一个新参数 data_lake_account_name
• 模型目标有一个新参数 data_lake_subscription_id
• 模型目标有一个新参数 data_lake_folder_path
• 模型 EHNamespace 有一个新参数 alternate_name
• 模型 OperationDisplay 有一个新参数 description
• 模型 AuthorizationRule 有一个新参数 location
• 添加了操作 NamespacesOperations.list_network_rule_set
• 添加了操作组 SchemaRegistryOperations

破坏性更改

• 模型 ErrorResponse 不再有参数 message
• 模型 ErrorResponse 不再有参数 code

9.1.0 (2021-09-17)

功能

• 模型 Cluster 有一个新参数 system_data
• 模型 EHNamespace 有一个新参数 disable_local_auth
• 模型 EHNamespace 有一个新参数 status
• 模型 NetworkRuleSet 有一个新参数 public_network_access
• 添加了操作 ClustersOperations.list_by_subscription

9.0.0 (2021-05-25)

功能

• 模型 NetworkRuleSet 有一个新参数 system_data
• 模型 ConsumerGroup 有一个新参数 system_data
• 模型 PrivateEndpointConnection 有一个新参数 system_data
• 模型 EHNamespace 有一个新参数 system_data
• 模型 EHNamespace 有一个新参数 private_endpoint_connections
• 模型 ArmDisasterRecovery 有一个新参数 system_data
• 模型 Identity 有一个新参数 user_assigned_identities
• 模型 Eventhub 有一个新参数 system_data
• 模型 KeyVaultProperties 有一个新参数 identity
• 模型 AuthorizationRule 有一个新参数 system_data
• 模型 Encryption 有一个新参数 require_infrastructure_encryption

破坏性更改

• 已移除操作 NamespacesOperations.list_ip_filter_rules
• 已移除操作 NamespacesOperations.delete_virtual_network_rule
• 已移除操作 NamespacesOperations.delete_ip_filter_rule
• 已移除操作 NamespacesOperations.list_virtual_network_rules
• 已移除操作 NamespacesOperations.create_or_update_virtual_network_rule
• 已移除操作 NamespacesOperations.get_virtual_network_rule
• 已移除操作 NamespacesOperations.create_or_update_ip_filter_rule
• 已移除操作 NamespacesOperations.get_ip_filter_rule

8.0.0 (2020-09-16)

功能

• 模型 NetworkRuleSet 新增参数 trusted_service_access_enabled
• 新增操作组 PrivateEndpointConnectionsOperations
• 新增操作组 PrivateLinkResourcesOperations

8.0.0b1 (2020-06-17)

这是测试预览版本。

此版本使用新一代代码生成器，引入了重要的破坏性变化，但也引入了重要的新功能（如统一认证和异步编程）。

一般破坏性变化

• 凭证系统已完全重制

  • 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 初始化文档中的参数接受](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)

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

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

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

• 大多数操作 kwarg 已更改。其中一些最明显的变化：

  • raw 已删除。等效功能可以使用 cls 找到，这是一个回调，将提供对内部 HTTP 响应的访问，供高级用户使用
  • 有关支持选项的完整集合，请参阅 [azure-core 请求文档中的参数接受](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)

一般新功能

• 支持使用 typing 进行类型注解。SDKs 已准备好使用 mypy。
• 此客户端现在对异步支持稳定且官方。检查您包的 aio 命名空间以查找异步客户端。
• 此客户端现在原生支持像 OpenCensus 或 OpenTelemetry 这样的跟踪库。有关概述，请参阅此 [跟踪快速入门](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/core/azure-core-tracing-opentelemetry)

4.0.0 (2020-06-12)

功能

• 模型 Cluster 新增参数 updated_at
• 模型 Cluster 新增参数 created_at
• 新增操作 ClustersOperations.update
• 新增操作 ClustersOperations.create_or_update
• 新增操作 ClustersOperations.list_available_cluster_region

**破坏性变化**

• 模型 Cluster 不再具有参数 created
• 模型 Cluster 不再具有参数 updated
• 已移除操作 ClustersOperations.put
• 已移除操作 ClustersOperations.list_available_clusters
• 已移除操作 ClustersOperations.patch

3.1.0 (2020-05-13)

功能

• 模型 EHNamespace 新增参数 encryption
• 模型 EHNamespace 新增参数 identity
• 模型 EHNamespace 新增参数 cluster_arm_id
• 新增操作 NamespacesOperations.list_keys
• 新增操作 NamespacesOperations.get_authorization_rule
• 新增操作 NamespacesOperations.check_name_availability
• 新增操作 NamespacesOperations.list_authorization_rules
• 新增操作 NamespacesOperations.regenerate_keys
• 新增操作 NamespacesOperations.create_or_update_authorization_rule
• 新增操作 NamespacesOperations.delete_authorization_rule

3.0.0 (2019-06-18)

一般破坏性变化

本版本使用了下一代代码生成器，如果从v20xx_yy_zz API文件夹导入，可能会引入破坏性更改。简而言之，一些模块的可见性/导入不正确，并已被重命名。这解决了由于最初不应该使用类而导致的一些问题。

• 无法从 azure.mgmt.eventhub.v20xx_yy_zz.event_hub_management_client 导入 EventHubManagementClient anymore（从 azure.mgmt.eventhub.v20xx_yy_zz 导入与之前相同）
• EventHubManagementClientConfiguration 的导入已从 azure.mgmt.eventhub.v20xx_yy_zz.event_hub_management_client 移至 azure.mgmt.eventhub.v20xx_yy_zz
• 来自 "models" 子模块的模型 MyClass 无法再使用 azure.mgmt.eventhub.v20xx_yy_zz.models.my_class 导入（从 azure.mgmt.eventhub.v20xx_yy_zz.models 导入与之前相同）
• 来自 operations 子模块的操作类 MyClassOperations 无法再使用 azure.mgmt.eventhub.v20xx_yy_zz.operations.my_class_operations 导入（从 azure.mgmt.eventhub.v20xx_yy_zz.operations 导入与之前相同）

最后但同样重要的是，HTTP连接池现在默认启用。您应该始终将客户端用作上下文管理器，或调用close()，或每个进程不超过一个客户端。

2.6.0 (2019-04-29)

预览功能

• 添加了操作 ClustersOperations.put
• 添加了操作 ClustersOperations.list_available_clusters
• 添加了操作 ClustersOperations.list_namespaces
• 添加了操作 ClustersOperations.delete

错误修复

• 删除错误打包的无用文件（azure.mgmt.eventhub.operations文件夹）

2.5.0 (2019-04-09)

功能

• 为2017-04-01 API版本添加了操作 NamespacesOperations.create_or_update_network_rule_set
• 为2017-04-01 API版本添加了操作 NamespacesOperations.get_network_rule_set

2.4.0 (2019-03-06)

功能

• 支持2015-08-01、2017-04-01和2018-01-01-preview的MultiApi
• 2017-04-01是默认API版本

2.3.0 (2019-02-04)

功能

• 模型 CaptureDescription 有一个新参数 skip_empty_archives

2.2.0 (2018-10-29)

功能

• 添加 kafka_enabled 属性

注意

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

2.1.0 (2018-07-31)

功能

• 添加 pending_replication_operations_count 支持

错误修复

• 修复一些Python3模型

2.0.0 (2018-05-04)

一般破坏性变化

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

• 模型签名现在只使用关键字参数语法。所有位置参数必须重写为关键字参数。为了在大多数情况下保持自动完成，模型现在为Python 2和Python 3生成。Python 3使用 "*" 语法进行关键字只参数。
• 枚举类型现在使用 "str" 混合（类 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 后轮询已完成，则 add_done_callback 将不再引发异常，而是立即执行回调。

功能

• 客户端类可以用作上下文管理器以保持底层HTTP会话开启以提升性能
• 添加区域操作组
• 为相关操作添加 skip/top
• 添加 get_messaging_plan 操作

错误修复

• 与 wheel 0.31.0 的 sdist 兼容性

1.2.0 (2017-12-12)

功能

• 向某些模型添加 alternate_name（GEO DR 配对）
• 添加 disaster_recovery_configs.check_name_availability
• 添加 disaster_recovery_configs.list_authorization_rules
• 添加 disaster_recovery_configs.get_authorization_rule
• 添加 disaster_recovery_configs.list_keys

错误修复

• 如预期，现在 create_or_update_authorization_rule 调用操作需要 "rights" 参数
• 修复 message_retention_in_days 验证规则
• 修复 partition_count 验证规则

1.1.0 (2017-10-26)

功能

• 添加 disaster_recovery_configs 操作组
• 添加 Geo DR

1.0.0 (2017-06-27)

• 新 API 版本 2017-04-01
• 预期有破坏性变更，从不稳定客户端迁移

此 wheel 软件包是用 azure wheel 扩展构建的

0.2.0 (2016-10-27)

破坏性更改

• CreateOrUpdate 将其参数扁平化，从一个大 Properties 对象移动到几个小的具体对象。

0.1.0 (2016-10-27)

• 初始发布