Recover Deleted Secret - Recover Deleted Secret
削除されたシークレットを最新バージョンに回復します。
指定したコンテナー内の削除されたシークレットを回復します。 この操作は、論理的な削除が有効なコンテナーでのみ実行できます。 この操作には、シークレット/回復アクセス許可が必要です。
POST {vaultBaseUrl}/deletedsecrets/{secret-name}/recover?api-version=7.4
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
secret-name
|
path | True |
string |
削除されたシークレットの名前。 |
vault
|
path | True |
string |
コンテナー名 (例: https://myvault.vault.azure.net)。 |
api-version
|
query | True |
string |
クライアント API バージョン。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
元のシークレットとその属性のシークレット バンドル。 |
|
Other Status Codes |
操作が失敗した理由を説明するエラー応答をKey Vaultします。 |
例
RecoverDeletedSecret
要求のサンプル
POST https://myvault.vault.azure.net//deletedsecrets/SecretCreateDeleteRecoverPurgeTest/recover?api-version=7.4
応答のサンプル
{
"id": "https://myvault.vault.azure.net/secrets/SecretCreateDeleteRecoverPurgeTest/16f5f7feb7004280b7f3b8ac50cd01f9",
"attributes": {
"enabled": true,
"created": 1493937960,
"updated": 1493937960,
"recoveryLevel": "Recoverable+Purgeable"
}
}
定義
名前 | 説明 |
---|---|
Deletion |
現在のコンテナー内のシークレットに対して現在有効になっている削除回復レベルを反映します。 "Purgeable" が含まれている場合は、特権ユーザーによってシークレットを完全に削除できます。それ以外の場合は、保持間隔の最後に、システムのみがシークレットを消去できます。 |
Error |
キー コンテナー サーバーエラー。 |
Key |
キー コンテナーエラー例外。 |
Secret |
シークレット管理属性。 |
Secret |
値、id、およびその属性で構成されるシークレット。 |
DeletionRecoveryLevel
現在のコンテナー内のシークレットに対して現在有効になっている削除回復レベルを反映します。 "Purgeable" が含まれている場合は、特権ユーザーによってシークレットを完全に削除できます。それ以外の場合は、保持間隔の最後に、システムのみがシークレットを消去できます。
名前 | 型 | 説明 |
---|---|---|
CustomizedRecoverable |
string |
即時および永続的な削除 (つまり、7<= SoftDeleteRetentionInDays 90 の場合は消去) を行わずに削除を回復できるコンテナーの状態を < 示します。このレベルでは、保持期間中およびサブスクリプションが引き続き使用できる間に、削除されたエンティティの回復可能性が保証されます。 |
CustomizedRecoverable+ProtectedSubscription |
string |
7<= SoftDeleteRetentionInDays < 90 の場合、削除が回復可能で、即時および完全な削除 (消去) が許可されず、サブスクリプション自体を完全に取り消すことができないコンテナーとサブスクリプションの状態を示します。 このレベルでは、保持期間中に削除されたエンティティの回復可能性が保証され、サブスクリプション自体を取り消すことができないという事実も反映されます。 |
CustomizedRecoverable+Purgeable |
string |
削除が回復可能であり、即時および永続的な削除も許可されるコンテナーの状態を示します (つまり、7< = SoftDeleteRetentionInDays < 90 の場合は消去)。 このレベルでは、消去操作が要求されるか、サブスクリプションが取り消されない限り、保持期間中に削除されたエンティティの回復可能性が保証されます。 |
Purgeable |
string |
復旧の可能性がない、削除が元に戻せない操作であるコンテナーの状態を示します。 このレベルは、Delete 操作に対して使用できる保護に対応しません。エンティティ レベル以上 (コンテナー、リソース グループ、サブスクリプションなど) で Delete 操作を受け入れると、データが回復不能に失われます。 |
Recoverable |
string |
即時および永続的な削除 (つまり消去) を行わずに削除を回復できるコンテナーの状態を示します。 このレベルでは、保持期間 (90 日) の間、およびサブスクリプションがまだ使用可能な間に、削除されたエンティティの回復可能性が保証されます。 回復されていない場合、システムは90日後にそれを完全に削除します |
Recoverable+ProtectedSubscription |
string |
保持期間内 (90 日以内)、即時削除と完全削除 (消去) が許可されず、サブスクリプション自体を完全に取り消すことができないコンテナーとサブスクリプションの状態を示します。 回復されていない場合、システムは90日後にそれを完全に削除します |
Recoverable+Purgeable |
string |
削除が回復可能であり、即時および永続的な削除 (消去) も許可されるコンテナーの状態を示します。 このレベルでは、消去操作が要求されたか、サブスクリプションが取り消されない限り、保持期間中 (90 日間) に削除されたエンティティの回復可能性が保証されます。 回復されていない場合、システムは90日後にそれを完全に削除します |
Error
キー コンテナー サーバーエラー。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コード。 |
innererror |
キー コンテナー サーバーエラー。 |
|
message |
string |
エラー メッセージ。 |
KeyVaultError
キー コンテナーエラー例外。
名前 | 型 | 説明 |
---|---|---|
error |
キー コンテナー サーバーエラー。 |
SecretAttributes
シークレット管理属性。
名前 | 型 | 説明 |
---|---|---|
created |
integer |
作成時刻 (UTC)。 |
enabled |
boolean |
オブジェクトが有効かどうかを判断します。 |
exp |
integer |
有効期限 (UTC)。 |
nbf |
integer |
UTC の日付より前ではありません。 |
recoverableDays |
integer |
softDelete データ保持日数。 softDelete が有効な場合は >=7、 <=90、それ以外の場合は 0 にする必要があります。 |
recoveryLevel |
現在のコンテナー内のシークレットに対して現在有効になっている削除回復レベルを反映します。 "Purgeable" が含まれている場合は、特権ユーザーによってシークレットを完全に削除できます。それ以外の場合は、保持間隔の最後に、システムのみがシークレットを消去できます。 |
|
updated |
integer |
UTC での最終更新時刻。 |
SecretBundle
値、id、およびその属性で構成されるシークレット。
名前 | 型 | 説明 |
---|---|---|
attributes |
シークレット管理属性。 |
|
contentType |
string |
シークレットのコンテンツ タイプ。 |
id |
string |
シークレット ID。 |
kid |
string |
これが KV 証明書をバックアップするシークレットの場合、このフィールドは KV 証明書をバッキングする対応するキーを指定します。 |
managed |
boolean |
シークレットの有効期間がキー コンテナーによって管理されている場合は True。 これが証明書をバックアップするシークレットの場合、マネージドは true になります。 |
tags |
object |
キーと値のペアの形式による、アプリケーション固有のメタデータ。 |
value |
string |
シークレット値。 |