managed_hsm_keys

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

Overview

Name	managed_hsm_keys
Type	Resource
Id	azure.key_vault.managed_hsm_keys

Fields

The following fields are returned by SELECT queries:

get

The retrieved key.

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 keys.

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		Gets the current version of the specified key from the specified managed HSM.
list	select	subscriptionId, resourceGroupName, name		Lists the keys in the specified managed HSM.
create_if_not_exist	insert	subscriptionId, resourceGroupName, name, keyName, data__properties		Creates the first version of a new key if it does not exist. If it already exists, then the existing key is returned without any write operations being performed. This API does not create subsequent versions, and does not update existing keys.

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.
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 current version of the specified key from the specified managed HSM.

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

list

Lists the keys in the specified managed HSM.

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

INSERT examples

create_if_not_exist

Creates the first version of a new key if it does not exist. If it already exists, then the existing key is returned without any write operations being performed. This API does not create subsequent versions, and does not update existing keys.

INSERT INTO azure.key_vault.managed_hsm_keys (
data__tags,
data__properties,
subscriptionId,
resourceGroupName,
name,
keyName
)
SELECT 
'{{ tags }}',
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ name }}',
'{{ keyName }}'
RETURNING
id,
name,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: managed_hsm_keys
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the managed_hsm_keys resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the managed_hsm_keys resource.
    - name: name
      value: string
      description: Required parameter for the managed_hsm_keys resource.
    - name: keyName
      value: string
      description: Required parameter for the managed_hsm_keys resource.
    - name: tags
      value: object
      description: |
        The tags that will be assigned to the key.
    - name: properties
      value: object
      description: |
        The properties of the key to be created.