rotate_keys

Creates, updates, deletes, gets or lists a rotate_keys resource.

Overview

Name	rotate_keys
Type	Resource
Id	azure.key_vault_keys.rotate_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
rotate_key	exec	key_name, vault_name		Creates a new key version, stores it, then returns key parameters, attributes and policy to the client. The operation will rotate the key based on the key policy. It requires the keys/rotate 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 key to be rotated. The system will generate a new version in the specified key. Required.
vault_name	string	Key vault name. (default: )

Lifecycle Methods

rotate_key

Creates a new key version, stores it, then returns key parameters, attributes and policy to the client. The operation will rotate the key based on the key policy. It requires the keys/rotate permission.

EXEC azure.key_vault_keys.rotate_keys.rotate_key 
@key_name='{{ key_name }}' --required, 
@vault_name='{{ vault_name }}' --required
;