wrap_keys
Creates, updates, deletes, gets or lists a wrap_keys resource.
Overview
| Name | wrap_keys |
| Type | Resource |
| Id | azure.key_vault_keys.wrap_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 |
|---|---|---|---|---|
wrap_key | exec | key_name, key_version, vault_name, alg, value | Wraps a symmetric key using a specified key. The WRAP operation supports encryption of a symmetric key using a key encryption key that has previously been stored in an Azure Key Vault. The WRAP operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using the public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/wrapKey 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
- wrap_key
Wraps a symmetric key using a specified key. The WRAP operation supports encryption of a symmetric key using a key encryption key that has previously been stored in an Azure Key Vault. The WRAP operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using the public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/wrapKey permission.
EXEC azure.key_vault_keys.wrap_keys.wrap_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 }}"
}'
;