CertificateClient クラス
コンテナーの証明書を管理するための大まかなインターフェイス。
- 継承
-
azure.keyvault.certificates._shared.client_base.KeyVaultClientBaseCertificateClient
コンストラクター
CertificateClient(vault_url: str, credential: TokenCredential, **kwargs)パラメーター
- vault_url
- str
クライアントがアクセスするコンテナーの URL。 これは、コンテナーの "DNS 名" とも呼ばれます。 この URL が有効なKey Vault リソースを参照していることを検証する必要があります。 詳細については、https://aka.ms/azsdk/blog/vault-uri を参照してください。
- api_version
- ApiVersion
使用するサービス API のバージョン。 既定値は最新です。
- verify_challenge_resource
- bool
認証チャレンジ リソースがKey Vault ドメインと一致するかどうかを確認するかどうか。 既定値は True です。
メソッド
| backup_certificate |
Azure Key Vaultでのみ使用できる保護された形式で証明書をバックアップします。 証明書/バックアップアクセス許可が必要です。 これは、あるコンテナーから別のコンテナーへの証明書のコピーを許可することを目的としています。 両方のコンテナーは、同じ Azure サブスクリプションによって所有されている必要があります。 また、地政学的境界を越えてバックアップ/復元を実行することはできません。 たとえば、米国リージョンのコンテナーからのバックアップを、EU リージョンのコンテナーに復元することはできません。 |
| begin_create_certificate |
新しい証明書を作成します。 これが最初のバージョンの場合は、証明書リソースが作成されます。 この操作を行うには、証明書/作成アクセス許可が必要です。 返されたポーリングャーを待機するには、証明書/取得アクセス許可が必要であり、作成が成功した場合は証明書を、そうでない場合は CertificateOperation を提供します。それ以外の場合は、 が HttpResponseError発生します。 |
| begin_delete_certificate |
証明書のすべてのバージョンを削除します。 証明書/削除アクセス許可が必要です。 このメソッドが返されると、証明書の削除が開始Key Vault。 論理的な削除が有効になっているコンテナーでは、削除に数秒かかる場合があります。 したがって、このメソッドはポーリングを返し、削除が完了するまで待機できるようにします。 |
| begin_recover_deleted_certificate |
削除された証明書を最新バージョンに回復します。 論理的な削除が有効になっているコンテナーでのみ可能です。 証明書/回復アクセス許可が必要です。 このメソッドがを返すと、証明書の回復が開始Key Vault。 回復には数秒かかる場合があります。 したがって、このメソッドはポーリングを返し、復旧が完了するまで待機できるようにします。 待機は、回復された証明書を別の操作ですぐに使用する場合にのみ必要です。 |
| cancel_certificate_operation |
進行中の証明書操作を取り消します。 証明書/更新アクセス許可が必要です。 |
| close |
クライアントによって開かれたソケットを閉じます。 クライアントをコンテキスト マネージャーとして使用する場合、このメソッドの呼び出しは不要です。 |
| create_issuer |
指定した証明書発行者を設定します。 証明書/setissuers アクセス許可が必要です。 |
| delete_certificate_operation |
特定の証明書の作成操作を削除して停止します。 証明書/更新アクセス許可が必要です。 |
| delete_contacts |
キー コンテナーの証明書の連絡先を削除します。 証明書/managecontacts アクセス許可が必要です。 |
| delete_issuer |
指定した証明書発行者を削除します。 証明書/manageissuers/deleteissuers アクセス許可が必要です。 |
| get_certificate |
管理ポリシーがアタッチされた証明書を取得します。 証明書/取得アクセス許可が必要です。 証明書のバージョンをパラメーターとして受け入れない。 証明書の特定のバージョンを取得するには、 を呼び出します get_certificate_version。 |
| get_certificate_operation |
証明書の作成操作を取得します。 証明書/取得アクセス許可が必要です。 |
| get_certificate_policy |
証明書のポリシーを取得します。 証明書/取得アクセス許可が必要です。 キー コンテナー内の指定された証明書ポリシー リソースを返します。 |
| get_certificate_version |
管理ポリシーを返さずに、証明書の特定のバージョンを取得します。 証明書/取得アクセス許可が必要です。 最新バージョンの証明書を取得したり、証明書のポリシーを取得したりするには、 を呼び出します get_certificate。 |
| get_contacts |
キー コンテナーの証明書の連絡先を取得します。 証明書/managecontacts アクセス許可が必要です。 |
| get_deleted_certificate |
削除された証明書を取得します。 論理的な削除が有効になっているコンテナーでのみ可能です。 証明書/取得アクセス許可が必要です。 削除された証明書情報とその属性 (保持間隔、スケジュールされた完全削除、現在の削除復旧レベルなど) を取得します。 |
| get_issuer |
指定した証明書発行者を取得します。 証明書/manageissuers/getissuers アクセス許可が必要です。 |
| import_certificate |
外部で作成された証明書をインポートします。 証明書/インポートアクセス許可が必要です。 秘密キーを含む、既存の有効な証明書を Azure Key Vault にインポートします。 インポートする証明書は、PFX または PEM 形式にすることができます。 証明書が PEM 形式の場合、PEM ファイルにはキーと x509 証明書が含まれている必要があり、 を 指定 |
| list_deleted_certificates |
現在回復可能な削除済み証明書を一覧表示します。 コンテナーが論理的な削除が有効になっている場合にのみ可能です。 証明書/取得/一覧のアクセス許可が必要です。 現在のコンテナー内の証明書を取得します。この証明書は削除された状態で、回復または消去の準備ができています。 この操作には、削除固有の情報が含まれます。 |
| list_properties_of_certificate_versions |
証明書のバージョンの識別子とプロパティを一覧表示します。 証明書/リストのアクセス許可が必要です。 |
| list_properties_of_certificates |
コンテナー内のすべての証明書の識別子とプロパティを一覧表示します。 証明書/リストのアクセス許可が必要です。 |
| list_properties_of_issuers |
キー コンテナーの証明書発行者のプロパティを一覧表示します。 証明書/manageissuers/getissuers アクセス許可が必要です。 |
| merge_certificate |
証明書または証明書チェーンを、サーバー上に存在するキー ペアとマージします。 証明書/作成アクセス許可が必要です。 サービスで現在使用できるキー ペアを使用して、証明書または証明書チェーンのマージを実行します。 を使用して begin_create_certificate マージする証明書を作成するときは、その発行者を 'Unknown' に設定してください。 このようにKey Vaultは、証明書が認識されている発行者によって署名されないことを認識します。 |
| 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 |
指定した証明書発行者を更新します。 証明書/setissuers アクセス許可が必要です。 |
backup_certificate
Azure Key Vaultでのみ使用できる保護された形式で証明書をバックアップします。
証明書/バックアップアクセス許可が必要です。 これは、あるコンテナーから別のコンテナーへの証明書のコピーを許可することを目的としています。 両方のコンテナーは、同じ Azure サブスクリプションによって所有されている必要があります。 また、地政学的境界を越えてバックアップ/復元を実行することはできません。 たとえば、米国リージョンのコンテナーからのバックアップを、EU リージョンのコンテナーに復元することはできません。
backup_certificate(certificate_name: str, **kwargs) -> bytesパラメーター
戻り値
バックアップされた証明書を含むバックアップ BLOB。
の戻り値の型 :
例外
証明書が存在しない場合は、
その他のエラーの場合
begin_create_certificate
新しい証明書を作成します。
これが最初のバージョンの場合は、証明書リソースが作成されます。 この操作を行うには、証明書/作成アクセス許可が必要です。 返されたポーリングャーを待機するには、証明書/取得アクセス許可が必要であり、作成が成功した場合は証明書を、そうでない場合は CertificateOperation を提供します。それ以外の場合は、 が HttpResponseError発生します。
begin_create_certificate(certificate_name: str, policy: CertificatePolicy, **kwargs) -> LROPoller[KeyVaultCertificate | CertificateOperation]パラメーター
- enabled
- bool
証明書の使用が有効になっているかどうか。
戻り値
証明書の作成操作の LROPoller。 ポーリングを待機すると、作成が成功した場合は証明書が、そうでない場合は CertificateOperation が提供されます。
の戻り値の型 :
例外
証明書ポリシーが無効な場合は、
その他のエラーの場合は 。
begin_delete_certificate
証明書のすべてのバージョンを削除します。 証明書/削除アクセス許可が必要です。
このメソッドが返されると、証明書の削除が開始Key Vault。 論理的な削除が有効になっているコンテナーでは、削除に数秒かかる場合があります。 したがって、このメソッドはポーリングを返し、削除が完了するまで待機できるようにします。
begin_delete_certificate(certificate_name: str, **kwargs) -> LROPoller[DeletedCertificate]パラメーター
戻り値
証明書の削除操作の投票者。 ポーリングの 結果 メソッドは、削除の完了を待たずに を DeletedCertificate 返します。 コンテナーで論理的な削除が有効になっており、すぐに証明書を完全に削除する場合は、 を使用 purge_deleted_certificateしてポーリング者の 待機 メソッドを最初に呼び出します。 削除が完了するまでブロックされます。 wait メソッドには、証明書/取得アクセス許可が必要です。
の戻り値の型 :
例外
証明書が存在しない場合は、
その他のエラーの場合
begin_recover_deleted_certificate
削除された証明書を最新バージョンに回復します。 論理的な削除が有効になっているコンテナーでのみ可能です。
証明書/回復アクセス許可が必要です。 このメソッドがを返すと、証明書の回復が開始Key Vault。 回復には数秒かかる場合があります。 したがって、このメソッドはポーリングを返し、復旧が完了するまで待機できるようにします。 待機は、回復された証明書を別の操作ですぐに使用する場合にのみ必要です。
begin_recover_deleted_certificate(certificate_name: str, **kwargs) -> LROPoller[KeyVaultCertificate]パラメーター
戻り値
回復操作のポーリング者。 ポーリングの 結果 メソッドは、回復が完了するまで待たずに、回復された KeyVaultCertificate を返します。 回復した証明書をすぐに使用する場合は、ポーリングャーの 待機 メソッドを呼び出します。このメソッドは、証明書を使用する準備ができるまでブロックします。 wait メソッドには、証明書/取得アクセス許可が必要です。
の戻り値の型 :
例外
cancel_certificate_operation
進行中の証明書操作を取り消します。 証明書/更新アクセス許可が必要です。
cancel_certificate_operation(certificate_name: str, **kwargs) -> CertificateOperationパラメーター
戻り値
取り消された証明書操作
の戻り値の型 :
例外
close
クライアントによって開かれたソケットを閉じます。
クライアントをコンテキスト マネージャーとして使用する場合、このメソッドの呼び出しは不要です。
close() -> None例外
証明書が存在しない場合は、
その他のエラーの場合
create_issuer
指定した証明書発行者を設定します。 証明書/setissuers アクセス許可が必要です。
create_issuer(issuer_name: str, provider: str, **kwargs) -> CertificateIssuerパラメーター
- enabled
- bool
発行者が使用を有効にしているかどうか。
- account_id
- str
ユーザー名/アカウント名/アカウント ID。
- password
- str
パスワード/シークレット/アカウント キー。
- organization_id
- str
organizationの ID
- admin_contacts
- list[AdministratorContact]
証明書発行者のorganization管理者の詳細に問い合わせてください。
戻り値
作成された CertificateIssuer
の戻り値の型 :
例外
delete_certificate_operation
特定の証明書の作成操作を削除して停止します。
証明書/更新アクセス許可が必要です。
delete_certificate_operation(certificate_name: str, **kwargs) -> CertificateOperationパラメーター
戻り値
削除された CertificateOperation
の戻り値の型 :
例外
delete_contacts
キー コンテナーの証明書の連絡先を削除します。 証明書/managecontacts アクセス許可が必要です。
delete_contacts(**kwargs) -> List[CertificateContact]戻り値
キー コンテナーの削除された連絡先。
の戻り値の型 :
例外
delete_issuer
指定した証明書発行者を削除します。
証明書/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
キー コンテナーの証明書の連絡先を取得します。 証明書/managecontacts アクセス許可が必要です。
get_contacts(**kwargs) -> List[CertificateContact]戻り値
キー コンテナーの証明書の連絡先。
の戻り値の型 :
例外
get_deleted_certificate
削除された証明書を取得します。 論理的な削除が有効になっているコンテナーでのみ可能です。
証明書/取得アクセス許可が必要です。 削除された証明書情報とその属性 (保持間隔、スケジュールされた完全削除、現在の削除復旧レベルなど) を取得します。
get_deleted_certificate(certificate_name: str, **kwargs) -> DeletedCertificateパラメーター
戻り値
削除された証明書
の戻り値の型 :
例外
証明書が存在しない場合は、
その他のエラーの場合
get_issuer
指定した証明書発行者を取得します。 証明書/manageissuers/getissuers アクセス許可が必要です。
get_issuer(issuer_name: str, **kwargs) -> CertificateIssuerパラメーター
戻り値
指定した証明書発行者。
の戻り値の型 :
例外
発行者が存在しない場合は、
その他のエラーの場合
import_certificate
外部で作成された証明書をインポートします。 証明書/インポートアクセス許可が必要です。
秘密キーを含む、既存の有効な証明書を Azure Key Vault にインポートします。 インポートする証明書は、PFX または PEM 形式にすることができます。 証明書が PEM 形式の場合、PEM ファイルにはキーと x509 証明書が含まれている必要があり、 を 指定 policycontent_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 バージョン 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
キー コンテナーの証明書発行者のプロパティを一覧表示します。
証明書/manageissuers/getissuers アクセス許可が必要です。
list_properties_of_issuers(**kwargs) -> ItemPaged[IssuerProperties]戻り値
Issuers の反復子のようなインスタンス
の戻り値の型 :
例外
merge_certificate
証明書または証明書チェーンを、サーバー上に存在するキー ペアとマージします。
証明書/作成アクセス許可が必要です。 サービスで現在使用できるキー ペアを使用して、証明書または証明書チェーンのマージを実行します。 を使用して begin_create_certificate マージする証明書を作成するときは、その発行者を 'Unknown' に設定してください。 このようにKey Vaultは、証明書が認識されている発行者によって署名されないことを認識します。
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
指定した証明書発行者を更新します。 証明書/setissuers アクセス許可が必要です。
update_issuer(issuer_name: str, **kwargs) -> CertificateIssuerパラメーター
- enabled
- bool
発行者の使用が有効になっているかどうか。
- provider
- str
発行者プロバイダー
- account_id
- str
ユーザー名/アカウント名/アカウント ID。
- password
- str
パスワード/シークレット/アカウント キー。
- organization_id
- str
organizationの ID
- admin_contacts
- list[AdministratorContact]
証明書発行者のorganization管理者の連絡先の詳細
戻り値
更新された発行者
の戻り値の型 :
例外
属性
vault_url
Azure SDK for Python