recover_deleted_keys
Creates, updates, deletes, gets or lists a recover_deleted_keys resource.
Overview
| Name | recover_deleted_keys |
| Type | Resource |
| Id | azure.key_vault_keys.recover_deleted_keys |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
recover_deleted_key | exec | key_name, vault_name | Recovers the deleted key to its latest version. The Recover Deleted Key operation is applicable for deleted keys in soft-delete enabled vaults. It recovers the deleted key back to its latest version under /keys. An attempt to recover an non-deleted key will return an error. Consider this the inverse of the delete operation on soft-delete enabled vaults. This operation requires the keys/recover permission. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
key_name | string | The name of the deleted key. Required. |
vault_name | string | Key vault name. (default: ) |
Lifecycle Methods
- recover_deleted_key
Recovers the deleted key to its latest version. The Recover Deleted Key operation is applicable for deleted keys in soft-delete enabled vaults. It recovers the deleted key back to its latest version under /keys. An attempt to recover an non-deleted key will return an error. Consider this the inverse of the delete operation on soft-delete enabled vaults. This operation requires the keys/recover permission.
EXEC azure.key_vault_keys.recover_deleted_keys.recover_deleted_key
@key_name='{{ key_name }}' --required,
@vault_name='{{ vault_name }}' --required
;