你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
CertificateClient 类
用于管理保管库证书的高级界面。
- 继承
-
azure.keyvault.certificates._shared.client_base.KeyVaultClientBaseCertificateClient
构造函数
CertificateClient(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_certificate |
以仅供 Azure 密钥保管库使用的受保护表单备份证书。 需要证书/备份权限。 这旨在允许将证书从一个保管库复制到另一个保管库。 这两个保管库必须归同一 Azure 订阅所有。 此外，无法跨地缘政治边界执行备份/还原。 例如，无法将美国区域中保管库的备份还原到欧盟区域中的保管库。 |
| begin_create_certificate |
创建新证书。 如果这是第一个版本，则会创建证书资源。 此操作需要证书/创建权限。 等待返回的轮询器需要证书/获取权限，如果创建成功，则会提供证书;否则，将引发 HttpResponseErrorCertificateOperation 。 |
| begin_delete_certificate |
删除证书的所有版本。 需要证书/删除权限。 此方法返回密钥保管库已开始删除证书。 在启用了软删除的保管库中，删除可能需要几秒钟时间。 因此，此方法返回一个轮询器，使你能够等待删除完成。 |
| begin_recover_deleted_certificate |
将已删除的证书恢复到其最新版本。 只能在启用了软删除的保管库中实现。 需要证书/恢复权限。 此方法返回密钥保管库已开始恢复证书。 恢复可能需要几秒钟。 因此，此方法返回一个轮询器，使你能够等待恢复完成。 仅当想要立即在另一个操作中使用恢复的证书时，才需要等待。 |
| cancel_certificate_operation |
取消正在进行的证书操作。 需要证书/更新权限。 |
| close |
关闭客户端打开的套接字。 使用客户端作为上下文管理器时，不需要调用此方法。 |
| create_issuer |
设置指定的证书颁发者。 需要证书/设置颁发者权限。 |
| delete_certificate_operation |
删除并停止特定证书的创建操作。 需要证书/更新权限。 |
| delete_contacts |
删除密钥保管库的证书联系人。 需要 certificates/managecontacts 权限。 |
| delete_issuer |
删除指定的证书颁发者。 需要 certificates/manageissuers/deleteissuers 权限。 |
| get_certificate |
获取附加了其管理策略的证书。 需要证书/获取权限。 不接受证书版本作为参数。 若要获取特定版本的证书，请调用 get_certificate_version。 |
| get_certificate_operation |
获取证书的创建操作。 需要证书/获取权限。 |
| get_certificate_policy |
获取证书的策略。 需要证书/获取权限。 返回密钥保管库中的指定证书策略资源。 |
| get_certificate_version |
获取证书的特定版本，而不返回其管理策略。 需要证书/获取权限。 若要获取最新版本的证书，或也获取证书的策略，请调用 get_certificate。 |
| get_contacts |
获取密钥保管库的证书联系人。 需要 certificates/managecontacts 权限。 |
| get_deleted_certificate |
获取已删除的证书。 只能在启用了软删除的保管库中实现。 需要证书/获取权限。 检索已删除的证书信息及其属性，例如保留间隔、计划的永久删除和当前删除恢复级别。 |
| get_issuer |
获取指定的证书颁发者。 需要 certificates/manageissuers/getissuers 权限。 |
| import_certificate |
导入在外部创建的证书。 需要证书/导入权限。 将包含私钥的现有有效证书导入 Azure Key Vault。 要导入的证书可以采用 PFX 或 PEM 格式。 如果证书采用 PEM 格式，则 PEM 文件必须包含密钥以及 x509 证书，并且必须提供 |
| list_deleted_certificates |
列出当前可恢复的已删除证书。 仅当启用了保管库软删除时，才可能。 需要证书/get/list 权限。 检索当前保管库中处于已删除状态并准备恢复或清除的证书。 此操作包括特定于删除的信息。 |
| list_properties_of_certificate_versions |
列出证书版本的标识符和属性。 需要证书/列表权限。 |
| list_properties_of_certificates |
列出保管库中所有证书的标识符和属性。 需要证书/列表权限。 |
| list_properties_of_issuers |
列出密钥保管库的证书颁发者的属性。 需要 certificates/manageissuers/getissuers 权限。 |
| merge_certificate |
将证书或证书链与服务器上存在的密钥对合并。 需要证书/创建权限。 将证书或证书链与服务中当前可用的密钥对合并。 在创建要合并的证书时，请确保将其 begin_create_certificate 颁发者设置为“未知”。 这样，密钥保管库知道证书不会由其已知的颁发者签名。 |
| purge_deleted_certificate |
永久删除已删除的证书。 只能在启用了软删除的保管库中使用。 需要证书/清除权限。 执行指定证书的不可逆删除操作，无法恢复。 如果未指定“Purgeable”， recovery_level 则操作不可用。 仅当清除证书之前， scheduled_purge_date才需要此方法。 |
| restore_certificate_backup |
将证书备份还原到保管库。 需要证书/还原权限。 这将还原证书的所有版本及其名称、属性和访问控制策略。 如果证书的名称已在使用中，还原该名称将失败。 此外，目标保管库必须由与源保管库相同的 Microsoft Azure 订阅拥有。 |
| send_request |
使用客户端的现有管道运行网络请求。 请求 URL 可以相对于保管库 URL。 除非另有指定，否则用于请求的服务 API 版本与客户端的版本相同。 如果响应是错误，则此方法不会引发;若要引发异常，请对返回的响应对象调用 raise_for_status () 。 有关如何使用此方法发送自定义请求的详细信息，请参阅 https://aka.ms/azsdk/dpcodegen/python/send_request。 |
| set_contacts |
设置密钥保管库的证书联系人。 需要证书/管理联系人权限。 |
| update_certificate_policy |
汇报证书的策略。 需要证书/更新权限。 在证书策略中设置指定成员。 将其他人保留为 null。 |
| update_certificate_properties |
更改证书的属性。 需要证书/更新权限。 |
| update_issuer |
汇报指定的证书颁发者。 需要证书/设置颁发者权限。 |
backup_certificate
以仅供 Azure 密钥保管库使用的受保护表单备份证书。
需要证书/备份权限。 这旨在允许将证书从一个保管库复制到另一个保管库。 这两个保管库必须归同一 Azure 订阅所有。 此外，无法跨地缘政治边界执行备份/还原。 例如，无法将美国区域中保管库的备份还原到欧盟区域中的保管库。
backup_certificate(certificate_name: str, **kwargs) -> bytes参数
返回
包含备份证书的备份 Blob。
返回类型
例外
如果证书不存在，则为
对于其他错误
begin_create_certificate
创建新证书。
如果这是第一个版本，则会创建证书资源。 此操作需要证书/创建权限。 等待返回的轮询器需要证书/获取权限，如果创建成功，则会提供证书;否则，将引发 HttpResponseErrorCertificateOperation 。
begin_create_certificate(certificate_name: str, policy: CertificatePolicy, **kwargs) -> LROPoller[KeyVaultCertificate | CertificateOperation]参数
- enabled
- bool
是否启用证书以供使用。
返回
用于创建证书操作的 LROPoller。 如果创建成功，则等待轮询器会提供证书;如果创建成功，则为 CertificateOperation。
返回类型
例外
如果证书策略无效，
用于其他错误。
begin_delete_certificate
删除证书的所有版本。 需要证书/删除权限。
此方法返回密钥保管库已开始删除证书。 在启用了软删除的保管库中，删除可能需要几秒钟时间。 因此，此方法返回一个轮询器，使你能够等待删除完成。
begin_delete_certificate(certificate_name: str, **kwargs) -> LROPoller[DeletedCertificate]参数
返回
删除证书操作的轮询程序。 轮询器 的结果 方法返回 ， DeletedCertificate 而无需等待删除完成。 如果保管库已启用软删除，并且你想要立即使用 purge_deleted_certificate永久删除证书，请首先调用轮询程序的 wait 方法。 它将阻止，直到删除完成。 wait 方法需要 certificates/get 权限。
返回类型
例外
如果证书不存在，则为
对于其他错误
begin_recover_deleted_certificate
将已删除的证书恢复到其最新版本。 只能在启用了软删除的保管库中实现。
需要证书/恢复权限。 此方法返回密钥保管库已开始恢复证书。 恢复可能需要几秒钟。 因此，此方法返回一个轮询器，使你能够等待恢复完成。 仅当想要立即在另一个操作中使用恢复的证书时，才需要等待。
begin_recover_deleted_certificate(certificate_name: str, **kwargs) -> LROPoller[KeyVaultCertificate]参数
返回
恢复操作的轮询程序。 轮询器 的结果 方法返回已 KeyVaultCertificate 恢复的 ，而无需等待恢复完成。 如果要立即使用恢复的证书，请调用轮询程序的 wait 方法，该方法会阻止，直到证书可供使用。 wait 方法需要 certificate/get 权限。
返回类型
例外
cancel_certificate_operation
取消正在进行的证书操作。 需要证书/更新权限。
cancel_certificate_operation(certificate_name: str, **kwargs) -> CertificateOperation参数
返回
已取消的证书操作
返回类型
例外
close
关闭客户端打开的套接字。
使用客户端作为上下文管理器时，不需要调用此方法。
close() -> None例外
如果证书不存在，则为
对于其他错误
create_issuer
设置指定的证书颁发者。 需要证书/设置颁发者权限。
create_issuer(issuer_name: str, provider: str, **kwargs) -> CertificateIssuer参数
- enabled
- bool
颁发者是否已启用以供使用。
- account_id
- str
用户名/帐户名称/帐户 ID。
- password
- str
密码/机密/帐户密钥。
- organization_id
- str
组织的 ID
- admin_contacts
- list[AdministratorContact]
证书颁发者的组织管理员的联系人详细信息。
返回
创建的 CertificateIssuer
返回类型
例外
delete_certificate_operation
删除并停止特定证书的创建操作。
需要证书/更新权限。
delete_certificate_operation(certificate_name: str, **kwargs) -> CertificateOperation参数
返回
已删除的 CertificateOperation
返回类型
例外
delete_contacts
删除密钥保管库的证书联系人。 需要 certificates/managecontacts 权限。
delete_contacts(**kwargs) -> List[CertificateContact]返回
密钥保管库的已删除联系人。
返回类型
例外
delete_issuer
删除指定的证书颁发者。
需要 certificates/manageissuers/deleteissuers 权限。
delete_issuer(issuer_name: str, **kwargs) -> CertificateIssuer参数
返回
CertificateIssuer
返回类型
例外
get_certificate
获取附加了其管理策略的证书。 需要证书/获取权限。
不接受证书版本作为参数。 若要获取特定版本的证书，请调用 get_certificate_version。
get_certificate(certificate_name: str, **kwargs) -> KeyVaultCertificate参数
返回
KeyVaultCertificate 的实例
返回类型
例外
如果证书不存在，则为
对于其他错误
get_certificate_operation
获取证书的创建操作。 需要证书/获取权限。
get_certificate_operation(certificate_name: str, **kwargs) -> CertificateOperation参数
返回
创建的 CertificateOperation
返回类型
例外
如果证书不存在，则为
对于其他错误
get_certificate_policy
获取证书的策略。 需要证书/获取权限。
返回密钥保管库中的指定证书策略资源。
get_certificate_policy(certificate_name: str, **kwargs) -> CertificatePolicy参数
返回
证书策略
返回类型
例外
get_certificate_version
获取证书的特定版本，而不返回其管理策略。
需要证书/获取权限。 若要获取最新版本的证书，或也获取证书的策略，请调用 get_certificate。
get_certificate_version(certificate_name: str, version: str, **kwargs) -> KeyVaultCertificate参数
返回
KeyVaultCertificate 的实例
返回类型
例外
如果证书不存在，则为
对于其他错误
get_contacts
获取密钥保管库的证书联系人。 需要 certificates/managecontacts 权限。
get_contacts(**kwargs) -> List[CertificateContact]返回
密钥保管库的证书联系人。
返回类型
例外
get_deleted_certificate
获取已删除的证书。 只能在启用了软删除的保管库中实现。
需要证书/获取权限。 检索已删除的证书信息及其属性，例如保留间隔、计划的永久删除和当前删除恢复级别。
get_deleted_certificate(certificate_name: str, **kwargs) -> DeletedCertificate参数
返回
已删除的证书
返回类型
例外
如果证书不存在，则为
对于其他错误
get_issuer
获取指定的证书颁发者。 需要 certificates/manageissuers/getissuers 权限。
get_issuer(issuer_name: str, **kwargs) -> CertificateIssuer参数
返回
指定的证书颁发者。
返回类型
例外
如果颁发者不存在，则为
对于其他错误
import_certificate
导入在外部创建的证书。 需要证书/导入权限。
将包含私钥的现有有效证书导入 Azure Key Vault。 要导入的证书可以采用 PFX 或 PEM 格式。 如果证书采用 PEM 格式，则 PEM 文件必须包含密钥以及 x509 证书，并且必须提供 policy 的 pem， 。content_type
import_certificate(certificate_name: str, certificate_bytes: bytes, **kwargs) -> KeyVaultCertificate参数
- enabled
- bool
是否启用证书以供使用。
- password
- str
如果传入的 证书中的私钥已加密，则它是用于加密的密码。
- policy
- CertificatePolicy
证书的管理策略。 导入 PEM 格式证书（设置为 content_typepem）时是必需的。
返回
导入的 KeyVaultCertificate
返回类型
例外
list_deleted_certificates
列出当前可恢复的已删除证书。 仅当启用了保管库软删除时，才可能。
需要证书/get/list 权限。 检索当前保管库中处于已删除状态并准备恢复或清除的证书。 此操作包括特定于删除的信息。
list_deleted_certificates(**kwargs) -> ItemPaged[DeletedCertificate]参数
- include_pending
- bool
指定是否包含未完全删除的证书。 仅适用于 API 版本 v7.0 及更新版本。
返回
与迭代器一样的 DeletedCertificate 实例
返回类型
例外
list_properties_of_certificate_versions
列出证书版本的标识符和属性。
需要证书/列表权限。
list_properties_of_certificate_versions(certificate_name: str, **kwargs) -> ItemPaged[CertificateProperties]参数
返回
与迭代器一样的 CertificateProperties 实例
返回类型
例外
list_properties_of_certificates
列出保管库中所有证书的标识符和属性。
需要证书/列表权限。
list_properties_of_certificates(**kwargs) -> ItemPaged[CertificateProperties]参数
- include_pending
- bool
指定是否包括未完全预配的证书。 仅适用于 API 版本 v7.0 及更新版本。
返回
与迭代器一样的 CertificateProperties 实例
返回类型
例外
list_properties_of_issuers
列出密钥保管库的证书颁发者的属性。
需要 certificates/manageissuers/getissuers 权限。
list_properties_of_issuers(**kwargs) -> ItemPaged[IssuerProperties]返回
与迭代器一样的颁发者实例
返回类型
例外
merge_certificate
将证书或证书链与服务器上存在的密钥对合并。
需要证书/创建权限。 将证书或证书链与服务中当前可用的密钥对合并。 在创建要合并的证书时，请确保将其 begin_create_certificate 颁发者设置为“未知”。 这样，密钥保管库知道证书不会由其已知的颁发者签名。
merge_certificate(certificate_name: str, x509_certificates: List[bytes], **kwargs) -> KeyVaultCertificate参数
返回
合并的证书
返回类型
例外
purge_deleted_certificate
永久删除已删除的证书。 只能在启用了软删除的保管库中使用。
需要证书/清除权限。 执行指定证书的不可逆删除操作，无法恢复。 如果未指定“Purgeable”， recovery_level 则操作不可用。 仅当清除证书之前， scheduled_purge_date才需要此方法。
purge_deleted_certificate(certificate_name: str, **kwargs) -> None参数
返回
无
返回类型
例外
restore_certificate_backup
将证书备份还原到保管库。 需要证书/还原权限。
这将还原证书的所有版本及其名称、属性和访问控制策略。 如果证书的名称已在使用中，还原该名称将失败。 此外，目标保管库必须由与源保管库相同的 Microsoft Azure 订阅拥有。
restore_certificate_backup(backup: bytes, **kwargs) -> KeyVaultCertificate参数
返回
还原的 KeyVaultCertificate
返回类型
例外
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_contacts
设置密钥保管库的证书联系人。 需要证书/管理联系人权限。
set_contacts(contacts: List[CertificateContact], **kwargs) -> List[CertificateContact]参数
返回
创建的联系人列表
返回类型
例外
update_certificate_policy
汇报证书的策略。 需要证书/更新权限。
在证书策略中设置指定成员。 将其他人保留为 null。
update_certificate_policy(certificate_name: str, policy: CertificatePolicy, **kwargs) -> CertificatePolicy参数
返回
证书策略
返回类型
例外
update_certificate_properties
更改证书的属性。 需要证书/更新权限。
update_certificate_properties(certificate_name: str, version: str | None = None, **kwargs) -> KeyVaultCertificate参数
- enabled
- bool
是否启用证书以供使用。
返回
更新的 KeyVaultCertificate
返回类型
例外
update_issuer
汇报指定的证书颁发者。 需要证书/设置颁发者权限。
update_issuer(issuer_name: str, **kwargs) -> CertificateIssuer参数
- enabled
- bool
颁发者是否已启用以供使用。
- provider
- str
颁发者提供程序
- account_id
- str
用户名/帐户名称/帐户 ID。
- password
- str
密码/机密/帐户密钥。
- organization_id
- str
组织的 ID
- admin_contacts
- list[AdministratorContact]
证书颁发者的组织管理员的联系人详细信息
返回
更新的颁发者
返回类型
例外
属性
vault_url
反馈
即将发布：在整个 2024 年，我们将逐步淘汰作为内容反馈机制的“GitHub 问题”，并将其取代为新的反馈系统。 有关详细信息，请参阅：https://aka.ms/ContentUserFeedback。
提交和查看相关反馈