Get Deleted Key - Get Deleted Key

リファレンス

Service:: Key Vault

API Version:: 7.4

削除されたキーの公開部分を取得します。
削除キーの取得操作は、論理的な削除が有効なコンテナーに適用されます。操作は任意のコンテナーで呼び出すことができますが、論理的な削除が有効になっていないコンテナーで呼び出されるとエラーが返されます。この操作には、キー/取得アクセス許可が必要です。

GET {vaultBaseUrl}/deletedkeys/{key-name}?api-version=7.4

URI パラメーター

名前	/	必須	型	説明
key-name	path	True	string	キーの名前です。
vaultBaseUrl	path	True	string	コンテナー名 (例: https://myvault.vault.azure.net)。
api-version	query	True	string	クライアント API バージョン。

応答

名前	型	説明
200 OK	DeletedKeyBundle	WebKey とその属性と削除情報で構成される DeletedKeyBundle。
Other Status Codes	KeyVaultError	操作Key Vault失敗した理由を説明するエラー応答です。

例

GetDeletedKey

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "recoveryId": "https://myvault.vault.azure.net/deletedkeys/CreateSoftKeyTest",
  "deletedDate": 1493942452,
  "scheduledPurgeDate": 1501718452,
  "key": {
    "kid": "https://myvault.vault.azure.net/keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71",
    "kty": "RSA",
    "key_ops": [
      "encrypt",
      "decrypt",
      "sign",
      "verify",
      "wrapKey",
      "unwrapKey"
    ],
    "n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w",
    "e": "AQAB"
  },
  "attributes": {
    "enabled": true,
    "created": 1493942451,
    "updated": 1493942451,
    "recoveryLevel": "Recoverable+Purgeable"
  },
  "tags": {
    "purpose": "unit test",
    "test name ": "CreateGetDeleteKeyTest"
  }
}

定義

名前	説明
DeletedKeyBundle	WebKey とその属性と削除情報で構成される DeletedKeyBundle
DeletionRecoveryLevel	現在のコンテナー内のキーに対して現在有効になっている削除回復レベルを反映します。 "Purgeable" が含まれている場合、キーは特権ユーザーによって完全に削除できます。それ以外の場合は、保持間隔の最後にキーを消去できるのはシステムだけです。
Error	キーコンテナーサーバーエラー。
JsonWebKey	の時点 http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
JsonWebKeyCurveName	楕円曲線名。有効な値については、「JsonWebKeyCurveName」を参照してください。
JsonWebKeyType	で定義 https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40されている JsonWebKey キー型 (kty)。
KeyAttributes	キーコンテナーサービスによって管理されるキーの属性。
KeyReleasePolicy	キーをエクスポートできるポリシールール。
KeyVaultError	キーコンテナーのエラー例外。

DeletedKeyBundle

WebKey とその属性と削除情報で構成される DeletedKeyBundle

名前	型	説明
attributes	KeyAttributes	キー管理属性。
deletedDate	integer	キーが削除された時刻 (UTC)
key	JsonWebKey	Json Web キー。
managed	boolean	True を指定すると、キーの有効期間がキーコンテナーによって管理されます。これが証明書をバックアップするキーの場合、マネージドは true になります。
recoveryId	string	削除されたキーを識別して回復するために使用される回復オブジェクトの URL。
release_policy	KeyReleasePolicy	キーをエクスポートできるポリシールール。
scheduledPurgeDate	integer	キーの消去がスケジュールされている時刻 (UTC)
tags	object	キーと値のペアの形式による、アプリケーション固有のメタデータ。

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	エラーメッセージ。

JsonWebKey

の時点 http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18

名前	型	説明
crv	JsonWebKeyCurveName	楕円曲線名。有効な値については、「JsonWebKeyCurveName」を参照してください。
d	string	RSA 秘密指数、または EC 秘密キーの D コンポーネント。
dp	string	RSA 秘密キーパラメーター。
dq	string	RSA 秘密キーパラメーター。
e	string	RSA パブリック指数。
k	string	対称キー。
key_hsm	string	保護されたキー。"Bring Your Own Key" と共に使用されます。
key_ops	string[]	サポートされているキー操作。
kid	string	キー識別子。
kty	JsonWebKeyType	で定義 https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40されている JsonWebKey キー型 (kty)。
n	string	RSA 剰余。
p	string	RSA シークレットプライム。
q	string	RSA シークレットプライム、p < q。
qi	string	RSA 秘密キーパラメーター。
x	string	EC 公開キーの X コンポーネント。
y	string	EC 公開キーの Y コンポーネント。

JsonWebKeyCurveName

楕円曲線名。有効な値については、「JsonWebKeyCurveName」を参照してください。

名前	型	説明
P-256	string	NIST P-256 楕円曲線、別名 SECG 曲線SECP256R1。
P-256K	string	SECG SECP256K1楕円曲線です。
P-384	string	NIST P-384 楕円曲線、別名 SECG 曲線SECP384R1。
P-521	string	NIST P-521 楕円曲線、別名 SECG 曲線SECP521R1。

JsonWebKeyType

で定義 https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40されている JsonWebKey キー型 (kty)。

名前	型	説明
EC	string	楕円曲線。
EC-HSM	string	HSM に格納されている秘密キーを持つ楕円曲線。
RSA	string	RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM	string	HSM に格納されている秘密キーを持つ RSA。
oct	string	オクテットシーケンス (対称キーを表すために使用)
oct-HSM	string	HSM に格納されるオクテットシーケンス (対称キーを表すために使用されます)。

KeyAttributes

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

名前	型	説明
created	integer	UTC での作成時刻。
enabled	boolean	オブジェクトが有効かどうかを判断します。
exp	integer	UTC の有効期限。
exportable	boolean	秘密キーをエクスポートできるかどうかを示します。エクスポート可能なキーの最初のバージョンを作成するときは、リリースポリシーを指定する必要があります。
nbf	integer	UTC の日付より前ではありません。
recoverableDays	integer	softDelete data retention days。 softDelete が有効な場合は、値は >=7、 <=90 である必要があります。それ以外の場合は 0 です。
recoveryLevel	DeletionRecoveryLevel	現在のコンテナー内のキーに対して現在有効になっている削除回復レベルを反映します。 "Purgeable" が含まれている場合、キーは特権ユーザーによって完全に削除できます。それ以外の場合は、保持間隔の最後にキーを消去できるのはシステムだけです。
updated	integer	UTC の最終更新時刻。

KeyReleasePolicy

キーをエクスポートできるポリシールール。

名前	型	既定値	説明
contentType	string	application/json; charset=utf-8	コンテンツタイプとキーリリースポリシーのバージョン
data	string		キーを解放できるポリシー規則をエンコードする BLOB。 BLOB は base64 URL エンコードされている必要があります。
immutable	boolean		ポリシーの変更可能性の状態を定義します。変更不可とマークされると、このフラグをリセットできず、どのような状況でもポリシーを変更することはできません。

KeyVaultError

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

名前	型	説明
error	Error	キーコンテナーサーバーエラー。