unwrap_keys
Creates, updates, deletes, gets or lists an unwrap_keys resource.
Overview
| Name | unwrap_keys |
| Type | Resource |
| Id | azure.key_vault_keys.unwrap_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 |
|---|---|---|---|---|
unwrap_key | exec | key_name, key_version, vault_name, alg, value | Unwraps a symmetric key using the specified key that was initially used for wrapping that key. The UNWRAP operation supports decryption of a symmetric key using the target key encryption key. This operation is the reverse of the WRAP operation. The UNWRAP operation applies to asymmetric and symmetric keys stored in Azure Key Vault since it uses the private portion of the key. This operation requires the keys/unwrapKey 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 key. Required. |
key_version | string | The version of the key. Required. |
vault_name | string | Key vault name. (default: ) |
Lifecycle Methods
- unwrap_key
Unwraps a symmetric key using the specified key that was initially used for wrapping that key. The UNWRAP operation supports decryption of a symmetric key using the target key encryption key. This operation is the reverse of the WRAP operation. The UNWRAP operation applies to asymmetric and symmetric keys stored in Azure Key Vault since it uses the private portion of the key. This operation requires the keys/unwrapKey permission.
EXEC azure.key_vault_keys.unwrap_keys.unwrap_key
@key_name='{{ key_name }}' --required,
@key_version='{{ key_version }}' --required,
@vault_name='{{ vault_name }}' --required
@@json=
'{
"alg": "{{ alg }}",
"value": "{{ value }}",
"iv": "{{ iv }}",
"aad": "{{ aad }}",
"tag": "{{ tag }}"
}'
;