Recover Deleted Key - Recover Deleted Key

參考

服務:: Key Vault

API 版本:: 7.4

將已刪除的金鑰復原至其最新版本。
復原已刪除的金鑰作業適用於已啟用虛刪除保存庫中已刪除的密鑰。它會將已刪除的金鑰復原回 /keys 下的最新版本。嘗試復原未刪除的金鑰將會傳回錯誤。請考慮這是已啟用虛刪除保存庫之刪除作業的反函數。此作業需要金鑰/復原許可權。

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

URI 參數

名稱	位於	必要	類型	Description
key-name	path	True	string	已刪除金鑰的名稱。
vaultBaseUrl	path	True	string	儲存庫名稱，例如 https://myvault.vault.azure.net。
api-version	query	True	string	用戶端 API 版本。

回應

名稱	類型	Description
200 OK	KeyBundle	原始金鑰及其屬性的金鑰組合
Other Status Codes	KeyVaultError	Key Vault 錯誤回應，描述作業失敗的原因。

範例

RecoverDeletedKey

範例要求

HTTP

POST https://myvault.vault.azure.net//deletedkeys/CreateDeleteRecoverPurgeTest/recover?api-version=7.4

範例回覆

狀態碼:: 200

{
  "key": {
    "kid": "https://myvault.vault.azure.net/keys/CreateDeleteRecoverPurgeTest/6fc2be54c6be4a7ea7bbb8a2a99a1996",
    "kty": "RSA",
    "key_ops": [
      "encrypt",
      "decrypt",
      "sign",
      "verify",
      "wrapKey",
      "unwrapKey"
    ],
    "n": "v-SWMCmPNKoK_rB_pNXUl6Iwh9Kqd3XzQlh6SXi_slBishqP7pyKEFjNbUvMSlyvPt21rJupLbJr-yhsK2Rq2V6O0doGuCsoadgNGih1aVAuUJAJls1-b-G1IJjD18ArM4RitnCvJmQFqyK2RVHa3EpEfaQW4gcRrsRAhiJDjc1L1S3skdt-E_rZfL7DIh1ZtqFyQAqIWSAG0BXDdbgfEx1kJKqH-HRokDKeMCIaJtKZof6e-DJr3e9Iy8aAR7V-BsZ7vY7JMjyeEukMzEji4MEsIyOESL67DgFllDEi4OM_3WKyxr6uXxzHDzmppWsk2ykLsYA_ALLnR3ZNZCuL9Q",
    "e": "AQAB"
  },
  "attributes": {
    "enabled": true,
    "created": 1493938342,
    "updated": 1493938342,
    "recoveryLevel": "Recoverable+Purgeable"
  },
  "tags": {
    "purpose": "unit test",
    "test name ": "CreateDeleteRecoverPurgeTest"
  }
}

定義

名稱	Description
DeletionRecoveryLevel	反映目前保存庫中金鑰的刪除復原層級。如果它包含「可清除」，則特殊許可權使用者可以永久刪除密鑰;否則，只有系統可以在保留間隔結束時清除密鑰。
Error	金鑰儲存庫伺服器錯誤。
JsonWebKey	自 http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 起
JsonWebKeyCurveName	橢圓曲線名稱。如需有效值，請參閱 JsonWebKeyCurveName。
JsonWebKeyType	JsonWebKey 金鑰類型（kty），如 https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40中所定義。
KeyAttributes	金鑰保存庫服務所管理之金鑰的屬性。
KeyBundle	包含 WebKey 及其屬性的 KeyBundle。
KeyReleasePolicy	可匯出金鑰的原則規則。
KeyVaultError	金鑰保存庫錯誤例外狀況。

DeletionRecoveryLevel

列舉型別

反映目前保存庫中金鑰的刪除復原層級。如果它包含「可清除」，則特殊許可權使用者可以永久刪除密鑰;否則，只有系統可以在保留間隔結束時清除密鑰。

值	Description
CustomizedRecoverable	表示可復原刪除的保存庫狀態，而無法立即和永久刪除（亦即當 7<= SoftDeleteRetentionInDays < 90 時清除）。此層級可保證已刪除實體在保留間隔期間和訂用帳戶仍可使用時的復原能力。
CustomizedRecoverable+ProtectedSubscription	表示不允許刪除、立即和永久刪除的保存庫和訂閱狀態，而且當 7<= SoftDeleteRetentionInDays < 90 時，就無法永久取消訂閱本身。此層級保證在保留間隔期間已刪除實體的復原能力，也反映無法取消訂閱本身的事實。
CustomizedRecoverable+Purgeable	表示可復原刪除的保存庫狀態，也允許立即和永久刪除（也就是當 7<= SoftDeleteRetentionInDays < 90 時清除）。除非要求清除作業或取消訂閱，否則此層級保證在保留間隔期間已刪除實體的復原能力。
Purgeable	表示刪除是不可復原作業的保存庫狀態，而無法復原。此層級對應至無法對刪除作業提供保護;在接受實體層級或更高層級的刪除作業時，數據會無法復原（保存庫、資源群組、訂用帳戶等）
Recoverable	表示可復原刪除的保存庫狀態，而無法立即和永久刪除（亦即清除）。此層級可保證已刪除實體在保留間隔（90 天）和訂用帳戶仍可使用期間復原。系統 wil 會在 90 天后永久刪除，如果未復原
Recoverable+ProtectedSubscription	表示不允許在保留間隔內復原刪除的保存庫和訂用帳戶狀態（亦即清除），且無法永久取消訂閱本身。系統 wil 會在 90 天后永久刪除，如果未復原
Recoverable+Purgeable	表示可復原刪除的保存庫狀態，也允許立即和永久刪除（亦即清除）。此層級保證刪除實體在保留間隔期間（90 天）的復原能力，除非要求清除作業，或取消訂閱。系統 wil 會在 90 天后永久刪除，如果未復原

Error

Object

金鑰儲存庫伺服器錯誤。

名稱	類型	Description
code	string	錯誤碼。
innererror	Error	金鑰儲存庫伺服器錯誤。
message	string	錯誤訊息。

JsonWebKey

Object

自 http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 起

名稱	類型	Description
crv	JsonWebKeyCurveName	橢圓曲線名稱。如需有效值，請參閱 JsonWebKeyCurveName。
d	string (base64url)	RSA 私人指數或 EC 私鑰的 D 元件。
dp	string (base64url)	RSA 私密金鑰參數。
dq	string (base64url)	RSA 私密金鑰參數。
e	string (base64url)	RSA 公用指數。
k	string (base64url)	對稱金鑰。
key_hsm	string (base64url)	受保護的金鑰，與「攜帶您自己的金鑰」搭配使用。
key_ops	string[]	支援的金鑰作業。
kid	string	金鑰識別碼。
kty	JsonWebKeyType	JsonWebKey 金鑰類型（kty），如 https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40中所定義。
n	string (base64url)	RSA 模數。
p	string (base64url)	RSA 秘密黃金。
q	string (base64url)	RSA 秘密質數，含 p < q。
qi	string (base64url)	RSA 私密金鑰參數。
x	string (base64url)	EC 公鑰的 X 元件。
y	string (base64url)	EC 公鑰的 Y 元件。

JsonWebKeyCurveName

列舉型別

橢圓曲線名稱。如需有效值，請參閱 JsonWebKeyCurveName。

值	Description
P-256	NIST P-256 橢圓曲線，AKA SECG 曲線SECP256R1。
P-256K	SECG SECP256K1橢圓曲線。
P-384	NIST P-384 橢圓曲線，AKA SECG 曲線SECP384R1。
P-521	NIST P-521 橢圓曲線，AKA SECG 曲線SECP521R1。

JsonWebKeyType

列舉型別

JsonWebKey 金鑰類型（kty），如 https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40中所定義。

值	Description
EC	橢圓曲線。
EC-HSM	橢圓曲線與儲存在 HSM 中的私鑰。
RSA	RSA （https://tools.ietf.org/html/rfc3447）
RSA-HSM	RSA 具有儲存在 HSM 中的私鑰。
oct	八位序列（用來表示對稱金鑰）
oct-HSM	八位序列（用來代表對稱金鑰）儲存 HSM。

KeyAttributes

Object

金鑰保存庫服務所管理之金鑰的屬性。

名稱	類型	Description
created	integer (unixtime)	以 UTC 為單位的建立時間。
enabled	boolean	判斷物件是否已啟用。
exp	integer (unixtime)	UTC 的到期日。
exportable	boolean	指出是否可以匯出私鑰。建立可匯出密鑰的第一個版本時，必須提供發行原則。
nbf	integer (unixtime)	不在UTC的日期之前。
recoverableDays	integer (int32)	softDelete 數據保留天數。當啟用 softDelete 時，值應 >=7，且 <=90，否則為 0。
recoveryLevel	DeletionRecoveryLevel	反映目前保存庫中金鑰的刪除復原層級。如果它包含「可清除」，則特殊許可權使用者可以永久刪除密鑰;否則，只有系統可以在保留間隔結束時清除密鑰。
updated	integer (unixtime)	上次以UTC更新的時間。

KeyBundle

Object

包含 WebKey 及其屬性的 KeyBundle。

名稱	類型	Description
attributes	KeyAttributes	金鑰管理屬性。
key	JsonWebKey	Json Web 金鑰。
managed	boolean	True 是表示如果金鑰的存留期是由金鑰保存庫管理。如果這是備份憑證的密鑰，則受控將會是 true。
release_policy	KeyReleasePolicy	可匯出金鑰的原則規則。
tags	object	以索引鍵/值組形式的應用程式特定元數據。

KeyReleasePolicy

Object

可匯出金鑰的原則規則。

名稱	類型	預設值	Description
contentType	string	application/json; charset=utf-8	金鑰發行原則的內容類型和版本
data	string (base64url)		Blob 編碼可釋放密鑰的原則規則。 Blob 必須是base64 URL編碼。
immutable	boolean		定義原則的可變性狀態。一旦標示為不可變，就無法重設此旗標，而且在任何情況下都無法變更原則。

KeyVaultError

Object

金鑰保存庫錯誤例外狀況。

名稱	類型	Description
error	Error	金鑰儲存庫伺服器錯誤。

共用方式為

Recover Deleted Key - Recover Deleted Key

URI 參數

回應

範例

RecoverDeletedKey

範例要求

範例回覆

定義

DeletionRecoveryLevel

Error

JsonWebKey

JsonWebKeyCurveName

JsonWebKeyType

KeyAttributes

KeyBundle

KeyReleasePolicy

KeyVaultError

其他資源