encrypts
Creates, updates, deletes, gets or lists an encrypts resource.
Overview
| Name | encrypts |
| Type | Resource |
| Id | azure.key_vault_keys.encrypts |
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 |
|---|---|---|---|---|
encrypt | exec | key_name, key_version, vault_name, alg, value | Encrypts an arbitrary sequence of bytes using an encryption key that is stored in a key vault. The ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only supports a single block of data, the size of which is dependent on the target key and the encryption algorithm to be used. The ENCRYPT operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using 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/encrypt 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
- encrypt
Encrypts an arbitrary sequence of bytes using an encryption key that is stored in a key vault. The ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only supports a single block of data, the size of which is dependent on the target key and the encryption algorithm to be used. The ENCRYPT operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using 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/encrypt permission.
EXEC azure.key_vault_keys.encrypts.encrypt
@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 }}"
}'
;