clusters

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

Overview

Name	clusters
Type	Resource
Id	azure.hdinsight.clusters

Fields

The following fields are returned by SELECT queries:

get_azure_async_operation_status

Name	Datatype	Description
error	object	The error message associated with the cluster creation.
status	string	The async operation state. Known values are: "InProgress", "Succeeded", and "Failed". (InProgress, Succeeded, Failed)

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.
clusterDefinition	object	The cluster definition. Required.
clusterHdpVersion	string	The hdp version of the cluster.
clusterId	string	The cluster id.
clusterState	string	The state of the cluster.
clusterVersion	string	The version of the cluster.
computeIsolationProperties	object	The compute isolation properties.
computeProfile	object	The compute profile.
connectivityEndpoints	array	The list of connectivity endpoints.
createdDate	string	The date on which the cluster was created.
diskEncryptionProperties	object	The disk encryption properties.
encryptionInTransitProperties	object	The encryption-in-transit properties.
errors	array	The list of errors.
etag	string	The ETag for the resource.
excludedServicesConfig	object	The excluded services config.
identity	object	The identity of the cluster, if configured.
kafkaRestProperties	object	The cluster kafka rest proxy configuration.
location	string	The geo-location where the resource lives. Required.
minSupportedTlsVersion	string	The minimal supported tls version.
networkProperties	object	The network properties.
osType	string	The type of operating system. Known values are: "Windows" and "Linux". (Windows, Linux)
privateEndpointConnections	array	The list of private endpoint connections.
privateLinkConfigurations	array	The private link configurations.
provisioningState	string	The provisioning state, which only appears in the response. Known values are: "InProgress", "Failed", "Succeeded", "Canceled", and "Deleting". (InProgress, Failed, Succeeded, Canceled, Deleting)
quotaInfo	object	The quota information.
securityProfile	object	The security profile.
storageProfile	object	The storage profile.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
tier	string	The cluster tier. Known values are: "Standard" and "Premium". (Standard, Premium)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
zones	array	The availability zones.

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.
clusterDefinition	object	The cluster definition. Required.
clusterHdpVersion	string	The hdp version of the cluster.
clusterId	string	The cluster id.
clusterState	string	The state of the cluster.
clusterVersion	string	The version of the cluster.
computeIsolationProperties	object	The compute isolation properties.
computeProfile	object	The compute profile.
connectivityEndpoints	array	The list of connectivity endpoints.
createdDate	string	The date on which the cluster was created.
diskEncryptionProperties	object	The disk encryption properties.
encryptionInTransitProperties	object	The encryption-in-transit properties.
errors	array	The list of errors.
etag	string	The ETag for the resource.
excludedServicesConfig	object	The excluded services config.
identity	object	The identity of the cluster, if configured.
kafkaRestProperties	object	The cluster kafka rest proxy configuration.
location	string	The geo-location where the resource lives. Required.
minSupportedTlsVersion	string	The minimal supported tls version.
networkProperties	object	The network properties.
osType	string	The type of operating system. Known values are: "Windows" and "Linux". (Windows, Linux)
privateEndpointConnections	array	The list of private endpoint connections.
privateLinkConfigurations	array	The private link configurations.
provisioningState	string	The provisioning state, which only appears in the response. Known values are: "InProgress", "Failed", "Succeeded", "Canceled", and "Deleting". (InProgress, Failed, Succeeded, Canceled, Deleting)
quotaInfo	object	The quota information.
securityProfile	object	The security profile.
storageProfile	object	The storage profile.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
tier	string	The cluster tier. Known values are: "Standard" and "Premium". (Standard, Premium)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
zones	array	The availability zones.

list

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.
clusterDefinition	object	The cluster definition. Required.
clusterHdpVersion	string	The hdp version of the cluster.
clusterId	string	The cluster id.
clusterState	string	The state of the cluster.
clusterVersion	string	The version of the cluster.
computeIsolationProperties	object	The compute isolation properties.
computeProfile	object	The compute profile.
connectivityEndpoints	array	The list of connectivity endpoints.
createdDate	string	The date on which the cluster was created.
diskEncryptionProperties	object	The disk encryption properties.
encryptionInTransitProperties	object	The encryption-in-transit properties.
errors	array	The list of errors.
etag	string	The ETag for the resource.
excludedServicesConfig	object	The excluded services config.
identity	object	The identity of the cluster, if configured.
kafkaRestProperties	object	The cluster kafka rest proxy configuration.
location	string	The geo-location where the resource lives. Required.
minSupportedTlsVersion	string	The minimal supported tls version.
networkProperties	object	The network properties.
osType	string	The type of operating system. Known values are: "Windows" and "Linux". (Windows, Linux)
privateEndpointConnections	array	The list of private endpoint connections.
privateLinkConfigurations	array	The private link configurations.
provisioningState	string	The provisioning state, which only appears in the response. Known values are: "InProgress", "Failed", "Succeeded", "Canceled", and "Deleting". (InProgress, Failed, Succeeded, Canceled, Deleting)
quotaInfo	object	The quota information.
securityProfile	object	The security profile.
storageProfile	object	The storage profile.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
tier	string	The cluster tier. Known values are: "Standard" and "Premium". (Standard, Premium)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
zones	array	The availability zones.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_azure_async_operation_status	select	resource_group_name, cluster_name, operation_id, subscription_id		The the async operation status.
get	select	resource_group_name, cluster_name, subscription_id		Gets the specified cluster.
list_by_resource_group	select	resource_group_name, subscription_id		Lists the HDInsight clusters in a resource group.
list	select	subscription_id		Lists all the HDInsight clusters under the subscription.
create	insert	resource_group_name, cluster_name, subscription_id		Creates a new HDInsight cluster with the specified parameters.
update	update	resource_group_name, cluster_name, subscription_id		Patch HDInsight cluster with the specified parameters.
delete	delete	resource_group_name, cluster_name, subscription_id		Deletes the specified HDInsight cluster.
get_gateway_settings	exec	resource_group_name, cluster_name, subscription_id		Gets the gateway settings for the specified cluster.
resize	exec	resource_group_name, cluster_name, role_name, subscription_id		Resizes the specified HDInsight cluster to the specified size.
update_auto_scale_configuration	exec	resource_group_name, cluster_name, role_name, subscription_id		Updates the Autoscale Configuration for HDInsight cluster.
rotate_disk_encryption_key	exec	resource_group_name, cluster_name, subscription_id		Rotate disk encryption key of the specified HDInsight cluster.
update_gateway_settings	exec	resource_group_name, cluster_name, subscription_id		Configures the gateway settings on the specified cluster.
update_identity_certificate	exec	resource_group_name, cluster_name, subscription_id		Updates the cluster identity certificate.
execute_script_actions	exec	resource_group_name, cluster_name, subscription_id, persistOnSuccess		Executes script actions on the specified HDInsight 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
cluster_name	string	The name of the cluster. Required.
operation_id	string	The long running operation id. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
role_name	string	The constant value for the roleName. "workernode" Required.
subscription_id	string

SELECT examples

get_azure_async_operation_status

The the async operation status.

SELECT
error,
status
FROM azure.hdinsight.clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND operation_id = '{{ operation_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Gets the specified cluster.

SELECT
id,
name,
clusterDefinition,
clusterHdpVersion,
clusterId,
clusterState,
clusterVersion,
computeIsolationProperties,
computeProfile,
connectivityEndpoints,
createdDate,
diskEncryptionProperties,
encryptionInTransitProperties,
errors,
etag,
excludedServicesConfig,
identity,
kafkaRestProperties,
location,
minSupportedTlsVersion,
networkProperties,
osType,
privateEndpointConnections,
privateLinkConfigurations,
provisioningState,
quotaInfo,
securityProfile,
storageProfile,
systemData,
tags,
tier,
type,
zones
FROM azure.hdinsight.clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists the HDInsight clusters in a resource group.

SELECT
id,
name,
clusterDefinition,
clusterHdpVersion,
clusterId,
clusterState,
clusterVersion,
computeIsolationProperties,
computeProfile,
connectivityEndpoints,
createdDate,
diskEncryptionProperties,
encryptionInTransitProperties,
errors,
etag,
excludedServicesConfig,
identity,
kafkaRestProperties,
location,
minSupportedTlsVersion,
networkProperties,
osType,
privateEndpointConnections,
privateLinkConfigurations,
provisioningState,
quotaInfo,
securityProfile,
storageProfile,
systemData,
tags,
tier,
type,
zones
FROM azure.hdinsight.clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all the HDInsight clusters under the subscription.

SELECT
id,
name,
clusterDefinition,
clusterHdpVersion,
clusterId,
clusterState,
clusterVersion,
computeIsolationProperties,
computeProfile,
connectivityEndpoints,
createdDate,
diskEncryptionProperties,
encryptionInTransitProperties,
errors,
etag,
excludedServicesConfig,
identity,
kafkaRestProperties,
location,
minSupportedTlsVersion,
networkProperties,
osType,
privateEndpointConnections,
privateLinkConfigurations,
provisioningState,
quotaInfo,
securityProfile,
storageProfile,
systemData,
tags,
tier,
type,
zones
FROM azure.hdinsight.clusters
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates a new HDInsight cluster with the specified parameters.

INSERT INTO azure.hdinsight.clusters (
location,
tags,
zones,
properties,
identity,
resource_group_name,
cluster_name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ zones }}',
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type,
zones
;

Manifest

# Description fields are for documentation purposes
- name: clusters
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the clusters resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the clusters resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the clusters resource.
  - name: location
    value: "{{ location }}"
    description: |
      The location of the cluster.
  - name: tags
    value: "{{ tags }}"
    description: |
      The resource tags.
  - name: zones
    value:
      - "{{ zones }}"
    description: |
      The availability zones.
  - name: properties
    description: |
      The cluster create parameters.
    value:
      clusterVersion: "{{ clusterVersion }}"
      osType: "{{ osType }}"
      tier: "{{ tier }}"
      clusterDefinition:
        blueprint: "{{ blueprint }}"
        kind: "{{ kind }}"
        componentVersion: "{{ componentVersion }}"
        configurations: "{{ configurations }}"
      kafkaRestProperties:
        clientGroupInfo:
          groupName: "{{ groupName }}"
          groupId: "{{ groupId }}"
        configurationOverride: "{{ configurationOverride }}"
      securityProfile:
        directoryType: "{{ directoryType }}"
        domain: "{{ domain }}"
        organizationalUnitDN: "{{ organizationalUnitDN }}"
        ldapsUrls:
          - "{{ ldapsUrls }}"
        domainUsername: "{{ domainUsername }}"
        domainUserPassword: "{{ domainUserPassword }}"
        clusterUsersGroupDNs:
          - "{{ clusterUsersGroupDNs }}"
        aaddsResourceId: "{{ aaddsResourceId }}"
        msiResourceId: "{{ msiResourceId }}"
      computeProfile:
        roles:
          - name: "{{ name }}"
            minInstanceCount: {{ minInstanceCount }}
            targetInstanceCount: {{ targetInstanceCount }}
            VMGroupName: "{{ VMGroupName }}"
            autoscale:
              capacity:
                minInstanceCount: {{ minInstanceCount }}
                maxInstanceCount: {{ maxInstanceCount }}
              recurrence:
                timeZone: "{{ timeZone }}"
                schedule: "{{ schedule }}"
            hardwareProfile:
              vmSize: "{{ vmSize }}"
            osProfile:
              linuxOperatingSystemProfile:
                username: "{{ username }}"
                password: "{{ password }}"
                sshProfile: "{{ sshProfile }}"
            virtualNetworkProfile:
              id: "{{ id }}"
              subnet: "{{ subnet }}"
            dataDisksGroups: "{{ dataDisksGroups }}"
            scriptActions: "{{ scriptActions }}"
            encryptDataDisks: {{ encryptDataDisks }}
      storageProfile:
        storageaccounts:
          - name: "{{ name }}"
            isDefault: {{ isDefault }}
            container: "{{ container }}"
            fileSystem: "{{ fileSystem }}"
            key: "{{ key }}"
            resourceId: "{{ resourceId }}"
            msiResourceId: "{{ msiResourceId }}"
            saskey: "{{ saskey }}"
            fileshare: "{{ fileshare }}"
            enableSecureChannel: {{ enableSecureChannel }}
      diskEncryptionProperties:
        vaultUri: "{{ vaultUri }}"
        keyName: "{{ keyName }}"
        keyVersion: "{{ keyVersion }}"
        encryptionAlgorithm: "{{ encryptionAlgorithm }}"
        msiResourceId: "{{ msiResourceId }}"
        encryptionAtHost: {{ encryptionAtHost }}
      encryptionInTransitProperties:
        isEncryptionInTransitEnabled: {{ isEncryptionInTransitEnabled }}
      minSupportedTlsVersion: "{{ minSupportedTlsVersion }}"
      networkProperties:
        outboundDependenciesManagedType: "{{ outboundDependenciesManagedType }}"
        resourceProviderConnection: "{{ resourceProviderConnection }}"
        privateLink: "{{ privateLink }}"
        publicIpTag:
          ipTagType: "{{ ipTagType }}"
          tag: "{{ tag }}"
      computeIsolationProperties:
        enableComputeIsolation: {{ enableComputeIsolation }}
        hostSku: "{{ hostSku }}"
      privateLinkConfigurations:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            groupId: "{{ groupId }}"
            provisioningState: "{{ provisioningState }}"
            ipConfigurations:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                properties:
                  provisioningState: "{{ provisioningState }}"
                  primary: {{ primary }}
                  privateIPAddress: "{{ privateIPAddress }}"
                  privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
                  subnet: "{{ subnet }}"
  - name: identity
    description: |
      The identity of the cluster, if configured.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Patch HDInsight cluster with the specified parameters.

UPDATE azure.hdinsight.clusters
SET 
tags = '{{ tags }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type,
zones;

DELETE examples

delete

Deletes the specified HDInsight cluster.

DELETE FROM azure.hdinsight.clusters
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_gateway_settings

Gets the gateway settings for the specified cluster.

EXEC azure.hdinsight.clusters.get_gateway_settings 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

resize

Resizes the specified HDInsight cluster to the specified size.

EXEC azure.hdinsight.clusters.resize 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@role_name='{{ role_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"targetInstanceCount": {{ targetInstanceCount }}
}'
;

update_auto_scale_configuration

Updates the Autoscale Configuration for HDInsight cluster.

EXEC azure.hdinsight.clusters.update_auto_scale_configuration 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@role_name='{{ role_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"autoscale": "{{ autoscale }}"
}'
;

rotate_disk_encryption_key

Rotate disk encryption key of the specified HDInsight cluster.

EXEC azure.hdinsight.clusters.rotate_disk_encryption_key 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"vaultUri": "{{ vaultUri }}", 
"keyName": "{{ keyName }}", 
"keyVersion": "{{ keyVersion }}"
}'
;

update_gateway_settings

Configures the gateway settings on the specified cluster.

EXEC azure.hdinsight.clusters.update_gateway_settings 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"restAuthCredential": "{{ restAuthCredential }}", 
"restAuthEntraUsers": "{{ restAuthEntraUsers }}"
}'
;

update_identity_certificate

Updates the cluster identity certificate.

EXEC azure.hdinsight.clusters.update_identity_certificate 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"applicationId": "{{ applicationId }}", 
"certificate": "{{ certificate }}", 
"certificatePassword": "{{ certificatePassword }}"
}'
;

execute_script_actions

Executes script actions on the specified HDInsight cluster.

EXEC azure.hdinsight.clusters.execute_script_actions 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"scriptActions": "{{ scriptActions }}", 
"persistOnSuccess": {{ persistOnSuccess }}
}'
;