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

vw_cloud_hsm_clusters

Name	Datatype	Description
activation_state	text	field from the properties object
auto_generated_domain_name_label_scope	text	field from the properties object
cloudHsmClusterName	text	field from the properties object
fips_approved_mode	text	field from the properties object
hsms	text	field from the properties object
identity	text	Managed service identity (system assigned and/or user assigned identities)
private_endpoint_connections	text	field from the properties object
provisioning_state	text	field from the properties object
public_network_access	text	field from the properties object
resourceGroupName	text	field from the properties object
sku	text	Cloud Hsm Cluster SKU information
status_message	text	field from the properties object
subscriptionId	text	field from the properties object

cloud_hsm_clusters

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

Methods

Name	Accessible by	Required Params	Description
get	SELECT	cloudHsmClusterName, resourceGroupName, subscriptionId	Gets the specified Cloud HSM Cluster
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	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	The List operation gets information about the Cloud HSM Clusters associated with the subscription.
create_or_update	INSERT	cloudHsmClusterName, resourceGroupName, subscriptionId	Create or Update a Cloud HSM Cluster in the specified subscription.
delete	DELETE	cloudHsmClusterName, resourceGroupName, subscriptionId	Deletes the specified Cloud HSM Cluster
update	UPDATE	cloudHsmClusterName, resourceGroupName, subscriptionId	Update a Cloud HSM Cluster in the specified subscription.
backup	EXEC	cloudHsmClusterName, resourceGroupName, subscriptionId	Create a backup of the Cloud HSM Cluster in the specified subscription
restore	EXEC	cloudHsmClusterName, resourceGroupName, subscriptionId, data__backupId	Restores all key materials of a specified Cloud HSM Cluster
validate_backup_properties	EXEC	cloudHsmClusterName, resourceGroupName, subscriptionId	Pre Backup operation to validate whether the customer can perform a backup on the Cloud HSM Cluster resource in the specified subscription.
validate_restore_properties	EXEC	cloudHsmClusterName, resourceGroupName, subscriptionId, data__backupId	Queued validating pre restore operation

SELECT examples

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

vw_cloud_hsm_clusters

SELECT
activation_state,
auto_generated_domain_name_label_scope,
cloudHsmClusterName,
fips_approved_mode,
hsms,
identity,
private_endpoint_connections,
provisioning_state,
public_network_access,
resourceGroupName,
sku,
status_message,
subscriptionId
FROM azure.hardware_security_modules.vw_cloud_hsm_clusters
WHERE subscriptionId = '{{ subscriptionId }}';

cloud_hsm_clusters

SELECT
identity,
properties,
sku
FROM azure.hardware_security_modules.cloud_hsm_clusters
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new cloud_hsm_clusters resource.

All Properties

/*+ create */
INSERT INTO azure.hardware_security_modules.cloud_hsm_clusters (
cloudHsmClusterName,
resourceGroupName,
subscriptionId,
properties,
identity,
sku
)
SELECT 
'{{ cloudHsmClusterName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}',
'{{ identity }}',
'{{ sku }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: activationState
          value: string
        - name: autoGeneratedDomainNameLabelScope
          value: string
        - name: fipsApprovedMode
          value: boolean
        - name: hsms
          value:
            - - name: fqdn
                value: string
              - name: state
                value: string
              - name: stateMessage
                value: string
        - name: privateEndpointConnections
          value:
            - - name: properties
                value:
                  - name: groupIds
                    value:
                      - string
                  - name: privateEndpoint
                    value:
                      - name: id
                        value: string
                  - name: privateLinkServiceConnectionState
                    value:
                      - name: status
                        value: []
                      - name: description
                        value: string
                      - name: actionsRequired
                        value: string
                  - name: provisioningState
                    value: []
              - name: id
                value: string
              - name: name
                value: string
              - name: type
                value: string
              - name: systemData
                value:
                  - name: createdBy
                    value: string
                  - name: createdByType
                    value: string
                  - name: createdAt
                    value: string
                  - name: lastModifiedBy
                    value: string
                  - name: lastModifiedByType
                    value: string
                  - name: lastModifiedAt
                    value: string
        - name: provisioningState
          value: string
        - name: publicNetworkAccess
          value: string
        - name: statusMessage
          value: string
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: []
        - name: userAssignedIdentities
          value: object
    - name: sku
      value:
        - name: family
          value: string
        - name: name
          value: string
        - name: capacity
          value: integer

UPDATE example

Updates a cloud_hsm_clusters resource.

/*+ update */
UPDATE azure.hardware_security_modules.cloud_hsm_clusters
SET 
tags = '{{ tags }}',
identity = '{{ identity }}'
WHERE 
cloudHsmClusterName = '{{ cloudHsmClusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified cloud_hsm_clusters resource.

/*+ delete */
DELETE FROM azure.hardware_security_modules.cloud_hsm_clusters
WHERE cloudHsmClusterName = '{{ cloudHsmClusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';