Get Deleted Keys - Get Deleted Keys

  • リファレンス
Service:
Key Vault
API Version:
7.4

指定したコンテナー内の削除されたキーをListsします。
削除されたキーの公開部分を含む JSON Web キー構造として、Key Vault内のキーの一覧を取得します。 この操作には、削除固有の情報が含まれます。 削除済みキーの取得操作は、論理的な削除が有効なコンテナーに適用されます。 操作は任意のコンテナーで呼び出すことができますが、論理的な削除が有効になっていないコンテナーで呼び出されるとエラーが返されます。 この操作には、キー/リストのアクセス許可が必要です。

GET {vaultBaseUrl}/deletedkeys?api-version=7.4
With optional parameters: 
GET {vaultBaseUrl}/deletedkeys?maxresults={maxresults}&api-version=7.4

URI パラメーター

名前 / 必須 型 説明
vaultBaseUrl
 path True

string

コンテナー名 (例: https://myvault.vault.azure.net)。
api-version
 query True

string

クライアント API バージョン。
maxresults
 query

integer

int32

ページに返される結果の最大数。 指定しない場合、サービスは最大 25 件の結果を返します。

応答

名前 型 説明
200 OK

DeletedKeyListResult

コンテナー内の削除されたキーの一覧と、削除されたキーの次のページへのリンクを含む応答メッセージ。
Other Status Codes

KeyVaultError

操作が失敗した理由を説明するエラー応答をKey Vaultします。

例

GetDeletedKeys

Sample Request

GET https://myvault.vault.azure.net//deletedkeys?maxresults=1&api-version=7.4

Sample Response

Status code:
200 
{
  "value": [
    {
      "recoveryId": "https://myvault.vault.azure.net/deletedkeys/listdeletedkeytest0",
      "deletedDate": 1493938031,
      "scheduledPurgeDate": 1501714031,
      "kid": "https://myvault.vault.azure.net/keys/listdeletedkeytest0",
      "attributes": {
        "enabled": true,
        "created": 1493938031,
        "updated": 1493938031,
        "recoveryLevel": "Recoverable+Purgeable"
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/deletedkeys?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExMzYhTURBd01EVTJJV3RsZVM5TVNWTlVSRVZNUlZSRlJFdEZXVlJGVTFRd0x6RkRRa0ZGTkVaQk5qQTBNelJGTmtZNE9FUXdORE5GTkRFM09FUkNPVFE1SVRBd01EQXlPQ0V5TURFM0xUQTFMVEEwVkRJeU9qUTNPakU1TGpVeU1UZ3dPVEZhSVEtLSIsIlRhcmdldExvY2F0aW9uIjowfQ&maxresults=1"
}

定義

名前 説明
DeletedKeyItem

削除されたキー メタデータと削除に関する情報を含む削除済みキー項目。
DeletedKeyListResult

このコンテナーで削除されたキーの一覧。
DeletionRecoveryLevel

現在のコンテナー内のキーに対して現在有効になっている削除回復レベルを反映します。 "Purgeable" が含まれている場合、キーは特権ユーザーによって完全に削除できます。それ以外の場合、保持間隔の最後にキーを消去できるのはシステムだけです。
Error

キー コンテナー サーバーエラー。
KeyAttributes

キー コンテナー サービスによって管理されるキーの属性。
KeyVaultError

キー コンテナーエラー例外。

DeletedKeyItem

削除されたキー メタデータと削除に関する情報を含む削除済みキー項目。

名前 型 説明
attributes

KeyAttributes

キー管理属性。
deletedDate

integer

キーが削除された時刻 (UTC)
kid

string

キー識別子。
managed

boolean

True キーの有効期間がキー コンテナーによって管理されている場合。 これが証明書をバックアップするキーの場合、マネージドは true になります。
recoveryId

string

削除されたキーを識別して回復するために使用される回復オブジェクトの URL。
scheduledPurgeDate

integer

キーの消去がスケジュールされている時刻 (UTC)
tags

object

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

DeletedKeyListResult

このコンテナーで削除されたキーの一覧。

名前 型 説明
nextLink

string

削除されたキーの次のセットを取得する URL。
value

DeletedKeyItem[]

コンテナー内の削除されたキーの一覧と、削除されたキーの次のページへのリンクを含む応答メッセージ

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

Error

キー コンテナー サーバーエラー。
message

string

エラー メッセージ。

KeyAttributes

キー コンテナー サービスによって管理されるキーの属性。

名前 型 説明
created

integer

作成時刻 (UTC)。
enabled

boolean

オブジェクトが有効かどうかを判断します。
exp

integer

有効期限 (UTC)。
exportable

boolean

秘密キーをエクスポートできるかどうかを示します。 エクスポート可能なキーの最初のバージョンを作成するときは、リリース ポリシーを指定する必要があります。
nbf

integer

UTC の日付より前ではありません。
recoverableDays

integer

softDelete データ保持日数。 softDelete が有効な場合は >=7、 <=90、それ以外の場合は 0 にする必要があります。
recoveryLevel

DeletionRecoveryLevel

現在のコンテナー内のキーに対して現在有効になっている削除回復レベルを反映します。 "Purgeable" が含まれている場合、キーは特権ユーザーによって完全に削除できます。それ以外の場合、保持間隔の最後にキーを消去できるのはシステムだけです。
updated

integer

UTC での最終更新時刻。

KeyVaultError

キー コンテナーエラー例外。

名前 型 説明
error

Error

キー コンテナー サーバーエラー。