KeyClient クラス
コンテナーのキーを管理するための高レベルのインターフェイス。
- 継承
-
azure.keyvault.keys._shared.client_base.KeyVaultClientBaseKeyClient
コンストラクター
KeyClient(vault_url: str, credential: TokenCredential, **kwargs)パラメーター
- vault_url
- str
クライアントがアクセスするコンテナーの URL。 これは、コンテナーの "DNS 名" とも呼ばれます。 この URL が有効なKey Vaultまたはマネージド HSM リソースを参照していることを検証する必要があります。 詳細については、https://aka.ms/azsdk/blog/vault-uri を参照してください。
- api_version
- ApiVersion
使用するサービス API のバージョン。 既定値は最新です。
- verify_challenge_resource
- bool
認証チャレンジ リソースがKey Vaultドメインとマネージド HSM ドメインのどちらと一致するかを確認します。 既定値は True です。
メソッド
| backup_key |
Azure Key Vaultでのみ使用できる保護された形式でキーをバックアップします。 キー/バックアップアクセス許可が必要です。 これは、あるコンテナーから別のコンテナーにキーをコピーできるようにするためです。 両方のコンテナーは、同じ Azure サブスクリプションによって所有されている必要があります。 また、地政学的境界を越えてバックアップ/復元を実行することはできません。 たとえば、米国リージョンのコンテナーからのバックアップを、EU リージョンのコンテナーに復元することはできません。 |
| begin_delete_key |
キーとその暗号化マテリアルのすべてのバージョンを削除します。 キー/削除アクセス許可が必要です。 このメソッドがを返すと、キーの削除が開始Key Vault。 論理的な削除が有効になっているコンテナーでは、削除に数秒かかる場合があります。 したがって、このメソッドはポーリングを返し、削除が完了するまで待機できるようにします。 |
| begin_recover_deleted_key |
削除されたキーを最新バージョンに回復します。 論理的な削除が有効になっているコンテナーでのみ可能です。 キー/回復アクセス許可が必要です。 このメソッドがを返すと、キーの回復が開始Key Vault。 回復には数秒かかる場合があります。 したがって、このメソッドはポーリングを返し、復旧が完了するまで待機できるようにします。 待機は、回復されたキーを別の操作ですぐに使用する場合にのみ必要です。 |
| close |
クライアントによって開かれたソケットを閉じます。 クライアントをコンテキスト マネージャーとして使用する場合、このメソッドの呼び出しは不要です。 |
| create_ec_key |
新しい楕円曲線キーを作成するか、既に使用されている場合 キー/作成のアクセス許可が必要です。 |
| create_key |
キーを作成するか、既に使用されている場合 キー/作成アクセス許可が必要です。 |
| create_oct_key |
新しいオクテット シーケンス (対称) キーを作成するか、使用中の場合 キー/作成のアクセス許可が必要です。 |
| create_rsa_key |
新しい RSA キーを作成するか、既に使用されている場合 キー/作成のアクセス許可が必要です。 |
| get_cryptography_client |
指定された CryptographyClient キーの を取得します。 |
| get_deleted_key |
削除されたキーを取得します。 論理的な削除が有効になっているコンテナーでのみ可能です。 キー/取得アクセス許可が必要です。 |
| get_key |
キーの属性を取得し、非対称キーの場合は公開資料を取得します。 キー/取得アクセス許可が必要です。 |
| get_key_rotation_policy |
Key Vault キーのローテーション ポリシーを取得します。 |
| get_random_bytes |
マネージド HSM から要求されたランダム バイト数を取得します。 |
| import_key |
外部で作成されたキーをインポートします。 キー/インポートアクセス許可が必要です。 が既に使用されている場合 |
| list_deleted_keys |
削除されたすべてのキー (各のパブリック部分を含む) を一覧表示します。 論理的な削除が有効になっているコンテナーでのみ可能です。 キー/リストのアクセス許可が必要です。 |
| list_properties_of_key_versions |
キーのバージョンの識別子とプロパティを一覧表示します。 キー/リストのアクセス許可が必要です。 |
| list_properties_of_keys |
コンテナー内のすべてのキーの識別子とプロパティを一覧表示します。 キー/リストのアクセス許可が必要です。 |
| purge_deleted_key |
削除されたキーを完全に削除します。 論理的な削除が有効になっているコンテナーでのみ可能です。 指定したキーを元に戻すことができない削除を実行します。回復の可能性はありません。 が 'Purgeable' を指定していない場合 recovery_level 、操作は使用できません。 このメソッドは、 の前 scheduled_purge_dateのキーを消去する場合にのみ必要です。 キー/消去アクセス許可が必要です。 |
| release_key |
キーを解放します。 リリース キー操作は、すべてのキーの種類に適用できます。 ターゲット キーはエクスポート可能とマークする必要があります。 この操作には、キー/リリースのアクセス許可が必要です。 |
| restore_key_backup |
キー バックアップをコンテナーに復元します。 キー/復元アクセス許可が必要です。 これにより、名前、属性、アクセス制御ポリシーを使用して、すべてのバージョンのキーがインポートされます。 キーの名前が既に使用されている場合、復元は失敗します。 また、ターゲット コンテナーは、ソース コンテナーと同じ Microsoft Azure サブスクリプションによって所有されている必要があります。 |
| rotate_key |
キーの新しいバージョンを生成して、キー ポリシーに基づいてキーをローテーションします。 この操作には、キー/回転アクセス許可が必要です。 |
| send_request |
クライアントの既存のパイプラインを使用してネットワーク要求を実行します。 要求 URL は、コンテナー URL を基準にして指定できます。 要求に使用されるサービス API のバージョンは、特に指定がない限り、クライアントと同じです。 応答がエラーの場合、このメソッドは発生しません。例外を発生させる場合は、返された応答オブジェクト に対して raise_for_status() を呼び出します。 このメソッドを使用してカスタム要求を送信する方法の詳細については、「」を参照してください https://aka.ms/azsdk/dpcodegen/python/send_request。 |
| update_key_properties |
(暗号化マテリアルではなく) キーのプロパティを変更します。 キー/更新アクセス許可が必要です。 |
| update_key_rotation_policy |
Key Vault キーのローテーション ポリシーを更新します。 この操作には、キー/更新アクセス許可が必要です。 |
backup_key
Azure Key Vaultでのみ使用できる保護された形式でキーをバックアップします。
キー/バックアップアクセス許可が必要です。
これは、あるコンテナーから別のコンテナーにキーをコピーできるようにするためです。 両方のコンテナーは、同じ Azure サブスクリプションによって所有されている必要があります。 また、地政学的境界を越えてバックアップ/復元を実行することはできません。 たとえば、米国リージョンのコンテナーからのバックアップを、EU リージョンのコンテナーに復元することはできません。
backup_key(name: str, **kwargs) -> bytesパラメーター
の戻り値の型 :
例外
キーが存在しない場合は、
その他のエラーの場合
begin_delete_key
キーとその暗号化マテリアルのすべてのバージョンを削除します。
キー/削除アクセス許可が必要です。 このメソッドがを返すと、キーの削除が開始Key Vault。 論理的な削除が有効になっているコンテナーでは、削除に数秒かかる場合があります。 したがって、このメソッドはポーリングを返し、削除が完了するまで待機できるようにします。
begin_delete_key(name: str, **kwargs) -> LROPoller[DeletedKey]パラメーター
戻り値
キーの削除操作のポーリング。 ポーリングの 結果 メソッドは、削除の完了を待たずに を DeletedKey 返します。 コンテナーで論理的な削除が有効になっており、 を使用してキー purge_deleted_keyを完全に削除する場合は、まずポーリングの 待機 メソッドを呼び出します。 削除が完了するまでブロックされます。 wait メソッドには、キー/取得アクセス許可が必要です。
の戻り値の型 :
例外
キーが存在しない場合は、
その他のエラーの場合
begin_recover_deleted_key
削除されたキーを最新バージョンに回復します。 論理的な削除が有効になっているコンテナーでのみ可能です。
キー/回復アクセス許可が必要です。
このメソッドがを返すと、キーの回復が開始Key Vault。 回復には数秒かかる場合があります。 したがって、このメソッドはポーリングを返し、復旧が完了するまで待機できるようにします。 待機は、回復されたキーを別の操作ですぐに使用する場合にのみ必要です。
begin_recover_deleted_key(name: str, **kwargs) -> LROPoller[KeyVaultKey]パラメーター
戻り値
回復操作のポーリング者。 ポーリングの 結果 メソッドは、回復が完了するまで待たずに、回復された KeyVaultKey を返します。 回復されたキーをすぐに使用する場合は、ポーリングの 待機 メソッドを呼び出します。これにより、キーを使用する準備が整うまでブロックされます。 wait メソッドには、キー/取得アクセス許可が必要です。
の戻り値の型 :
例外
close
クライアントによって開かれたソケットを閉じます。
クライアントをコンテキスト マネージャーとして使用する場合、このメソッドの呼び出しは不要です。
close() -> None例外
キーが存在しない場合は、
その他のエラーの場合
create_ec_key
新しい楕円曲線キーを作成するか、既に使用されている場合 name は、新しいバージョンのキーを作成します。
キー/作成のアクセス許可が必要です。
create_ec_key(name: str, **kwargs) -> KeyVaultKeyパラメーター
- curve
- KeyCurveName または str または None
楕円曲線名。 既定値は NIST P-256 楕円曲線です。
- key_operations
- list[KeyOperation または str] または None
許可されているキー操作
- release_policy
- KeyReleasePolicy または None
キーをエクスポートできるポリシー ルール。
戻り値
作成されたキー
の戻り値の型 :
例外
create_key
キーを作成するか、既に使用されている場合 name は、新しいバージョンのキーを作成します。
キー/作成アクセス許可が必要です。
create_key(name: str, key_type: str | KeyType, **kwargs) -> KeyVaultKeyパラメーター
キー サイズ (ビット単位)。 RSA キーと対称キーにのみ適用されます。 代わりに または create_oct_key を使用create_rsa_keyすることを検討してください。
- curve
- KeyCurveName または str または None
楕円曲線名。 楕円曲線キーにのみ適用されます。 既定値は NIST P-256 楕円曲線です。 楕円曲線キーを作成するには、代わりに を使用 create_ec_key することを検討してください。
- key_operations
- list[KeyOperation または str] または None
許可されているキー操作
- release_policy
- KeyReleasePolicy または None
キーをエクスポートできるポリシー ルール。
戻り値
作成されたキー
の戻り値の型 :
例外
create_oct_key
新しいオクテット シーケンス (対称) キーを作成するか、使用中の場合 name は新しいバージョンのキーを作成します。
キー/作成のアクセス許可が必要です。
create_oct_key(name: str, **kwargs) -> KeyVaultKeyパラメーター
- key_operations
- list[KeyOperation または str] または None
許可されたキー操作。
- release_policy
- KeyReleasePolicy または None
キーをエクスポートできるポリシー ルール。
戻り値
作成されたキー
の戻り値の型 :
例外
create_rsa_key
新しい RSA キーを作成するか、既に使用されている場合 name は、新しいバージョンのキーを作成します
キー/作成のアクセス許可が必要です。
create_rsa_key(name: str, **kwargs) -> KeyVaultKeyパラメーター
- key_operations
- list[KeyOperation または str] または None
許可されたキー操作
- release_policy
- KeyReleasePolicy または None
キーをエクスポートできるポリシー ルール。
戻り値
作成されたキー
の戻り値の型 :
例外
get_cryptography_client
指定された CryptographyClient キーの を取得します。
get_cryptography_client(key_name: str, **kwargs) -> CryptographyClientパラメーター
- key_version
- str
暗号化操作の実行に使用されるキーのオプション バージョン。
戻り値
CryptographyClientこの KeyClientと同じオプション、資格情報、および HTTP クライアントを使用する 。
の戻り値の型 :
例外
キーが存在しない場合は、
その他のエラーの場合
get_deleted_key
削除されたキーを取得します。 論理的な削除が有効になっているコンテナーでのみ可能です。
キー/取得アクセス許可が必要です。
get_deleted_key(name: str, **kwargs) -> DeletedKeyパラメーター
戻り値
削除されたキー
の戻り値の型 :
例外
キーが存在しない場合は、
その他のエラー
get_key
キーの属性を取得し、非対称キーの場合は公開資料を取得します。
キー/取得アクセス許可が必要です。
get_key(name: str, version: str | None = None, **kwargs) -> KeyVaultKeyパラメーター
の戻り値の型 :
例外
キーが存在しない場合は、
その他のエラー
get_key_rotation_policy
Key Vault キーのローテーション ポリシーを取得します。
get_key_rotation_policy(key_name: str, **kwargs) -> KeyRotationPolicyパラメーター
戻り値
キー ローテーション ポリシー。
の戻り値の型 :
例外
get_random_bytes
マネージド HSM から要求されたランダム バイト数を取得します。
get_random_bytes(count: int, **kwargs) -> bytesパラメーター
戻り値
ランダム バイト。
の戻り値の型 :
例外
1 バイト未満のランダム バイトが要求された場合は、
その他のエラー
import_key
外部で作成されたキーをインポートします。
キー/インポートアクセス許可が必要です。 が既に使用されている場合 name 、キーは新しいバージョンとしてインポートされます。
import_key(name: str, key: JsonWebKey, **kwargs) -> KeyVaultKeyパラメーター
- release_policy
- KeyReleasePolicy または None
キーをエクスポートできるポリシー ルール。
戻り値
インポートされたキー
の戻り値の型 :
例外
list_deleted_keys
削除されたすべてのキー (各のパブリック部分を含む) を一覧表示します。 論理的な削除が有効になっているコンテナーでのみ可能です。
キー/リストのアクセス許可が必要です。
list_deleted_keys(**kwargs) -> ItemPaged[DeletedKey]戻り値
削除されたキーの反復子
の戻り値の型 :
例外
キーが存在しない場合は、
その他のエラーの場合
list_properties_of_key_versions
キーのバージョンの識別子とプロパティを一覧表示します。
キー/リストのアクセス許可が必要です。
list_properties_of_key_versions(name: str, **kwargs) -> ItemPaged[KeyProperties]パラメーター
戻り値
暗号化マテリアルのないキーの反復子
の戻り値の型 :
例外
キーが存在しない場合は、
その他のエラーの場合
list_properties_of_keys
コンテナー内のすべてのキーの識別子とプロパティを一覧表示します。
キー/リストのアクセス許可が必要です。
list_properties_of_keys(**kwargs) -> ItemPaged[KeyProperties]戻り値
暗号化マテリアルまたはバージョン情報のないキーの反復子
の戻り値の型 :
例外
キーが存在しない場合は、
その他のエラーの場合
purge_deleted_key
削除されたキーを完全に削除します。 論理的な削除が有効になっているコンテナーでのみ可能です。
指定したキーを元に戻すことができない削除を実行します。回復の可能性はありません。 が 'Purgeable' を指定していない場合 recovery_level 、操作は使用できません。 このメソッドは、 の前 scheduled_purge_dateのキーを消去する場合にのみ必要です。
キー/消去アクセス許可が必要です。
purge_deleted_key(name: str, **kwargs) -> Noneパラメーター
戻り値
なし
例外
例
# if the vault has soft-delete enabled, purge permanently deletes a deleted key
# (with soft-delete disabled, begin_delete_key is permanent)
key_client.purge_deleted_key("key-name")
release_key
キーを解放します。
リリース キー操作は、すべてのキーの種類に適用できます。 ターゲット キーはエクスポート可能とマークする必要があります。 この操作には、キー/リリースのアクセス許可が必要です。
release_key(name: str, target_attestation_token: str, **kwargs) -> ReleaseKeyResultパラメーター
- algorithm
- str または KeyExportEncryptionAlgorithm または None
解放されたキーマテリアルを保護するために使用する暗号化アルゴリズム。
戻り値
キーリリースの結果。
の戻り値の型 :
例外
restore_key_backup
キー バックアップをコンテナーに復元します。
キー/復元アクセス許可が必要です。
これにより、名前、属性、アクセス制御ポリシーを使用して、すべてのバージョンのキーがインポートされます。 キーの名前が既に使用されている場合、復元は失敗します。 また、ターゲット コンテナーは、ソース コンテナーと同じ Microsoft Azure サブスクリプションによって所有されている必要があります。
restore_key_backup(backup: bytes, **kwargs) -> KeyVaultKeyパラメーター
戻り値
復元されたキー
の戻り値の型 :
例外
バックアップされたキーの名前が既に使用されている場合は、
その他のエラー
rotate_key
キーの新しいバージョンを生成して、キー ポリシーに基づいてキーをローテーションします。
この操作には、キー/回転アクセス許可が必要です。
rotate_key(name: str, **kwargs) -> KeyVaultKeyパラメーター
戻り値
ローテーションされたキーの新しいバージョン。
の戻り値の型 :
例外
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 です。
戻り値
ネットワーク呼び出しの応答。 応答でエラー処理を行いません。
の戻り値の型 :
例外
キーが存在しない場合は、
その他のエラーの場合
update_key_properties
(暗号化マテリアルではなく) キーのプロパティを変更します。
キー/更新アクセス許可が必要です。
update_key_properties(name: str, version: str | None = None, **kwargs) -> KeyVaultKeyパラメーター
- key_operations
- list[KeyOperation または str] または None
許可されたキー操作
- release_policy
- KeyReleasePolicy または None
キーをエクスポートできるポリシー ルール。
戻り値
更新されたキー
の戻り値の型 :
例外
キーが存在しない場合は、
その他のエラー
update_key_rotation_policy
Key Vault キーのローテーション ポリシーを更新します。
この操作には、キー/更新アクセス許可が必要です。
update_key_rotation_policy(key_name: str, policy: KeyRotationPolicy, **kwargs) -> KeyRotationPolicyパラメーター
- lifetime_actions
- list[KeyRotationLifetimeAction]
キーの有効期間中にKey Vaultによって実行されるアクション。 これにより、指定された の有効期間アクションがオーバーライドされます policy。
- expires_in
- str
ISO 8601 期間として定義された新しいキー バージョンに適用されるポリシーの有効期限。 たとえば、90 日は "P90D" で、3 か月は "P3M" で、48 時間は "PT48H" です。 ISO 8601 の期間の詳細については、 Wikipedia を参照してください。
これにより、指定 policyされた の有効期限がオーバーライドされます。
戻り値
更新されたローテーション ポリシー。
の戻り値の型 :
例外
属性
vault_url
Azure SDK for Python