Get Deleted Keys - Get Deleted Keys

參考

服務:: Key Vault

API 版本:: 7.4

清單指定保存庫中已刪除的金鑰。
擷取金鑰保存庫中索引鍵的清單做為 JSON Web 金鑰結構，其中包含已刪除金鑰的公用部分。此作業包含刪除特定資訊。 [取得刪除金鑰] 作業適用於啟用虛刪除的保存庫。雖然可以在任何保存庫上叫用作業，但如果在啟用非虛刪除的保存庫上叫用，則會傳回錯誤。這項作業需要金鑰/列表許可權。

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

含選擇性參數:

GET {vaultBaseUrl}/deletedkeys?maxresults={maxresults}&api-version=7.4

URI 參數

名稱	位於	必要	類型	Description
vaultBaseUrl	path	True	string	儲存庫名稱，例如 https://myvault.vault.azure.net。
api-version	query	True	string	用戶端 API 版本。
maxresults	query		integer int32	在頁面中傳回的結果數目上限。如果未指定，服務最多會傳回 25 個結果。

回應

名稱	類型	Description
200 OK	DeletedKeyListResult	回應訊息，其中包含保存庫中已刪除的金鑰清單，以及已刪除密鑰下一頁的連結。
Other Status Codes	KeyVaultError	金鑰保存庫錯誤回應，描述作業失敗的原因。

範例

GetDeletedKeys

範例要求

HTTP

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

範例回覆

狀態碼:: 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"
}

定義

名稱	Description
DeletedKeyItem	已刪除的索引鍵專案，其中包含已刪除的金鑰元數據和刪除的相關信息。
DeletedKeyListResult	此保存庫中已刪除的金鑰清單。
DeletionRecoveryLevel	反映目前保存庫中金鑰目前生效的刪除復原層級。如果它包含「可清除」，則特殊許可權使用者可以永久刪除密鑰;否則，只有系統可以在保留間隔結束時清除密鑰。
Error	金鑰儲存庫伺服器錯誤。
KeyAttributes	金鑰保存庫服務所管理的金鑰屬性。
KeyVaultError	金鑰保存庫錯誤例外狀況。

DeletedKeyItem

已刪除的索引鍵專案，其中包含已刪除的金鑰元數據和刪除的相關信息。

名稱	類型	Description
attributes	KeyAttributes	金鑰管理屬性。
deletedDate	integer	刪除金鑰的時間，以 UTC 為單位
kid	string	金鑰識別碼。
managed	boolean	如果金鑰的存留期是由金鑰保存庫管理，則為 True。如果這是備份憑證的密鑰，則 Managed 會是 true。
recoveryId	string	用來識別和復原已刪除金鑰之復原物件的 URL。
scheduledPurgeDate	integer	排程清除金鑰的時間，以 UTC 為單位
tags	object	以機碼/值組的形式應用程式特定元數據。

DeletedKeyListResult

此保存庫中已刪除的金鑰清單。

名稱	類型	Description
nextLink	string	要取得下一組已刪除金鑰的 URL。
value	DeletedKeyItem[]	回應訊息，其中包含保存庫中已刪除的金鑰清單，以及已刪除密鑰下一頁的連結

DeletionRecoveryLevel

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

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

Error

金鑰儲存庫伺服器錯誤。

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

KeyAttributes

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

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

KeyVaultError

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

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

共用方式為