Microsoft Azure SDK for Python

这是 Microsoft Azure Key Vault 管理客户端库。此包已与 Python 3.8+ 进行测试。要查看 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.8+。
• Azure 订阅

安装包

pip install azure-mgmt-keyvault
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.keyvault import KeyVaultManagementClient
import os

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

示例

此包的代码示例可在此处找到

• 在 docs.microsoft.com 上搜索密钥保管库管理
• Azure Python Mgmt SDK 示例存储库

故障排除

下一步操作

提供反馈

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

发布历史

10.3.1 (2024-07-16)

其他更改

• 修复文档字符串

10.3.0 (2023-10-23)

新增功能

• 模型 MHSMPrivateEndpointConnection 新增参数 identity
• 模型 MHSMPrivateLinkResource 新增参数 identity
• 模型 ManagedHsm 新增参数 identity
• 模型 ManagedHsmResource 新增参数 identity

10.2.3 (2023-07-25)

已修复的错误

• 对于 VaultsOperation.list，不要使用配置的 api_version 替换 nextLink 中的值

10.2.2 (2023-05-24)

其他更改

• 为模型 Sku.family 添加默认值以避免破坏

10.2.1 (2023-04-03)

已修复的错误

• 将具有默认常量的单一值的 Seal 枚举转换为避免破坏性更改

10.2.0 (2023-03-13)

新增功能

• 添加操作组 MHSMRegionsOperations
• 添加操作组 ManagedHsmKeysOperations
• 模型 ManagedHsmProperties 新增参数 regions
• 模型 ManagedHsmProperties 新增参数 security_domain_properties

10.2.0b1 (2023-02-14)

新增功能

• 模型 ManagedHsmProperties 新增参数 security_domain_properties

10.1.0 (2022-08-10)

新增功能

• 添加操作 ManagedHsmsOperations.check_mhsm_name_availability
• 模型 Key 新增参数 release_policy
• 模型 Key 新增参数 rotation_policy
• 模型 KeyProperties 新增参数 release_policy
• 模型 KeyProperties 新增参数 rotation_policy
• 模型 MHSMPrivateEndpointConnectionItem 新增参数 etag
• 模型 MHSMPrivateEndpointConnectionItem 新增参数 id

其他更改

• 不再支持 Python 3.6。请使用 Python 版本 3.7 或更高版本。

10.0.0 (2022-05-24)

破坏性更改

• 模型 Key 不再具有参数 release_policy
• 模型 Key 不再具有参数 rotation_policy
• 模型 KeyProperties 不再具有参数 release_policy
• 模型 KeyProperties 不再具有参数 rotation_policy

9.3.0 (2021-11-11)

功能

• 添加了一些枚举值

9.2.0 (2021-10-15)

功能

• 模型 VaultProperties 新增参数 public_network_access
• 模型 VaultPatchProperties 新增参数 public_network_access
• 模型 KeyAttributes 新增参数 exportable
• 模型 Key 新增参数 release_policy
• 模型 Key 新增参数 rotation_policy
• 模型 KeyProperties 新增参数 release_policy
• 模型 KeyProperties 新增参数 rotation_policy

9.1.0 (2021-08-26)

功能

• 模型 VirtualNetworkRule 新增参数 ignore_missing_vnet_service_endpoint
• 模型 VaultProperties 新增参数 hsm_pool_resource_id
• 模型 PrivateEndpointConnectionItem 新增参数 etag
• 模型 PrivateEndpointConnectionItem 新增参数 id
• 模型 ServiceSpecification 新增参数 metric_specifications

9.0.0 (2021-04-19)

功能

• 模型 DeletedVaultProperties 新增参数 purge_protection_enabled
• 模型 Operation 新增参数 is_data_action
• 模型 Vault 新增参数 system_data
• 模型 ManagedHsmProperties 新增参数 scheduled_purge_date
• 模型 ManagedHsmProperties 新增参数 public_network_access
• 模型 ManagedHsmProperties 新增参数 network_acls
• 模型 ManagedHsmProperties 新增参数 private_endpoint_connections
• 模型 VaultProperties 新增参数 provisioning_state
• 模型 PrivateLinkServiceConnectionState 新增参数 actions_required
• 模型 ManagedHsmResource 新增参数 system_data
• Model ManagedHsm 具有新的参数 system_data
• Model PrivateEndpointConnection 具有新的参数 etag
• 添加了操作 ManagedHsmsOperations.get_deleted
• 添加了操作 ManagedHsmsOperations.list_deleted
• 添加了操作 ManagedHsmsOperations.begin_purge_deleted
• 添加了操作 PrivateEndpointConnectionsOperations.list_by_resource
• 添加了操作组 SecretsOperations
• 添加了操作组 MHSMPrivateLinkResourcesOperations
• 添加了操作组 KeysOperations
• 添加了操作组 MHSMPrivateEndpointConnectionsOperations

破坏性更改

• Model PrivateLinkServiceConnectionState 不再具有参数 action_required

8.0.0 (2020-09-29)

功能

• Model ManagedHsmProperties 具有新的参数 hsm_uri

破坏性更改

• Model ManagedHsmProperties 不再具有参数 hsm_pool_uri

7.0.0 (2020-09-15)

• 作为稳定版本发布

7.0.0b3 (2020-09-09)

功能

• 添加了操作组 ManagedHsmsOperations

7.0.0b2 (2020-07-21)

错误修复

• 使用服务 api_version "2015-11-01" 而不是 "2016-10-01"。

7.0.0b1 (2020-06-17)

这是一个测试预览版本。有关详细变更日志，请参阅等效稳定版本 2.2.0 (https://pypi.ac.cn/project/azure-mgmt-keyvault/2.2.0/)

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

一般破坏性更改

• 凭证系统已完全重做

  • azure.common.credentials 或 msrestazure.azure_active_directory 实例不再受支持，请使用 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 等跟踪库。有关概述，请参阅此 跟踪快速入门

2.2.0 (2020-03-20)

功能

• Model VaultProperties 具有新的参数 enable_rbac_authorization
• Model VaultProperties 具有新的参数 soft_delete_retention_in_days
• Model VaultPatchProperties 具有新的参数 enable_rbac_authorization
• Model VaultPatchProperties 具有新的参数 soft_delete_retention_in_days

2.1.1 (2020-02-07)

错误修复

• 修复了多 API 客户端问题

2.1.0 (2020-01-30)

功能

• Model VaultProperties 具有新的参数 private_endpoint_connections
• 添加了操作组 PrivateEndpointConnectionsOperations
• 添加了操作组 PrivateLinkResourcesOperations

2.0.0 (2019-06-18)

一般破坏性更改

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

• 无法从azure.mgmt.key_vault.v20xx_yy_zz.key_vault_management_client导入KeyVaultManagementClient（从azure.mgmt.key_vault.v20xx_yy_zz导入的行为与之前相同）
• KeyVaultManagementClientConfiguration的导入已从azure.mgmt.key_vault.v20xx_yy_zz.key_vault_management_client移动到azure.mgmt.key_vault.v20xx_yy_zz
• 来自“models”子模块的模型MyClass无法再使用azure.mgmt.key_vault.v20xx_yy_zz.models.my_class导入（从azure.mgmt.key_vault.v20xx_yy_zz.models导入的行为与之前相同）
• 来自operations子模块的操作类MyClassOperations无法再使用azure.mgmt.key_vault.v20xx_yy_zz.operations.my_class_operations导入（从azure.mgmt.key_vault.v20xx_yy_zz.operations导入的行为与之前相同）

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

1.1.0 (2018-08-07)

• 添加对多API和API配置文件的支持

1.0.0 (2018-06-27)

• 将azure-mgmt-keyvault移动到稳定的API版本2018-02-14

1.0.0b1 (2018-04-10)

• 升级到由autorest 3.0生成的代码

一般破坏性更改

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

• 模型签名现在仅使用关键字参数语法。所有位置参数都必须重写为关键字参数。为了在大多数情况下保持自动完成，现在为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不再在轮询完成后抛出异常，而是立即执行回调。

1.0.0a2 (2018-03-28)

• 升级到API版本2018-02-14-preview
• 在vault create_or_update中的破坏性更改现在返回一个'LROPoller'对象而不是Vault，以便调用者确定何时Vault可以接受流量。调用者应使用result()方法阻塞，直到Vault可访问。
• 添加network_acls vault属性，以限制对Vault的网络访问
• 添加对托管存储帐户密钥备份、还原和软删除支持
• 添加vault属性enable_purge_protection，以增强对Vault删除的保护

0.40.0 (2017-06-06)

• 升级到API版本2016-10-01
• 添加keyvault管理平面更新，以启用新或现有keyvault的软删除功能

注意

• 这包含一个向后不兼容的更改，从KeyPermissions、SecretPermissions和CertificatePermissions中删除了All值

0.31.0 (2017-04-19)

错误修复

• 修复可能的反序列化错误，但在适用的情况下从列表更改为列表

注意

• 此轮包现在使用 Azure 轮扩展构建

0.30.1 (2016-12-15)

• 修复列表库通过订阅方法返回类型

0.30.0 (2016-10-04)

• 初始预览版本（API 版本 2016-10-02）