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 |
建立新的憑證。 如果這是第一個版本，則會建立憑證資源。 此作業須有憑證/建立權限。 等候傳回的輪詢器需要憑證/取得許可權，並在建立成功時提供憑證，否則會引發 HttpResponseError CertificateOperation 。 |
| begin_delete_certificate |
刪除所有版本的憑證。 需要憑證/刪除許可權。 當這個方法傳回金鑰保存庫開始刪除憑證時。 在已啟用虛刪除的保存庫中，刪除可能需要幾秒鐘的時間。 因此，此方法會傳回輪詢器，讓您等候刪除完成。 |
| begin_recover_deleted_certificate |
將已刪除的憑證復原至其最新版本。 只能在已啟用虛刪除的保存庫中進行。 需要憑證/復原許可權。 當這個方法傳回金鑰保存庫開始復原憑證時。 復原可能需要幾秒鐘的時間。 因此，此方法會傳回輪詢器，讓您等候復原完成。 只有在您想要立即在另一個作業中使用復原的憑證時，才需要等候。 |
| cancel_certificate_operation |
取消進行中的憑證作業。 需要憑證/更新許可權。 |
| close |
關閉用戶端開啟的通訊端。 使用用戶端作為內容管理員時，不需要呼叫這個方法。 |
| create_issuer |
設定指定的憑證簽發者。 需要 certificates/setissuers 許可權。 |
| delete_certificate_operation |
刪除並停止特定憑證的建立作業。 需要憑證/更新許可權。 |
| delete_contacts |
刪除金鑰保存庫的憑證連絡人。 需要憑證/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 金鑰保存庫。 要匯入的憑證可以是 PFX 或 PEM 格式。 如果憑證採用 PEM 格式，PEM 檔案必須包含金鑰和 x509 憑證，而且您必須提供 |
| list_deleted_certificates |
列出目前可復原的已刪除憑證。 只有在已啟用虛刪除保存庫時才可行。 需要憑證/取得/列出許可權。 擷取目前保存庫中處於已刪除狀態且已準備好復原或清除的憑證。 此作業包含刪除特定資訊。 |
| list_properties_of_certificate_versions |
列出憑證版本的識別碼和屬性。 需要憑證/清單許可權。 |
| list_properties_of_certificates |
列出保存庫中所有憑證的識別碼和屬性。 需要憑證/清單許可權。 |
| list_properties_of_issuers |
列出金鑰保存庫之憑證簽發者的屬性。 需要 certificates/manageissuers/getissuers 許可權。 |
| merge_certificate |
將憑證或憑證鏈結與伺服器上現有的金鑰組合並。 須有憑證/建立權限。 執行憑證或憑證鏈結與服務中目前可用的金鑰組合並。 請確定建立憑證時，請使用 begin_create_certificate 將憑證簽發者設定為 「未知」。 如此一來，金鑰保存庫知道憑證不會由已知的簽發者簽署。 |
| purge_deleted_certificate |
永久刪除已刪除的憑證。 只能在已啟用虛刪除的保存庫中進行。 需要憑證/清除許可權。 執行無法復原的指定憑證刪除，而無法復原。 如果 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 |
設定金鑰保存庫的憑證連絡人。 需要憑證/managecontacts 許可權。 |
| update_certificate_policy |
更新憑證的原則。 需要憑證/更新許可權。 在憑證原則中設定指定的成員。 將其他人保留為 Null。 |
| update_certificate_properties |
變更憑證的屬性。 需要憑證/更新許可權。 |
| update_issuer |
更新指定的憑證簽發者。 需要 certificates/setissuers 許可權。 |
backup_certificate
備份受保護表單中的憑證，僅供 Azure 金鑰保存庫使用。
需要憑證/備份許可權。 這是為了允許將憑證從一個保存庫複製到另一個保存庫。 這兩個保存庫都必須由相同的 Azure 訂用帳戶擁有。 此外，無法跨地理政治界限執行備份/還原。 例如，美國地區的保存庫備份無法還原到歐盟區域中的保存庫。
backup_certificate(certificate_name: str, **kwargs) -> bytes參數
傳回
包含備份憑證的備份 Blob。
傳回類型
例外狀況
如果憑證不存在，則為
其他錯誤
begin_create_certificate
建立新的憑證。
如果這是第一個版本，則會建立憑證資源。 此作業須有憑證/建立權限。 等候傳回的輪詢器需要憑證/取得許可權，並在建立成功時提供憑證，否則會引發 HttpResponseError CertificateOperation 。
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 憑證，請先呼叫輪詢器的 等候 方法。 它會封鎖，直到刪除完成為止。 等候方法需要憑證/取得許可權。
傳回類型
例外狀況
如果憑證不存在，則為
其他錯誤
begin_recover_deleted_certificate
將已刪除的憑證復原至其最新版本。 只能在已啟用虛刪除的保存庫中進行。
需要憑證/復原許可權。 當這個方法傳回金鑰保存庫開始復原憑證時。 復原可能需要幾秒鐘的時間。 因此，此方法會傳回輪詢器，讓您等候復原完成。 只有在您想要立即在另一個作業中使用復原的憑證時，才需要等候。
begin_recover_deleted_certificate(certificate_name: str, **kwargs) -> LROPoller[KeyVaultCertificate]參數
傳回
復原作業的輪詢器。 輪詢器 的結果 方法會傳回已 KeyVaultCertificate 復原，而不需要等待復原完成。 如果您想要立即使用復原的憑證，請呼叫輪詢器的 等候 方法，這會封鎖直到憑證準備好使用為止。 等候方法需要憑證/取得許可權。
傳回類型
例外狀況
cancel_certificate_operation
取消進行中的憑證作業。 需要憑證/更新許可權。
cancel_certificate_operation(certificate_name: str, **kwargs) -> CertificateOperation參數
傳回
已取消的憑證作業
傳回類型
例外狀況
close
關閉用戶端開啟的通訊端。
使用用戶端作為內容管理員時，不需要呼叫這個方法。
close() -> None例外狀況
如果憑證不存在，則為
其他錯誤
create_issuer
設定指定的憑證簽發者。 需要 certificates/setissuers 許可權。
create_issuer(issuer_name: str, provider: str, **kwargs) -> CertificateIssuer參數
- enabled
- bool
是否啟用簽發者以供使用。
- account_id
- str
使用者名稱/帳戶名稱/帳戶識別碼。
- password
- str
密碼/秘密/帳戶金鑰。
- organization_id
- str
組織的識別碼
- admin_contacts
- list[AdministratorContact]
憑證簽發者的組織系統管理員連絡詳細資料。
傳回
已建立的 CertificateIssuer
傳回類型
例外狀況
delete_certificate_operation
刪除並停止特定憑證的建立作業。
需要憑證/更新許可權。
delete_certificate_operation(certificate_name: str, **kwargs) -> CertificateOperation參數
傳回
已刪除的 CertificateOperation
傳回類型
例外狀況
delete_contacts
刪除金鑰保存庫的憑證連絡人。 需要憑證/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 金鑰保存庫。 要匯入的憑證可以是 PFX 或 PEM 格式。 如果憑證採用 PEM 格式，PEM 檔案必須包含金鑰和 x509 憑證，而且您必須提供 policy 的 content_typepem 。
import_certificate(certificate_name: str, certificate_bytes: bytes, **kwargs) -> KeyVaultCertificate參數
- enabled
- bool
憑證是否已啟用以供使用。
- password
- str
如果傳入憑證中的私密金鑰已加密，則會是用於加密的密碼。
- policy
- CertificatePolicy
憑證的管理原則。 如果匯入 PEM 格式憑證，則為 必要專案，並將 content_type 設定為 pem 。
傳回
匯入的 KeyVaultCertificate
傳回類型
例外狀況
list_deleted_certificates
列出目前可復原的已刪除憑證。 只有在已啟用虛刪除保存庫時才可行。
需要憑證/取得/列出許可權。 擷取目前保存庫中處於已刪除狀態且已準備好復原或清除的憑證。 此作業包含刪除特定資訊。
list_deleted_certificates(**kwargs) -> ItemPaged[DeletedCertificate]參數
- include_pending
- bool
指定是否要包含未完全刪除的憑證。 僅適用于 API 7.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 7.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
永久刪除已刪除的憑證。 只能在已啟用虛刪除的保存庫中進行。
需要憑證/清除許可權。 執行無法復原的指定憑證刪除，而無法復原。 如果 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
設定金鑰保存庫的憑證連絡人。 需要憑證/managecontacts 許可權。
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
更新指定的憑證簽發者。 需要 certificates/setissuers 許可權。
update_issuer(issuer_name: str, **kwargs) -> CertificateIssuer參數
- enabled
- bool
是否啟用簽發者以供使用。
- provider
- str
簽發者提供者
- account_id
- str
使用者名稱/帳戶名稱/帳戶識別碼。
- password
- str
密碼/秘密/帳戶金鑰。
- organization_id
- str
組織的識別碼
- admin_contacts
- list[AdministratorContact]
憑證簽發者的組織系統管理員連絡詳細資料
傳回
更新的簽發者
