managed_hsms

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

Overview

Name	managed_hsms
Type	Resource
Id	azure.key_vault.managed_hsms

Fields

The following fields are returned by SELECT queries:

get

Retrieved managed HSM Pool

Name	Datatype	Description
id	string	The Azure Resource Manager resource ID for the managed HSM Pool.
name	string	The name of the managed HSM Pool.
identity	object	Managed service identity (system assigned and/or user assigned identities)
location	string	The supported Azure location where the managed HSM Pool should be created.
properties	object	Properties of the managed HSM
sku	object	SKU details
systemData	object	Metadata pertaining to creation and last modification of the key vault resource.
tags	object	Resource tags
type	string	The resource type of the managed HSM Pool.

list_by_resource_group

Get information about all managed HSM Pools in the specified resource group.

Name	Datatype	Description
id	string	The Azure Resource Manager resource ID for the managed HSM Pool.
name	string	The name of the managed HSM Pool.
identity	object	Managed service identity (system assigned and/or user assigned identities)
location	string	The supported Azure location where the managed HSM Pool should be created.
properties	object	Properties of the managed HSM
sku	object	SKU details
systemData	object	Metadata pertaining to creation and last modification of the key vault resource.
tags	object	Resource tags
type	string	The resource type of the managed HSM Pool.

list_by_subscription

Get information about all managed HSM Pools in the specified subscription.

Name	Datatype	Description
id	string	The Azure Resource Manager resource ID for the managed HSM Pool.
name	string	The name of the managed HSM Pool.
identity	object	Managed service identity (system assigned and/or user assigned identities)
location	string	The supported Azure location where the managed HSM Pool should be created.
properties	object	Properties of the managed HSM
sku	object	SKU details
systemData	object	Metadata pertaining to creation and last modification of the key vault resource.
tags	object	Resource tags
type	string	The resource type of the managed HSM Pool.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, name, subscriptionId		Gets the specified managed HSM Pool.
list_by_resource_group	select	resourceGroupName, subscriptionId	$top	The List operation gets information about the managed HSM Pools associated with the subscription and within the specified resource group.
list_by_subscription	select	subscriptionId	$top	The List operation gets information about the managed HSM Pools associated with the subscription.
create_or_update	insert	resourceGroupName, name, subscriptionId		Create or update a managed HSM Pool in the specified subscription.
update	update	resourceGroupName, name, subscriptionId		Update a managed HSM Pool in the specified subscription.
delete	delete	resourceGroupName, name, subscriptionId		Deletes the specified managed HSM Pool.
purge_deleted	exec	name, location, subscriptionId		Permanently deletes the specified managed HSM.
check_mhsm_name_availability	exec	subscriptionId, name		Checks that the managed hsm name is valid and is not already in use.

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
location	string	The location of the soft-deleted managed HSM.
name	string	The name of the soft-deleted managed HSM.
resourceGroupName	string	Name of the resource group that contains the managed HSM pool.
subscriptionId	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
$top	integer (int32)	Maximum number of results to return.

SELECT examples

get

Gets the specified managed HSM Pool.

SELECT
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.key_vault.managed_hsms
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

The List operation gets information about the managed HSM Pools associated with the subscription and within the specified resource group.

SELECT
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.key_vault.managed_hsms
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $top = '{{ $top }}'
;

list_by_subscription

The List operation gets information about the managed HSM Pools associated with the subscription.

SELECT
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.key_vault.managed_hsms
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Create or update a managed HSM Pool in the specified subscription.

INSERT INTO azure.key_vault.managed_hsms (
data__properties,
data__location,
data__sku,
data__tags,
data__identity,
resourceGroupName,
name,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ sku }}',
'{{ tags }}',
'{{ identity }}',
'{{ resourceGroupName }}',
'{{ name }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: managed_hsms
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the managed_hsms resource.
    - name: name
      value: string
      description: Required parameter for the managed_hsms resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the managed_hsms resource.
    - name: properties
      value: object
      description: |
        Properties of the managed HSM
    - name: location
      value: string
      description: |
        The supported Azure location where the managed HSM Pool should be created.
    - name: sku
      value: object
      description: |
        SKU details
    - name: tags
      value: object
      description: |
        Resource tags
    - name: identity
      value: object
      description: |
        Managed service identity (system assigned and/or user assigned identities)

UPDATE examples

update

Update a managed HSM Pool in the specified subscription.

UPDATE azure.key_vault.managed_hsms
SET 
data__properties = '{{ properties }}',
data__location = '{{ location }}',
data__sku = '{{ sku }}',
data__tags = '{{ tags }}',
data__identity = '{{ identity }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Deletes the specified managed HSM Pool.

DELETE FROM azure.key_vault.managed_hsms
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

purge_deleted

Permanently deletes the specified managed HSM.

EXEC azure.key_vault.managed_hsms.purge_deleted 
@name='{{ name }}' --required, 
@location='{{ location }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

check_mhsm_name_availability

Checks that the managed hsm name is valid and is not already in use.

EXEC azure.key_vault.managed_hsms.check_mhsm_name_availability 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"name": "{{ name }}"
}'
;