| Description | : Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation includes deletion-specific information. The Get Deleted Keys operation is applicable for vaults enabled for soft-delete. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/list permission. |
| Reference | : Link ¶ |
⚶ Changes
{
"#id": "GetDeletedKeys",
"$parameters": [
{
"#name": "api-version",
"Description": {
"new": "The API version to use for this operation.",
"old": "Client API version."
}
}
],
"$responses": {
"200": {
"$properties": [
{
"#name": "value",
"Description": {
"new": "A response message containing a list of deleted keys in the key vault along with a link to the next page of deleted keys.",
"old": "A response message containing a list of deleted keys in the vault along with a link to the next page of deleted keys"
},
"$items": {
"$properties": {
"@added_259550533bd84e38ad4913b3c7d80413": {
"#name": "kid",
"Description": "Key identifier.",
"Required": false,
"Type": "string"
},
"@added_b81ccf40c8f44890b2fd6eaf048ce775": {
"#name": "attributes",
"Description": "The key management attributes.",
"Required": false,
"Type": "object",
"$properties": [
{
"#name": "enabled",
"Description": "Determines whether the object is enabled.",
"Required": false,
"Type": "boolean"
},
{
"#name": "nbf",
"Description": "Not before date in UTC.",
"Format": "unixtime",
"Required": false,
"Type": "integer"
},
{
"#name": "exp",
"Description": "Expiry date in UTC.",
"Format": "unixtime",
"Required": false,
"Type": "integer"
},
{
"#name": "created",
"Description": "Creation time in UTC.",
"Format": "unixtime",
"Required": false,
"Type": "integer"
},
{
"#name": "updated",
"Description": "Last updated time in UTC.",
"Format": "unixtime",
"Required": false,
"Type": "integer"
},
{
"#name": "recoverableDays",
"Description": "softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0.",
"Format": "int32",
"Required": false,
"Type": "integer"
},
{
"#name": "recoveryLevel",
"Description": "Reflects the deletion recovery level currently in effect for keys in the current vault. If it contains 'Purgeable' the key can be permanently deleted by a privileged user; otherwise, only the system can purge the key, at the end of the retention interval.",
"Enum": [
[
"Purgeable",
"Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)"
],
[
"Recoverable+Purgeable",
"Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered"
],
[
"Recoverable",
"Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered"
],
[
"Recoverable+ProtectedSubscription",
"Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered"
],
[
"CustomizedRecoverable+Purgeable",
"Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled."
],
[
"CustomizedRecoverable",
"Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available."
],
[
"CustomizedRecoverable+ProtectedSubscription",
"Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7 <= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled."
]
],
"Required": false,
"Type": "string"
},
{
"#name": "exportable",
"Description": "Indicates if the private key can be exported. Release policy must be provided when creating the first version of an exportable key.",
"Required": false,
"Type": "boolean"
},
{
"#name": "hsmPlatform",
"Description": "The underlying HSM Platform.",
"Required": false,
"Type": "string"
}
]
},
"@added_f6776b8fa51641908e65e73413493556": {
"#name": "tags",
"Description": "Application specific metadata in the form of key-value pairs.",
"Required": false,
"Type": "object"
},
"@added_690e62af7a324b55b28a5db4a6d65e51": {
"#name": "managed",
"Description": "True if the key's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true.",
"Required": false,
"Type": "boolean"
}
}
}
}
]
}
}
}
⚼ Request
GET:
/deletedkeys
{
api-version:
string
,
maxresults:
integer
,
}
⚐ Response (200)
{
value:
[
]
,
{
,
kid:
string
,
attributes:
{
,
enabled:
boolean
,
nbf:
integer
,
exp:
integer
,
created:
integer
,
updated:
integer
,
recoverableDays:
integer
,
recoveryLevel:
enum
,
exportable:
boolean
,
hsmPlatform:
string
,
}
tags:
object
,
managed:
boolean
,
recoveryId:
string
,
scheduledPurgeDate:
integer
,
deletedDate:
integer
,
}
nextLink:
string
,
}
⚐ Response (default)
{
error:
}
{
,
code:
string
,
message:
string
,
innererror:
string
,
}