keys_versions

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

Overview

Name	keys_versions
Type	Resource
Id	azure.key_vault.keys_versions

Fields

The following fields are returned by SELECT queries:

get

The retrieved key version.

Name	Datatype	Description
id	string	Fully qualified identifier of the key vault resource.
name	string	Name of the key vault resource.
location	string	Azure location of the key vault resource.
properties	object	The properties of the key.
tags	object	Tags assigned to the key vault resource.
type	string	Resource type of the key vault resource.

list

The retrieved page of key versions.

Name	Datatype	Description
id	string	Fully qualified identifier of the key vault resource.
name	string	Name of the key vault resource.
location	string	Azure location of the key vault resource.
properties	object	The properties of the key.
tags	object	Tags assigned to the key vault resource.
type	string	Resource type of the key vault resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, vaultName, keyName, keyVersion		Gets the specified version of the specified key in the specified key vault.
list	select	subscriptionId, resourceGroupName, vaultName, keyName		Lists the versions of the specified key in the specified key vault.

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
keyName	string	The name of the key versions to be retrieved.
keyVersion	string	The version of the key to be retrieved.
resourceGroupName	string	The name of the resource group which contains the specified key vault.
subscriptionId	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
vaultName	string	The name of the vault which contains the key versions to be retrieved.

SELECT examples

get

Gets the specified version of the specified key in the specified key vault.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.key_vault.keys_versions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vaultName = '{{ vaultName }}' -- required
AND keyName = '{{ keyName }}' -- required
AND keyVersion = '{{ keyVersion }}' -- required
;

list

Lists the versions of the specified key in the specified key vault.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.key_vault.keys_versions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vaultName = '{{ vaultName }}' -- required
AND keyName = '{{ keyName }}' -- required
;