你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
SecretClient 类
用于管理保管库机密的高级接口。
- 继承
-
azure.keyvault.secrets._shared.client_base.KeyVaultClientBaseSecretClient
构造函数
SecretClient(vault_url: str, credential: TokenCredential, **kwargs)参数
- vault_url
- str
客户端将访问的保管库的 URL。 这也称为保管库的“DNS 名称”。 应验证此 URL 是否引用了有效的密钥保管库资源。 有关详细信息，请参阅https://aka.ms/azsdk/blog/vault-uri。
- api_version
- ApiVersion
要使用的服务 API 的版本。 默认为最新的 。
- verify_challenge_resource
- bool
验证身份验证质询资源是否与密钥保管库域匹配。 默认为 True。
方法
| backup_secret |
以仅供 Azure 密钥保管库使用的受保护表单备份机密。 需要机密/备份权限。 |
| begin_delete_secret |
删除机密的所有版本。 需要机密/删除权限。 此方法返回密钥保管库已开始删除机密。 在启用了软删除的保管库中，删除可能需要几秒钟时间。 因此，此方法返回一个轮询器，使你能够等待删除完成。 |
| begin_recover_deleted_secret |
将已删除的机密恢复到其最新版本。 只能在启用了软删除的保管库中实现。 需要机密/恢复权限。 如果保管库未启用软删除， begin_delete_secret 是永久性的，此方法将返回错误。 尝试恢复未删除的机密也会返回错误。 此方法返回密钥保管库已开始恢复机密。 恢复可能需要几秒钟。 因此，此方法返回一个轮询器，使你能够等待恢复完成。 仅当想要立即在另一个操作中使用恢复的机密时，才需要等待。 |
| close |
关闭客户端打开的套接字。 使用客户端作为上下文管理器时，不需要调用此方法。 |
| get_deleted_secret |
获取已删除的机密。 只能在启用了软删除的保管库中使用。 需要机密/获取权限。 |
| get_secret |
获取机密。 需要 secrets/get 权限。 |
| list_deleted_secrets |
列出所有已删除的机密。 只能在启用了软删除的保管库中使用。 需要机密/列表权限。 |
| list_properties_of_secret_versions |
列出机密的所有版本的属性，不包括其值。 需要机密/列表权限。 列表项不包括机密值。 使用 get_secret 获取机密的值。 |
| list_properties_of_secrets |
列出保管库中所有机密的标识符和属性。 需要机密/列表权限。 列表项不包括机密值。 使用 get_secret 获取机密的值。 |
| purge_deleted_secret |
永久删除已删除的机密。 只能在启用了软删除的保管库中使用。 执行指定机密的不可逆删除，无法恢复。 如果未指定“Purgeable”， recovery_level 则操作不可用。 仅当清除机密之前， scheduled_purge_date才需要此方法。 需要机密/清除权限。 |
| restore_secret_backup |
还原备份的机密。 需要机密/还原权限。 |
| send_request |
使用客户端的现有管道运行网络请求。 请求 URL 可以相对于保管库 URL。 除非另有指定，否则用于请求的服务 API 版本与客户端的版本相同。 如果响应是错误，则此方法不会引发;若要引发异常，请对返回的响应对象调用 raise_for_status () 。 有关如何使用此方法发送自定义请求的详细信息，请参阅 https://aka.ms/azsdk/dpcodegen/python/send_request。 |
| set_secret |
设置机密值。 如果 名称 正在使用中，请创建机密的新版本。 如果没有，请创建新机密。 需要机密/设置权限。 |
| update_secret_properties |
更新机密的值以外的其他属性。 需要机密/设置权限。 此方法更新机密的属性，例如是否已启用该机密，但无法更改机密的值。 使用 set_secret 更改机密的值。 |
backup_secret
以仅供 Azure 密钥保管库使用的受保护表单备份机密。 需要机密/备份权限。
backup_secret(name: str, **kwargs) -> bytes参数
返回类型
例外
如果机密不存在，则为
对于其他错误
begin_delete_secret
删除机密的所有版本。 需要机密/删除权限。
此方法返回密钥保管库已开始删除机密。 在启用了软删除的保管库中，删除可能需要几秒钟时间。 因此，此方法返回一个轮询器，使你能够等待删除完成。
begin_delete_secret(name: str, **kwargs) -> LROPoller[DeletedSecret]参数
返回
删除操作的轮询器。 轮询器 的结果 方法返回 ， DeletedSecret 而无需等待删除完成。 如果保管库已启用软删除，并且你想要使用 purge_deleted_secret永久删除机密，请首先调用轮询者的 wait 方法。 它将阻止，直到删除完成。 wait 方法需要机密/get 权限。
返回类型
例外
如果机密不存在，则为
对于其他错误
begin_recover_deleted_secret
将已删除的机密恢复到其最新版本。 只能在启用了软删除的保管库中实现。
需要机密/恢复权限。 如果保管库未启用软删除， begin_delete_secret 是永久性的，此方法将返回错误。 尝试恢复未删除的机密也会返回错误。 此方法返回密钥保管库已开始恢复机密。 恢复可能需要几秒钟。 因此，此方法返回一个轮询器，使你能够等待恢复完成。 仅当想要立即在另一个操作中使用恢复的机密时，才需要等待。
begin_recover_deleted_secret(name: str, **kwargs) -> LROPoller[SecretProperties]参数
返回
恢复操作的轮询程序。 轮询器 的结果 方法返回已恢复的机密， SecretProperties 而无需等待恢复完成。 如果要立即使用恢复的机密，请调用轮询 器等待方法 ，该方法会阻止，直到机密可供使用。 wait 方法需要机密/get 权限。
返回类型
例外
close
关闭客户端打开的套接字。
使用客户端作为上下文管理器时，不需要调用此方法。
close() -> None例外
如果机密不存在，则为
对于其他错误
get_deleted_secret
获取已删除的机密。 只能在启用了软删除的保管库中使用。 需要机密/获取权限。
get_deleted_secret(name: str, **kwargs) -> DeletedSecret参数
返回类型
例外
如果已删除的机密不存在，
对于其他错误
get_secret
获取机密。 需要 secrets/get 权限。
get_secret(name: str, version: str | None = None, **kwargs) -> KeyVaultSecret参数
返回类型
例外
如果机密不存在，则为
对于其他错误
list_deleted_secrets
列出所有已删除的机密。 只能在启用了软删除的保管库中使用。
需要机密/列表权限。
list_deleted_secrets(**kwargs) -> ItemPaged[DeletedSecret]返回
已删除机密的迭代器，不包括其值
返回类型
例外
如果机密不存在，则为
对于其他错误
list_properties_of_secret_versions
列出机密的所有版本的属性，不包括其值。 需要机密/列表权限。
列表项不包括机密值。 使用 get_secret 获取机密的值。
list_properties_of_secret_versions(name: str, **kwargs) -> ItemPaged[SecretProperties]参数
返回
机密的迭代器，不包括其值
返回类型
例外
如果机密不存在，则为
对于其他错误
list_properties_of_secrets
列出保管库中所有机密的标识符和属性。 需要机密/列表权限。
列表项不包括机密值。 使用 get_secret 获取机密的值。
list_properties_of_secrets(**kwargs) -> ItemPaged[SecretProperties]返回
机密的迭代器，不包括其值
返回类型
例外
如果机密不存在，则为
对于其他错误
purge_deleted_secret
永久删除已删除的机密。 只能在启用了软删除的保管库中使用。
执行指定机密的不可逆删除，无法恢复。 如果未指定“Purgeable”， recovery_level 则操作不可用。 仅当清除机密之前， scheduled_purge_date才需要此方法。
需要机密/清除权限。
purge_deleted_secret(name: str, **kwargs) -> None参数
返回
无
例外
示例
# if the vault has soft-delete enabled, purge permanently deletes the secret
# (with soft-delete disabled, begin_delete_secret is permanent)
secret_client.purge_deleted_secret("secret-name")
restore_secret_backup
还原备份的机密。 需要机密/还原权限。
restore_secret_backup(backup: bytes, **kwargs) -> SecretProperties参数
返回
还原的机密
返回类型
例外
如果机密的名称已在使用中，
对于其他错误
send_request
使用客户端的现有管道运行网络请求。
请求 URL 可以相对于保管库 URL。 除非另有指定，否则用于请求的服务 API 版本与客户端的版本相同。 如果响应是错误，则此方法不会引发;若要引发异常，请对返回的响应对象调用 raise_for_status () 。 有关如何使用此方法发送自定义请求的详细信息，请参阅 https://aka.ms/azsdk/dpcodegen/python/send_request。
send_request(request: HttpRequest, *, stream: bool = False, **kwargs) -> HttpResponse参数
- stream
- bool
是否对响应有效负载进行流式处理。 默认为 False。
返回
网络呼叫的响应。 不对响应执行错误处理。
返回类型
例外
如果机密不存在，则为
对于其他错误
set_secret
设置机密值。 如果 名称 正在使用中，请创建机密的新版本。 如果没有，请创建新机密。
需要机密/设置权限。
set_secret(name: str, value: str, **kwargs) -> KeyVaultSecret参数
- enabled
- bool
是否启用机密以供使用。
- content_type
- str
指示机密类型的任意字符串，例如“password”
- not_before
- datetime
不在 UTC 机密日期之前
- expires_on
- datetime
UTC 中机密的到期日期
返回类型
例外
update_secret_properties
更新机密的值以外的其他属性。 需要机密/设置权限。
此方法更新机密的属性，例如是否已启用该机密，但无法更改机密的值。 使用 set_secret 更改机密的值。
update_secret_properties(name: str, version: str | None = None, **kwargs) -> SecretProperties参数
- enabled
- bool
是否启用机密以供使用。
- content_type
- str
指示机密类型的任意字符串，例如“password”
- not_before
- datetime
不在 UTC 机密日期之前
- expires_on
- datetime
UTC 中机密的到期日期
返回类型
例外
如果机密不存在，
其他错误
