managed_hsm_keys_versions

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

Overview

Name	managed_hsm_keys_versions
Type	Resource
Id	azure.key_vault.managed_hsm_keys_versions

Fields

The following fields are returned by SELECT queries:

get

The retrieved key version.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object	The properties of the key.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

The retrieved page of key versions.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object	The properties of the key.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

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

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 to be created. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.
keyVersion	string	The version of the key to be retrieved.
name	string	The name of the Managed HSM Pool within the specified resource group.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Gets the specified version of the specified key in the specified managed HSM.

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

list

Lists the versions of the specified key in the specified managed HSM.

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