decrypts
Creates, updates, deletes, gets or lists a decrypts resource.
Overview
| Name | decrypts |
| Type | Resource |
| Id | azure.key_vault_keys.decrypts |
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 |
|---|---|---|---|---|
decrypt | exec | key_name, key_version, vault_name, alg, value | Decrypts a single block of encrypted data. The DECRYPT operation decrypts a well-formed block of ciphertext using the target encryption key and specified algorithm. This operation is the reverse of the ENCRYPT operation; only a single block of data may be decrypted, the size of this block is dependent on the target key and the algorithm to be used. The DECRYPT 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/decrypt permission. Microsoft recommends not to use CBC algorithms for decryption without first ensuring the integrity of the ciphertext using an HMAC, for example. See https://learn.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode _ for more information. |
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
- decrypt
Decrypts a single block of encrypted data. The DECRYPT operation decrypts a well-formed block of ciphertext using the target encryption key and specified algorithm. This operation is the reverse of the ENCRYPT operation; only a single block of data may be decrypted, the size of this block is dependent on the target key and the algorithm to be used. The DECRYPT 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/decrypt permission. Microsoft recommends not to use CBC algorithms for decryption without first ensuring the integrity of the ciphertext using an HMAC, for example. See https://learn.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode _ for more information.
EXEC azure.key_vault_keys.decrypts.decrypt
@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 }}"
}'
;