SecretClient クラス

  • リファレンス

コンテナーのシークレットを管理するための高度なインターフェイス。

継承
azure.keyvault.secrets._shared.client_base.KeyVaultClientBase
SecretClient

コンストラクター

SecretClient(vault_url: str, credential: TokenCredential, **kwargs)

パラメーター

vault_url
str
必須

クライアントがアクセスするコンテナーの URL。 これは、コンテナーの "DNS 名" とも呼ばれます。 この URL が有効なKey Vault リソースを参照していることを検証する必要があります。 詳細については、https://aka.ms/azsdk/blog/vault-uri を参照してください。

credential
TokenCredential
必須

資格情報など、コンテナーのアクセス トークンを提供できる オブジェクト。 identity

api_version
ApiVersion

使用するサービス API のバージョン。 既定値は最新です。

verify_challenge_resource
bool

認証チャレンジ リソースがKey Vault ドメインと一致するかどうかを確認するかどうか。 既定値は True です。

メソッド

backup_secret

Azure Key Vaultでのみ使用できる保護された形式でシークレットをバックアップします。 シークレット/バックアップアクセス許可が必要です。
begin_delete_secret

シークレットのすべてのバージョンを削除します。 シークレット/削除アクセス許可が必要です。

このメソッドが戻ると、シークレットの削除が開始Key Vault。 論理的な削除が有効になっているコンテナーでは、削除に数秒かかる場合があります。 したがって、このメソッドはポーリングを返し、削除が完了するまで待機できるようにします。
begin_recover_deleted_secret

削除されたシークレットを最新バージョンに復元します。 論理的な削除が有効になっているコンテナーでのみ可能です。

シークレット/回復アクセス許可が必要です。 コンテナーで論理的な削除が有効になっていない場合、 begin_delete_secret は永続的であり、このメソッドはエラーを返します。 削除されていないシークレットを回復しようとすると、エラーも返されます。 このメソッドがを返すと、シークレットの復旧が開始Key Vault。 回復には数秒かかる場合があります。 したがって、このメソッドはポーリングを返し、復旧が完了するまで待機できるようにします。 待機は、回復されたシークレットを別の操作ですぐに使用する場合にのみ必要です。
close

クライアントによって開かれたソケットを閉じます。

クライアントをコンテキスト マネージャーとして使用する場合、このメソッドの呼び出しは不要です。
get_deleted_secret

削除されたシークレットを取得します。 論理的な削除が有効になっているコンテナーでのみ可能です。 シークレット/取得アクセス許可が必要です。
get_secret

シークレットを取得します。 シークレット/取得のアクセス許可が必要です。
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

シークレット値を設定します。 name が使用されている場合は、シークレットの新しいバージョンを作成します。 そうでない場合は、新しいシークレットを作成します。

secrets/set 権限が必要です。
update_secret_properties

シークレットの値以外のプロパティを更新します。 secrets/set 権限が必要です。

このメソッドは、シークレットが有効になっているかどうかなど、シークレットのプロパティを更新しますが、シークレットの値を変更することはできません。 シークレットの値を変更するには、 を使用 set_secret します。

backup_secret

Azure Key Vaultでのみ使用できる保護された形式でシークレットをバックアップします。 シークレット/バックアップアクセス許可が必要です。

backup_secret(name: str, **kwargs) -> bytes

パラメーター

name
str
必須

バックアップするシークレットの名前

の戻り値の型 :

bytes

例外

ResourceNotFoundError

シークレットが存在しない場合は、

HttpResponseError

その他のエラーの場合

begin_delete_secret

シークレットのすべてのバージョンを削除します。 シークレット/削除アクセス許可が必要です。

このメソッドが戻ると、シークレットの削除が開始Key Vault。 論理的な削除が有効になっているコンテナーでは、削除に数秒かかる場合があります。 したがって、このメソッドはポーリングを返し、削除が完了するまで待機できるようにします。

begin_delete_secret(name: str, **kwargs) -> LROPoller[DeletedSecret]

パラメーター

name
str
必須

削除するシークレットの名前。

戻り値

削除操作の投票者。 ポーリングの 結果 メソッドは、削除の完了を待たずに を DeletedSecret 返します。 コンテナーで論理的な削除が有効になっており、 を使用してシークレット purge_deleted_secretを完全に削除する場合は、まずポーリングの 待機 メソッドを呼び出します。 削除が完了するまでブロックされます。 wait メソッドには secrets/get アクセス許可が必要です。

の戻り値の型 :

LROPoller[DeletedSecret]

例外

ResourceNotFoundError

シークレットが存在しない場合は、

HttpResponseError

その他のエラーの場合

begin_recover_deleted_secret

削除されたシークレットを最新バージョンに復元します。 論理的な削除が有効になっているコンテナーでのみ可能です。

シークレット/回復アクセス許可が必要です。 コンテナーで論理的な削除が有効になっていない場合、 begin_delete_secret は永続的であり、このメソッドはエラーを返します。 削除されていないシークレットを回復しようとすると、エラーも返されます。 このメソッドがを返すと、シークレットの復旧が開始Key Vault。 回復には数秒かかる場合があります。 したがって、このメソッドはポーリングを返し、復旧が完了するまで待機できるようにします。 待機は、回復されたシークレットを別の操作ですぐに使用する場合にのみ必要です。

begin_recover_deleted_secret(name: str, **kwargs) -> LROPoller[SecretProperties]

パラメーター

name
str
必須

回復する削除されたシークレットの名前

戻り値

回復操作のポーリング者。 ポーリングの 結果 メソッドは、回復が完了するのを待たずに、回復されたシークレット SecretProperties を返します。 回復されたシークレットをすぐに使用する場合は、ポーリングャーの wait メソッドを呼び出します。このメソッドは、シークレットを使用する準備ができるまでブロックします。 wait メソッドには secrets/get アクセス許可が必要です。

の戻り値の型 :

LROPoller[SecretProperties]

例外

HttpResponseError

close

クライアントによって開かれたソケットを閉じます。

クライアントをコンテキスト マネージャーとして使用する場合、このメソッドの呼び出しは不要です。

close() -> None

例外

ResourceNotFoundError

シークレットが存在しない場合は、

HttpResponseError

その他のエラーの場合

get_deleted_secret

削除されたシークレットを取得します。 論理的な削除が有効になっているコンテナーでのみ可能です。 シークレット/取得アクセス許可が必要です。

get_deleted_secret(name: str, **kwargs) -> DeletedSecret

パラメーター

name
str
必須

削除されたシークレットの名前

の戻り値の型 :

DeletedSecret

例外

ResourceNotFoundError

削除されたシークレットが存在しない場合は、

HttpResponseError

その他のエラーの場合

get_secret

シークレットを取得します。 シークレット/取得のアクセス許可が必要です。

get_secret(name: str, version: str | None = None, **kwargs) -> KeyVaultSecret

パラメーター

name
str
必須

シークレットの名前

version
str
必須

(省略可能)取得するシークレットのバージョン。 指定されていない場合は、最新バージョンを取得します。

の戻り値の型 :

KeyVaultSecret

例外

ResourceNotFoundError

シークレットが存在しない場合は、

HttpResponseError

その他のエラーの場合

list_deleted_secrets

削除されたすべてのシークレットを一覧表示します。 論理的な削除が有効になっているコンテナーでのみ可能です。

シークレット/リストのアクセス許可が必要です。

list_deleted_secrets(**kwargs) -> ItemPaged[DeletedSecret]

戻り値

削除されたシークレットの反復子 (値を除く)

の戻り値の型 :

ItemPaged[DeletedSecret]

例外

ResourceNotFoundError

シークレットが存在しない場合は、

HttpResponseError

その他のエラーの場合

list_properties_of_secret_versions

シークレットのすべてのバージョンのプロパティ (値を除く) を一覧表示します。 シークレット/リストのアクセス許可が必要です。

リスト アイテムにはシークレット値は含まれません。 を使用して get_secret シークレットの値を取得します。

list_properties_of_secret_versions(name: str, **kwargs) -> ItemPaged[SecretProperties]

パラメーター

name
str
必須

シークレットの名前

戻り値

シークレットの値を除く反復子

の戻り値の型 :

ItemPaged[SecretProperties]

例外

ResourceNotFoundError

シークレットが存在しない場合は、

HttpResponseError

その他のエラーの場合

list_properties_of_secrets

コンテナー内のすべてのシークレットの識別子と属性を一覧表示します。 シークレット/リストのアクセス許可が必要です。

リスト アイテムにはシークレット値は含まれません。 を使用して get_secret シークレットの値を取得します。

list_properties_of_secrets(**kwargs) -> ItemPaged[SecretProperties]

戻り値

シークレットの値を除く反復子

の戻り値の型 :

ItemPaged[SecretProperties]

例外

ResourceNotFoundError

シークレットが存在しない場合は、

HttpResponseError

その他のエラーの場合

purge_deleted_secret

削除されたシークレットを完全に削除します。 論理的な削除が有効になっているコンテナーでのみ可能です。

指定されたシークレットの元に戻せない削除を実行します。復旧の可能性はありません。 が 'Purgeable' を指定していない場合 recovery_level 、操作は使用できません。 このメソッドは、 の前にシークレットを消去する場合にのみ必要です scheduled_purge_date。

シークレット/消去アクセス許可が必要です。

purge_deleted_secret(name: str, **kwargs) -> None

パラメーター

name
str
必須

消去する削除されたシークレットの名前

戻り値

なし

例外

HttpResponseError

例


   # 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

パラメーター

backup
bytes
必須

によって返されるシークレット バックアップ backup_secret

戻り値

復元されたシークレット

の戻り値の型 :

SecretProperties

例外

ResourceExistsError

シークレットの名前が既に使用されている場合は、

HttpResponseError

その他のエラーの場合

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

パラメーター

request
HttpRequest
必須

作成するネットワーク要求。

stream
bool

応答ペイロードがストリーミングされるかどうか。 既定値は False です。

戻り値

ネットワーク呼び出しの応答。 応答でエラー処理を行いません。

の戻り値の型 :

HttpResponse

例外

ResourceNotFoundError

シークレットが存在しない場合は、

HttpResponseError

その他のエラーの場合

set_secret

シークレット値を設定します。 name が使用されている場合は、シークレットの新しいバージョンを作成します。 そうでない場合は、新しいシークレットを作成します。

secrets/set 権限が必要です。

set_secret(name: str, value: str, **kwargs) -> KeyVaultSecret

パラメーター

name
str
必須

シークレットの名前

value
str
必須

シークレットの値

enabled
bool

シークレットの使用が有効になっているかどうか。

tags
Dict[str, str] または None

キーと値のペアの形式による、アプリケーション固有のメタデータ。

content_type
str

シークレットの種類を示す任意の文字列 (例: 'password' )

not_before
datetime

UTC のシークレットの日付より前ではない

expires_on
datetime

シークレットの有効期限 (UTC)

の戻り値の型 :

KeyVaultSecret

例外

HttpResponseError

update_secret_properties

シークレットの値以外のプロパティを更新します。 secrets/set 権限が必要です。

このメソッドは、シークレットが有効になっているかどうかなど、シークレットのプロパティを更新しますが、シークレットの値を変更することはできません。 シークレットの値を変更するには、 を使用 set_secret します。

update_secret_properties(name: str, version: str | None = None, **kwargs) -> SecretProperties

パラメーター

name
str
必須

シークレットの名前

version
str
必須

(省略可能)更新するシークレットのバージョン。 指定しない場合は、最新バージョンが更新されます。

enabled
bool

シークレットの使用が有効になっているかどうか。

tags
Dict[str, str] または None

キーと値のペアの形式による、アプリケーション固有のメタデータ。

content_type
str

シークレットの種類を示す任意の文字列 (例: 'password' )

not_before
datetime

UTC のシークレットの日付より前ではない

expires_on
datetime

シークレットの有効期限 (UTC)

の戻り値の型 :

SecretProperties

例外

ResourceNotFoundError

シークレットが存在しない場合は、

HttpResponseError

その他のエラーの場合

属性

vault_url