你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Get Deleted Secret - Get Deleted Secret

参考

Service:: Key Vault

API Version:: 7.4

获取指定的已删除机密。
“获取已删除的机密”操作返回指定的已删除机密及其属性。此操作需要机密/get 权限。

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

URI 参数

名称	在	必需	类型	说明
secret-name	path	True	string	机密的名称。
vaultBaseUrl	path	True	string	保管库名称，例如 https://myvault.vault.azure.net。
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	DeletedSecretBundle	机密及其属性的机密捆绑包。
Other Status Codes	KeyVaultError	密钥保管库描述操作失败原因的错误响应。

示例

GetDeletedSecret

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "recoveryId": "https://myvault.vault.azure.net/deletedsecrets/GetDeletedSecretTest",
  "deletedDate": 1493938433,
  "scheduledPurgeDate": 1501714433,
  "id": "https://myvault.vault.azure.net/secrets/GetDeletedSecretTest/b595353d9c39413d80626575b3b5d865",
  "attributes": {
    "enabled": true,
    "created": 1493938433,
    "updated": 1493938433,
    "recoveryLevel": "Recoverable+Purgeable"
  }
}

定义

名称	说明
DeletedSecretBundle	一个已删除的机密，其中包含其以前的 ID、属性和标记，以及有关何时清除它的信息。
DeletionRecoveryLevel	反映当前对当前保管库中的机密有效的删除恢复级别。如果它包含“可清除”，则特权用户可永久删除机密;否则，只有系统可以在保留间隔结束时清除机密。
Error	密钥保管库服务器错误。
KeyVaultError	密钥保管库错误异常。
SecretAttributes	机密管理属性。

DeletedSecretBundle

一个已删除的机密，其中包含其以前的 ID、属性和标记，以及有关何时清除它的信息。

名称	类型	说明
attributes	SecretAttributes	机密管理属性。
contentType	string	机密的内容类型。
deletedDate	integer	删除机密的时间（UTC）
id	string	机密 ID。
kid	string	如果这是支持 KV 证书的机密，则此字段指定支持 KV 证书的相应密钥。
managed	boolean	如此如果机密的生存期由密钥保管库管理。如果这是支持证书的机密，则托管为 true。
recoveryId	string	恢复对象的 URL，用于标识和恢复已删除的机密。
scheduledPurgeDate	integer	计划清除机密的时间（UTC）
tags	object	键/值对形式的应用程序特定元数据。
value	string	机密值。

DeletionRecoveryLevel

反映当前对当前保管库中的机密有效的删除恢复级别。如果它包含“可清除”，则特权用户可永久删除机密;否则，只有系统可以在保留间隔结束时清除机密。

名称	类型	说明
CustomizedRecoverable	string	表示可恢复删除的保管库状态， (即当 7<= SoftDeleteRetentionInDays < 90) 时进行清除，则无法立即和永久删除删除。此级别可保证已删除实体在保留间隔期间以及订阅仍可用时的可恢复性。
CustomizedRecoverable+ProtectedSubscription	string	表示保管库和订阅状态，其中删除是可恢复的，即时和永久删除 (即不允许清除) ，并且当 7<= SoftDeleteRetentionInDays < 90 时，订阅本身无法永久取消。此级别可保证已删除实体在保留间隔期间的可恢复性，还反映了订阅本身无法取消这一事实。
CustomizedRecoverable+Purgeable	string	表示保管库状态，其中删除是可恢复的，并且还允许立即和永久删除 (即在 7<= SoftDeleteRetentionInDays <) 时清除。除非请求清除操作或取消订阅，否则此级别可保证已删除实体在保留间隔期间的可恢复性。
Purgeable	string	表示保管库状态，其中删除操作不可逆，无法恢复。此级别对应于对删除操作没有可用的保护;在实体级别或更高 (保管库、资源组、订阅等接受删除操作时，数据将不可挽回地丢失 )
Recoverable	string	表示可恢复删除的保管库状态，无法立即和永久删除 (即清除) 。此级别保证在保留间隔 (90 天) 且订阅仍然可用期间，已删除实体的可恢复性。系统将在 90 天后永久删除它（如果未恢复）
Recoverable+ProtectedSubscription	string	表示保管库和订阅状态，其中删除可在 90 天内恢复， (90 天的保留间隔) ，即时和永久删除 (即不允许清除) ，并且订阅本身不能永久取消。系统将在 90 天后永久删除它（如果未恢复）
Recoverable+Purgeable	string	表示保管库状态，其中删除是可恢复的，还允许立即和永久删除 (即清除) 。此级别保证删除实体在保留间隔 (90 天) 的可恢复性，除非请求清除操作或取消订阅。系统将在 90 天后永久删除它（如果未恢复）

Error

密钥保管库服务器错误。

名称	类型	说明
code	string	错误代码。
innererror	Error	密钥保管库服务器错误。
message	string	错误消息。

KeyVaultError

密钥保管库错误异常。

名称	类型	说明
error	Error	密钥保管库服务器错误。

SecretAttributes

机密管理属性。

名称	类型	说明
created	integer	创建时间（UTC）。
enabled	boolean	确定是否启用对象。
exp	integer	到期日期（UTC）。
nbf	integer	不早于 UTC 日期。
recoverableDays	integer	softDelete 数据保留天数。启用 softDelete 时，值应为 >=7 和 <=90，否则为 0。
recoveryLevel	DeletionRecoveryLevel	反映当前对当前保管库中的机密有效的删除恢复级别。如果它包含“可清除”，则特权用户可永久删除机密;否则，只有系统可以在保留间隔结束时清除机密。
updated	integer	上次更新时间（UTC）。