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

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.
activationState	string	State of security domain activation. Known values are: "NotDefined", "NotActivated", "Active", "Failed", and "Unknown". (NotDefined, NotActivated, Active, Failed, Unknown)
autoGeneratedDomainNameLabelScope	string	The Cloud HSM Cluster's auto-generated Domain Name Label Scope. Known values are: "TenantReuse", "SubscriptionReuse", "ResourceGroupReuse", and "NoReuse". (TenantReuse, SubscriptionReuse, ResourceGroupReuse, NoReuse)
hsms	array	An array of Cloud HSM Cluster's HSMs.
identity	object	Managed service identity (system assigned and/or user assigned identities).
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	List of private endpoint connection resources.
provisioningState	string	The Cloud HSM Cluster's provisioningState. Known values are: "Provisioning", "Succeeded", "Updating", "Failed", "Deleting", and "Canceled". (Provisioning, Succeeded, Updating, Failed, Deleting, Canceled)
publicNetworkAccess	string	The Cloud HSM Cluster public network access. "Disabled" (Disabled)
sku	object	SKU details.
statusMessage	string	Cloud HSM Cluster status message.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

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.
activationState	string	State of security domain activation. Known values are: "NotDefined", "NotActivated", "Active", "Failed", and "Unknown". (NotDefined, NotActivated, Active, Failed, Unknown)
autoGeneratedDomainNameLabelScope	string	The Cloud HSM Cluster's auto-generated Domain Name Label Scope. Known values are: "TenantReuse", "SubscriptionReuse", "ResourceGroupReuse", and "NoReuse". (TenantReuse, SubscriptionReuse, ResourceGroupReuse, NoReuse)
hsms	array	An array of Cloud HSM Cluster's HSMs.
identity	object	Managed service identity (system assigned and/or user assigned identities).
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	List of private endpoint connection resources.
provisioningState	string	The Cloud HSM Cluster's provisioningState. Known values are: "Provisioning", "Succeeded", "Updating", "Failed", "Deleting", and "Canceled". (Provisioning, Succeeded, Updating, Failed, Deleting, Canceled)
publicNetworkAccess	string	The Cloud HSM Cluster public network access. "Disabled" (Disabled)
sku	object	SKU details.
statusMessage	string	Cloud HSM Cluster status message.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

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.
activationState	string	State of security domain activation. Known values are: "NotDefined", "NotActivated", "Active", "Failed", and "Unknown". (NotDefined, NotActivated, Active, Failed, Unknown)
autoGeneratedDomainNameLabelScope	string	The Cloud HSM Cluster's auto-generated Domain Name Label Scope. Known values are: "TenantReuse", "SubscriptionReuse", "ResourceGroupReuse", and "NoReuse". (TenantReuse, SubscriptionReuse, ResourceGroupReuse, NoReuse)
hsms	array	An array of Cloud HSM Cluster's HSMs.
identity	object	Managed service identity (system assigned and/or user assigned identities).
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	List of private endpoint connection resources.
provisioningState	string	The Cloud HSM Cluster's provisioningState. Known values are: "Provisioning", "Succeeded", "Updating", "Failed", "Deleting", and "Canceled". (Provisioning, Succeeded, Updating, Failed, Deleting, Canceled)
publicNetworkAccess	string	The Cloud HSM Cluster public network access. "Disabled" (Disabled)
sku	object	SKU details.
statusMessage	string	Cloud HSM Cluster status message.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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	resource_group_name, cloud_hsm_cluster_name, subscription_id		Gets the specified Cloud HSM Cluster.
list_by_resource_group	select	resource_group_name, subscription_id	$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	subscription_id	$skiptoken	The List operation gets information about the Cloud HSM Clusters associated with the subscription.
create_or_update	insert	resource_group_name, cloud_hsm_cluster_name, subscription_id, location		Create or Update a Cloud HSM Cluster in the specified subscription.
update	update	resource_group_name, cloud_hsm_cluster_name, subscription_id		Update a Cloud HSM Cluster in the specified subscription.
create_or_update	replace	resource_group_name, cloud_hsm_cluster_name, subscription_id, location		Create or Update a Cloud HSM Cluster in the specified subscription.
delete	delete	resource_group_name, cloud_hsm_cluster_name, subscription_id		Deletes the specified Cloud HSM Cluster.
validate_backup_properties	exec	resource_group_name, cloud_hsm_cluster_name, subscription_id, azureStorageBlobContainerUri		Pre Backup operation to validate whether the customer can perform a backup on the Cloud HSM Cluster resource in the specified subscription.
backup	exec	resource_group_name, cloud_hsm_cluster_name, subscription_id, azureStorageBlobContainerUri		Create a backup of the Cloud HSM Cluster in the specified subscription.
validate_restore_properties	exec	resource_group_name, cloud_hsm_cluster_name, subscription_id, azureStorageBlobContainerUri, backupId		Queued validating pre restore operation.
restore	exec	resource_group_name, cloud_hsm_cluster_name, subscription_id, azureStorageBlobContainerUri, 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
cloud_hsm_cluster_name	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. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$skiptoken	string	The page-continuation token to use with a paged version of this API. Default value is None.

SELECT examples

get

Gets the specified Cloud HSM Cluster.

SELECT
id,
name,
activationState,
autoGeneratedDomainNameLabelScope,
hsms,
identity,
location,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
statusMessage,
systemData,
tags,
type
FROM azure.hardware_security_modules.cloud_hsm_clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cloud_hsm_cluster_name = '{{ cloud_hsm_cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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
id,
name,
activationState,
autoGeneratedDomainNameLabelScope,
hsms,
identity,
location,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
statusMessage,
systemData,
tags,
type
FROM azure.hardware_security_modules.cloud_hsm_clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $skiptoken = '{{ $skiptoken }}'
;

list_by_subscription

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

SELECT
id,
name,
activationState,
autoGeneratedDomainNameLabelScope,
hsms,
identity,
location,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
statusMessage,
systemData,
tags,
type
FROM azure.hardware_security_modules.cloud_hsm_clusters
WHERE subscription_id = '{{ subscription_id }}' -- 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 (
tags,
location,
properties,
identity,
sku,
resource_group_name,
cloud_hsm_cluster_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ sku }}',
'{{ resource_group_name }}',
'{{ cloud_hsm_cluster_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: cloud_hsm_clusters
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the cloud_hsm_clusters resource.
  - name: cloud_hsm_cluster_name
    value: "{{ cloud_hsm_cluster_name }}"
    description: Required parameter for the cloud_hsm_clusters resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the cloud_hsm_clusters resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Properties of the Cloud HSM Cluster.
    value:
      activationState: "{{ activationState }}"
      autoGeneratedDomainNameLabelScope: "{{ autoGeneratedDomainNameLabelScope }}"
      hsms:
        - fqdn: "{{ fqdn }}"
          state: "{{ state }}"
          stateMessage: "{{ stateMessage }}"
      privateEndpointConnections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          systemData:
            createdBy: "{{ createdBy }}"
            createdByType: "{{ createdByType }}"
            createdAt: "{{ createdAt }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            lastModifiedByType: "{{ lastModifiedByType }}"
            lastModifiedAt: "{{ lastModifiedAt }}"
          properties:
            privateEndpoint:
              id: "{{ id }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
            provisioningState: "{{ provisioningState }}"
            groupIds:
              - "{{ groupIds }}"
          etag: "{{ etag }}"
      provisioningState: "{{ provisioningState }}"
      publicNetworkAccess: "{{ publicNetworkAccess }}"
      statusMessage: "{{ statusMessage }}"
  - name: identity
    description: |
      Managed service identity (system assigned and/or user assigned identities).
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: sku
    description: |
      SKU details.
    value:
      family: "{{ family }}"
      name: "{{ name }}"
      capacity: {{ capacity }}

UPDATE examples

update

Update a Cloud HSM Cluster in the specified subscription.

UPDATE azure.hardware_security_modules.cloud_hsm_clusters
SET 
tags = '{{ tags }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cloud_hsm_cluster_name = '{{ cloud_hsm_cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type;

REPLACE examples

create_or_update

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

REPLACE azure.hardware_security_modules.cloud_hsm_clusters
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}',
sku = '{{ sku }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cloud_hsm_cluster_name = '{{ cloud_hsm_cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Deletes the specified Cloud HSM Cluster.

DELETE FROM azure.hardware_security_modules.cloud_hsm_clusters
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cloud_hsm_cluster_name = '{{ cloud_hsm_cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --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 
@resource_group_name='{{ resource_group_name }}' --required, 
@cloud_hsm_cluster_name='{{ cloud_hsm_cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --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 
@resource_group_name='{{ resource_group_name }}' --required, 
@cloud_hsm_cluster_name='{{ cloud_hsm_cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --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 
@resource_group_name='{{ resource_group_name }}' --required, 
@cloud_hsm_cluster_name='{{ cloud_hsm_cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"azureStorageBlobContainerUri": "{{ azureStorageBlobContainerUri }}", 
"token": "{{ token }}", 
"backupId": "{{ backupId }}"
}'
;

restore

Restores all key materials of a specified Cloud HSM Cluster.

EXEC azure.hardware_security_modules.cloud_hsm_clusters.restore 
@resource_group_name='{{ resource_group_name }}' --required, 
@cloud_hsm_cluster_name='{{ cloud_hsm_cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"azureStorageBlobContainerUri": "{{ azureStorageBlobContainerUri }}", 
"token": "{{ token }}", 
"backupId": "{{ backupId }}"
}'
;