你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Get Deleted Certificates - Get Deleted Certificates
Lists当前可用于恢复的指定保管库中已删除的证书。
GetDeletedCertificates 操作检索当前保管库中处于已删除状态并准备恢复或清除的证书。 此操作包括特定于删除的信息。 此操作需要 certificates/get/list 权限。 只能在已启用软删除的保管库上启用此操作。
GET {vaultBaseUrl}/deletedcertificates?api-version=7.4
GET {vaultBaseUrl}/deletedcertificates?maxresults={maxresults}&includePending={includePending}&api-version=7.4
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
vault
|
path | True |
string |
保管库名称,例如 https://myvault.vault.azure.net。 |
api-version
|
query | True |
string |
客户端 API 版本。 |
include
|
query |
boolean |
指定是否包括未完全预配的证书。 |
|
maxresults
|
query |
integer int32 |
在一页中返回的最大结果数。 如果未指定,服务将返回最多 25 个结果。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
包含保管库中已删除证书的列表以及指向已删除证书的下一页的链接的响应消息 |
|
Other Status Codes |
密钥保管库描述操作失败原因的错误响应。 |
示例
GetDeletedCertificates
Sample Request
GET https://myvault.vault.azure.net//deletedcertificates?maxresults=1&api-version=7.4
Sample Response
{
"value": [
{
"recoveryId": "https://myvault.vault.azure.net/deletedcertificates/listdeletedcerttest0",
"deletedDate": 1493937659,
"scheduledPurgeDate": 1501713659,
"id": "https://myvault.vault.azure.net/certificates/listdeletedcerttest0",
"x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo",
"attributes": {
"enabled": true,
"nbf": 1430344421,
"exp": 2208988799,
"created": 1493937658,
"updated": 1493937658,
"recoveryLevel": "Recoverable+Purgeable"
}
}
],
"nextLink": "https://myvault.vault.azure.net:443/deletedcertificates?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExMTIhTURBd01ETTVJV05sY25ScFptbGpZWFJsTDB4SlUxUkVSVXhGVkVWRVEwVlNWRlJGVTFRd0wxQlBURWxEV1NFd01EQXdNamdoT1RrNU9TMHhNaTB6TVZReU16bzFPVG8xT1M0NU9UazVPVGs1V2lFLSIsIlRhcmdldExvY2F0aW9uIjowfQ&maxresults=1"
}
定义
名称 | 说明 |
---|---|
Certificate |
证书管理属性。 |
Deleted |
包含有关已删除证书的元数据的已删除证书项。 |
Deleted |
已在此保管库中删除的证书列表。 |
Deletion |
反映当前保管库中证书当前生效的删除恢复级别。 如果它包含“Purgeable”,则特权用户可以永久删除证书;否则,只有系统才能在保留间隔结束时清除证书。 |
Error |
密钥保管库服务器错误。 |
Key |
密钥保管库错误异常。 |
CertificateAttributes
证书管理属性。
名称 | 类型 | 说明 |
---|---|---|
created |
integer |
创建时间(UTC)。 |
enabled |
boolean |
确定是否启用对象。 |
exp |
integer |
到期日期(UTC)。 |
nbf |
integer |
不早于 UTC 日期。 |
recoverableDays |
integer |
softDelete 数据保留天数。 启用 softDelete 时,值应为 >=7 和 <=90,否则为 0。 |
recoveryLevel |
反映当前保管库中证书当前生效的删除恢复级别。 如果它包含“Purgeable”,则特权用户可以永久删除证书;否则,只有系统才能在保留间隔结束时清除证书。 |
|
updated |
integer |
上次更新时间(UTC)。 |
DeletedCertificateItem
包含有关已删除证书的元数据的已删除证书项。
名称 | 类型 | 说明 |
---|---|---|
attributes |
证书管理属性。 |
|
deletedDate |
integer |
删除证书的时间(UTC) |
id |
string |
证书标识符。 |
recoveryId |
string |
恢复对象的 URL,用于标识和恢复已删除的证书。 |
scheduledPurgeDate |
integer |
计划清除证书的时间(UTC) |
tags |
object |
键/值对形式的应用程序特定元数据。 |
x5t |
string |
证书的指纹。 |
DeletedCertificateListResult
已在此保管库中删除的证书列表。
名称 | 类型 | 说明 |
---|---|---|
nextLink |
string |
用于获取下一组已删除证书的 URL。 |
value |
包含保管库中已删除证书的列表以及指向已删除证书的下一页的链接的响应消息 |
DeletionRecoveryLevel
反映当前保管库中证书当前生效的删除恢复级别。 如果它包含“Purgeable”,则特权用户可以永久删除证书;否则,只有系统才能在保留间隔结束时清除证书。
名称 | 类型 | 说明 |
---|---|---|
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
密钥保管库服务器错误。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误代码。 |
innererror |
密钥保管库服务器错误。 |
|
message |
string |
错误消息。 |
KeyVaultError
密钥保管库错误异常。
名称 | 类型 | 说明 |
---|---|---|
error |
密钥保管库服务器错误。 |