Get Deleted Secrets - Get Deleted Secrets

參考

Service:: Key Vault

API Version:: 7.4

清單指定保存庫已刪除的秘密。
[取得刪除的秘密] 作業會傳回針對已啟用虛刪除之保存庫刪除的秘密。這項作業需要秘密/列表許可權。

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

With optional parameters:

GET {vaultBaseUrl}/deletedsecrets?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	DeletedSecretListResult	回應訊息，其中包含保存庫中已刪除的秘密清單，以及已刪除秘密下一頁的連結。
Other Status Codes	KeyVaultError	金鑰保存庫錯誤回應，描述作業失敗的原因。

範例

GetDeletedSecrets

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "recoveryId": "https://myvault.vault.azure.net/deletedsecrets/listdeletedsecrettest0",
      "deletedDate": 1493937855,
      "scheduledPurgeDate": 1501713855,
      "contentType": "plainText",
      "id": "https://myvault.vault.azure.net/secrets/listdeletedsecrettest0",
      "attributes": {
        "enabled": true,
        "created": 1493937855,
        "updated": 1493937855,
        "recoveryLevel": "Recoverable+Purgeable"
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/deletedsecrets?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExNDQhTURBd01EWXlJWE5sWTNKbGRDOU1TVk5VUkVWTVJWUkZSRk5GUTFKRlZGUkZVMVF3THpZMU16ZERSRVJGTlRJNU5qUkRSa1pDTVRkQ1JVWXhORGszUXpSQ1JEZEVJVEF3TURBeU9DRXlNREUzTFRBMUxUQTBWREl5T2pRME9qUXdMamsxTnpZeE1UbGFJUS0tIiwiVGFyZ2V0TG9jYXRpb24iOjB9&maxresults=1"
}

定義

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

DeletedSecretItem

已刪除的秘密專案，其中包含已刪除秘密的相關元數據。

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

DeletedSecretListResult

已刪除的秘密清單結果

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

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	錯誤訊息。

KeyVaultError

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

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

SecretAttributes

秘密管理屬性。

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

共用方式為