clusters

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

Overview

Name	clusters
Type	Resource
Id	azure.hdinsight.clusters

Fields

vw_clusters

Name	Datatype	Description
clusterName	text	field from the properties object
cluster_definition	text	field from the properties object
cluster_hdp_version	text	field from the properties object
cluster_id	text	field from the properties object
cluster_state	text	field from the properties object
cluster_version	text	field from the properties object
compute_isolation_properties	text	field from the properties object
compute_profile	text	field from the properties object
connectivity_endpoints	text	field from the properties object
created_date	text	field from the properties object
disk_encryption_properties	text	field from the properties object
encryption_in_transit_properties	text	field from the properties object
errors	text	field from the properties object
etag	text	The ETag for the resource
excluded_services_config	text	field from the properties object
identity	text	Identity for the cluster.
kafka_rest_properties	text	field from the properties object
location	text	The geo-location where the resource lives
min_supported_tls_version	text	field from the properties object
network_properties	text	field from the properties object
os_type	text	field from the properties object
private_endpoint_connections	text	field from the properties object
private_link_configurations	text	field from the properties object
provisioning_state	text	field from the properties object
quota_info	text	field from the properties object
resourceGroupName	text	field from the properties object
security_profile	text	field from the properties object
storage_profile	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Resource tags.
tier	text	field from the properties object
zones	text	The availability zones.

clusters

Name	Datatype	Description
etag	string	The ETag for the resource
identity	object	Identity for the cluster.
location	string	The geo-location where the resource lives
properties	object	The properties of cluster.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
zones	array	The availability zones.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	clusterName, resourceGroupName, subscriptionId	Gets the specified cluster.
list	SELECT	subscriptionId	Lists all the HDInsight clusters under the subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Lists the HDInsight clusters in a resource group.
create	INSERT	clusterName, resourceGroupName, subscriptionId	Creates a new HDInsight cluster with the specified parameters.
delete	DELETE	clusterName, resourceGroupName, subscriptionId	Deletes the specified HDInsight cluster.
update	UPDATE	clusterName, resourceGroupName, subscriptionId	Patch HDInsight cluster with the specified parameters.
execute_script_actions	EXEC	clusterName, resourceGroupName, subscriptionId, data__persistOnSuccess	Executes script actions on the specified HDInsight cluster.
resize	EXEC	clusterName, resourceGroupName, roleName, subscriptionId	Resizes the specified HDInsight cluster to the specified size.
rotate_disk_encryption_key	EXEC	clusterName, resourceGroupName, subscriptionId	Rotate disk encryption key of the specified HDInsight cluster.

SELECT examples

Lists all the HDInsight clusters under the subscription.

vw_clusters

SELECT
clusterName,
cluster_definition,
cluster_hdp_version,
cluster_id,
cluster_state,
cluster_version,
compute_isolation_properties,
compute_profile,
connectivity_endpoints,
created_date,
disk_encryption_properties,
encryption_in_transit_properties,
errors,
etag,
excluded_services_config,
identity,
kafka_rest_properties,
location,
min_supported_tls_version,
network_properties,
os_type,
private_endpoint_connections,
private_link_configurations,
provisioning_state,
quota_info,
resourceGroupName,
security_profile,
storage_profile,
subscriptionId,
system_data,
tags,
tier,
zones
FROM azure.hdinsight.vw_clusters
WHERE subscriptionId = '{{ subscriptionId }}';

clusters

SELECT
etag,
identity,
location,
properties,
systemData,
tags,
zones
FROM azure.hdinsight.clusters
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.hdinsight.clusters (
clusterName,
resourceGroupName,
subscriptionId,
location,
tags,
zones,
properties,
identity
)
SELECT 
'{{ clusterName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ location }}',
'{{ tags }}',
'{{ zones }}',
'{{ properties }}',
'{{ identity }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: location
      value: string
    - name: tags
      value: object
    - name: zones
      value:
        - string
    - name: properties
      value:
        - name: clusterVersion
          value: string
        - name: osType
          value: string
        - name: tier
          value: string
        - name: clusterDefinition
          value:
            - name: blueprint
              value: string
            - name: kind
              value: string
            - name: componentVersion
              value: object
            - name: configurations
              value: object
        - name: kafkaRestProperties
          value:
            - name: clientGroupInfo
              value:
                - name: groupName
                  value: string
                - name: groupId
                  value: string
            - name: configurationOverride
              value: object
        - name: securityProfile
          value:
            - name: directoryType
              value: string
            - name: domain
              value: string
            - name: organizationalUnitDN
              value: string
            - name: ldapsUrls
              value:
                - string
            - name: domainUsername
              value: string
            - name: domainUserPassword
              value: string
            - name: clusterUsersGroupDNs
              value:
                - string
            - name: aaddsResourceId
              value: string
            - name: msiResourceId
              value: string
        - name: computeProfile
          value:
            - name: roles
              value:
                - - name: name
                    value: string
                  - name: minInstanceCount
                    value: integer
                  - name: targetInstanceCount
                    value: integer
                  - name: VMGroupName
                    value: string
                  - name: autoscale
                    value:
                      - name: capacity
                        value:
                          - name: minInstanceCount
                            value: integer
                          - name: maxInstanceCount
                            value: integer
                      - name: recurrence
                        value:
                          - name: timeZone
                            value: string
                          - name: schedule
                            value:
                              - - name: days
                                  value:
                                    - string
                                - name: timeAndCapacity
                                  value:
                                    - name: time
                                      value: string
                                    - name: minInstanceCount
                                      value: integer
                                    - name: maxInstanceCount
                                      value: integer
                  - name: hardwareProfile
                    value:
                      - name: vmSize
                        value: string
                  - name: osProfile
                    value:
                      - name: linuxOperatingSystemProfile
                        value:
                          - name: username
                            value: string
                          - name: password
                            value: string
                          - name: sshProfile
                            value:
                              - name: publicKeys
                                value:
                                  - - name: certificateData
                                      value: string
                  - name: virtualNetworkProfile
                    value:
                      - name: id
                        value: string
                      - name: subnet
                        value: string
                  - name: dataDisksGroups
                    value:
                      - - name: disksPerNode
                          value: integer
                        - name: storageAccountType
                          value: string
                        - name: diskSizeGB
                          value: integer
                  - name: scriptActions
                    value:
                      - - name: name
                          value: string
                        - name: uri
                          value: string
                        - name: parameters
                          value: string
                  - name: encryptDataDisks
                    value: boolean
        - name: storageProfile
          value:
            - name: storageaccounts
              value:
                - - name: name
                    value: string
                  - name: isDefault
                    value: boolean
                  - name: container
                    value: string
                  - name: fileSystem
                    value: string
                  - name: key
                    value: string
                  - name: resourceId
                    value: string
                  - name: msiResourceId
                    value: string
                  - name: saskey
                    value: string
                  - name: fileshare
                    value: string
                  - name: enableSecureChannel
                    value: boolean
        - name: diskEncryptionProperties
          value:
            - name: vaultUri
              value: string
            - name: keyName
              value: string
            - name: keyVersion
              value: string
            - name: encryptionAlgorithm
              value: string
            - name: msiResourceId
              value: string
            - name: encryptionAtHost
              value: boolean
        - name: encryptionInTransitProperties
          value:
            - name: isEncryptionInTransitEnabled
              value: boolean
        - name: minSupportedTlsVersion
          value: string
        - name: networkProperties
          value:
            - name: outboundDependenciesManagedType
              value: string
            - name: resourceProviderConnection
              value: string
            - name: privateLink
              value: string
            - name: publicIpTag
              value:
                - name: ipTagType
                  value: string
                - name: tag
                  value: string
        - name: computeIsolationProperties
          value:
            - name: enableComputeIsolation
              value: boolean
            - name: hostSku
              value: string
        - name: privateLinkConfigurations
          value:
            - - name: id
                value: string
              - name: name
                value: string
              - name: type
                value: string
              - name: properties
                value:
                  - name: groupId
                    value: string
                  - name: provisioningState
                    value: string
                  - name: ipConfigurations
                    value:
                      - - name: id
                          value: string
                        - name: name
                          value: string
                        - name: type
                          value: string
                        - name: properties
                          value:
                            - name: provisioningState
                              value: string
                            - name: primary
                              value: boolean
                            - name: privateIPAddress
                              value: string
                            - name: privateIPAllocationMethod
                              value: string
                            - name: subnet
                              value:
                                - name: id
                                  value: string
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: string
        - name: userAssignedIdentities
          value: object

UPDATE example

Updates a clusters resource.

/*+ update */
UPDATE azure.hdinsight.clusters
SET 
tags = '{{ tags }}',
identity = '{{ identity }}'
WHERE 
clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified clusters resource.

/*+ delete */
DELETE FROM azure.hdinsight.clusters
WHERE clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';