key_versions

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

Overview

Name	key_versions
Type	Resource
Id	azure.key_vault_keys.key_versions

Fields

The following fields are returned by SELECT queries:

get_key_versions

Name	Datatype	Description
attributes	object	The key management attributes.
kid	string	Key identifier.
managed	boolean	True if the key's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true.
tags	object	Application specific metadata in the form of key-value pairs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_key_versions	select	key_name, vault_name	maxresults	Retrieves a list of individual key versions with the same key name. The full key identifier, attributes, and tags are provided in the response. This operation requires the keys/list 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.
vault_name	string	Key vault name. (default: )
maxresults	integer	Maximum number of results to return in a page. If not specified the service will return up to 25 results. Default value is None.

SELECT examples

get_key_versions

Retrieves a list of individual key versions with the same key name. The full key identifier, attributes, and tags are provided in the response. This operation requires the keys/list permission.

SELECT
attributes,
kid,
managed,
tags
FROM azure.key_vault_keys.key_versions
WHERE key_name = '{{ key_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND maxresults = '{{ maxresults }}'
;