cloud_hsm_clusters

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

Overview

Name	cloud_hsm_clusters
Type	Resource
Id	azure.hardware_security_modules.cloud_hsm_clusters

Fields

The following fields are returned by SELECT queries:

get

Retrieved Cloud HSM Cluster

Name	Datatype	Description
identity	object	Managed service identity (system assigned and/or user assigned identities)
properties	object	Properties of the Cloud HSM Cluster
sku	object	SKU details

list_by_resource_group

Get information about all Cloud HSM Clusters in the specified resource group.

Name	Datatype	Description
identity	object	Managed service identity (system assigned and/or user assigned identities)
properties	object	Properties of the Cloud HSM Cluster
sku	object	SKU details

list_by_subscription

Get information about all Cloud HSM Clusters in the specified subscription.

Name	Datatype	Description
identity	object	Managed service identity (system assigned and/or user assigned identities)
properties	object	Properties of the Cloud HSM Cluster
sku	object	SKU details

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, cloudHsmClusterName		Gets the specified Cloud HSM Cluster
list_by_resource_group	select	subscriptionId, resourceGroupName	$skiptoken	The List operation gets information about the Cloud HSM Clusters associated with the subscription and within the specified resource group.
list_by_subscription	select	subscriptionId	$skiptoken	The List operation gets information about the Cloud HSM Clusters associated with the subscription.
create_or_update	insert	subscriptionId, resourceGroupName, cloudHsmClusterName		Create or Update a Cloud HSM Cluster in the specified subscription.
update	update	subscriptionId, resourceGroupName, cloudHsmClusterName		Update a Cloud HSM Cluster in the specified subscription.
delete	delete	subscriptionId, resourceGroupName, cloudHsmClusterName		Deletes the specified Cloud HSM Cluster
validate_backup_properties	exec	subscriptionId, resourceGroupName, cloudHsmClusterName		Pre Backup operation to validate whether the customer can perform a backup on the Cloud HSM Cluster resource in the specified subscription.
backup	exec	subscriptionId, resourceGroupName, cloudHsmClusterName		Create a backup of the Cloud HSM Cluster in the specified subscription
validate_restore_properties	exec	subscriptionId, resourceGroupName, cloudHsmClusterName, backupId		Queued validating pre restore operation
restore	exec	subscriptionId, resourceGroupName, cloudHsmClusterName, backupId		Restores all key materials of a specified Cloud HSM Cluster

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
cloudHsmClusterName	string	The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$skiptoken	string	The page-continuation token to use with a paged version of this API

SELECT examples

get

Gets the specified Cloud HSM Cluster

SELECT
identity,
properties,
sku
FROM azure.hardware_security_modules.cloud_hsm_clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND cloudHsmClusterName = '{{ cloudHsmClusterName }}' -- required
;

list_by_resource_group

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

SELECT
identity,
properties,
sku
FROM azure.hardware_security_modules.cloud_hsm_clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND $skiptoken = '{{ $skiptoken }}'
;

list_by_subscription

The List operation gets information about the Cloud HSM Clusters associated with the subscription.

SELECT
identity,
properties,
sku
FROM azure.hardware_security_modules.cloud_hsm_clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $skiptoken = '{{ $skiptoken }}'
;

INSERT examples

create_or_update

Create or Update a Cloud HSM Cluster in the specified subscription.

INSERT INTO azure.hardware_security_modules.cloud_hsm_clusters (
data__properties,
data__identity,
data__sku,
subscriptionId,
resourceGroupName,
cloudHsmClusterName
)
SELECT 
'{{ properties }}',
'{{ identity }}',
'{{ sku }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ cloudHsmClusterName }}'
RETURNING
identity,
properties,
sku
;

Manifest

# Description fields are for documentation purposes
- name: cloud_hsm_clusters
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the cloud_hsm_clusters resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the cloud_hsm_clusters resource.
    - name: cloudHsmClusterName
      value: string
      description: Required parameter for the cloud_hsm_clusters resource.
    - name: properties
      value: object
      description: |
        Properties of the Cloud HSM Cluster
    - name: identity
      value: object
      description: |
        Managed service identity (system assigned and/or user assigned identities)
    - name: sku
      value: object
      description: |
        SKU details

UPDATE examples

update

Update a Cloud HSM Cluster in the specified subscription.

UPDATE azure.hardware_security_modules.cloud_hsm_clusters
SET 
data__tags = '{{ tags }}',
data__identity = '{{ identity }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND cloudHsmClusterName = '{{ cloudHsmClusterName }}' --required
RETURNING
identity,
properties,
sku;

DELETE examples

delete

Deletes the specified Cloud HSM Cluster

DELETE FROM azure.hardware_security_modules.cloud_hsm_clusters
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND cloudHsmClusterName = '{{ cloudHsmClusterName }}' --required
;

Lifecycle Methods

validate_backup_properties

Pre Backup operation to validate whether the customer can perform a backup on the Cloud HSM Cluster resource in the specified subscription.

EXEC azure.hardware_security_modules.cloud_hsm_clusters.validate_backup_properties 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@cloudHsmClusterName='{{ cloudHsmClusterName }}' --required 
@@json=
'{
"azureStorageBlobContainerUri": "{{ azureStorageBlobContainerUri }}", 
"token": "{{ token }}"
}'
;

backup

Create a backup of the Cloud HSM Cluster in the specified subscription

EXEC azure.hardware_security_modules.cloud_hsm_clusters.backup 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@cloudHsmClusterName='{{ cloudHsmClusterName }}' --required 
@@json=
'{
"azureStorageBlobContainerUri": "{{ azureStorageBlobContainerUri }}", 
"token": "{{ token }}"
}'
;

validate_restore_properties

Queued validating pre restore operation

EXEC azure.hardware_security_modules.cloud_hsm_clusters.validate_restore_properties 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@cloudHsmClusterName='{{ cloudHsmClusterName }}' --required 
@@json=
'{
"backupId": "{{ backupId }}", 
"azureStorageBlobContainerUri": "{{ azureStorageBlobContainerUri }}", 
"token": "{{ token }}"
}'
;

restore

Restores all key materials of a specified Cloud HSM Cluster

EXEC azure.hardware_security_modules.cloud_hsm_clusters.restore 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@cloudHsmClusterName='{{ cloudHsmClusterName }}' --required 
@@json=
'{
"backupId": "{{ backupId }}", 
"azureStorageBlobContainerUri": "{{ azureStorageBlobContainerUri }}", 
"token": "{{ token }}"
}'
;