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

OK response definition.

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

list_by_resource_group

OK response definition.

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

list

OK response definition.

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, clusterName		Gets the specified cluster.
list_by_resource_group	select	subscriptionId, resourceGroupName		Lists the HDInsight clusters in a resource group.
list	select	subscriptionId		Lists all the HDInsight clusters under the subscription.
create	insert	subscriptionId, resourceGroupName, clusterName		Creates a new HDInsight cluster with the specified parameters.
update	update	subscriptionId, resourceGroupName, clusterName		Patch HDInsight cluster with the specified parameters.
delete	delete	subscriptionId, resourceGroupName, clusterName		Deletes the specified HDInsight cluster.
execute_script_actions	exec	subscriptionId, resourceGroupName, clusterName, persistOnSuccess		Executes script actions on the specified HDInsight cluster.
resize	exec	subscriptionId, resourceGroupName, clusterName, roleName		Resizes the specified HDInsight cluster to the specified size.
rotate_disk_encryption_key	exec	subscriptionId, resourceGroupName, clusterName		Rotate disk encryption key of 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
clusterName	string	The name of the cluster.
resourceGroupName	string	The name of the resource group.
roleName	string	The constant value for the roleName
subscriptionId	string	The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Gets the specified cluster.

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

list_by_resource_group

Lists the HDInsight clusters in a resource group.

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

list

Lists all the HDInsight clusters under the subscription.

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

INSERT examples

create

Creates a new HDInsight cluster with the specified parameters.

INSERT INTO azure.hdinsight.clusters (
data__location,
data__tags,
data__zones,
data__properties,
data__identity,
subscriptionId,
resourceGroupName,
clusterName
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ zones }}',
'{{ properties }}',
'{{ identity }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ clusterName }}'
RETURNING
etag,
identity,
location,
properties,
systemData,
tags,
zones
;

Manifest

# Description fields are for documentation purposes
- name: clusters
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the clusters resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the clusters resource.
    - name: clusterName
      value: string
      description: Required parameter for the clusters resource.
    - name: location
      value: string
      description: |
        The location of the cluster.
    - name: tags
      value: object
      description: |
        The resource tags.
    - name: zones
      value: array
      description: |
        The availability zones.
    - name: properties
      value: object
      description: |
        The cluster create parameters.
    - name: identity
      value: object
      description: |
        The identity of the cluster, if configured.

UPDATE examples

update

Patch HDInsight cluster with the specified parameters.

UPDATE azure.hdinsight.clusters
SET 
data__tags = '{{ tags }}',
data__identity = '{{ identity }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
RETURNING
etag,
identity,
location,
properties,
systemData,
tags,
zones;

DELETE examples

delete

Deletes the specified HDInsight cluster.

DELETE FROM azure.hdinsight.clusters
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
;

Lifecycle Methods

execute_script_actions

Executes script actions on the specified HDInsight cluster.

EXEC azure.hdinsight.clusters.execute_script_actions 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required 
@@json=
'{
"scriptActions": "{{ scriptActions }}", 
"persistOnSuccess": {{ persistOnSuccess }}
}'
;

resize

Resizes the specified HDInsight cluster to the specified size.

EXEC azure.hdinsight.clusters.resize 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@roleName='{{ roleName }}' --required 
@@json=
'{
"targetInstanceCount": {{ targetInstanceCount }}
}'
;

rotate_disk_encryption_key

Rotate disk encryption key of the specified HDInsight cluster.

EXEC azure.hdinsight.clusters.rotate_disk_encryption_key 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required 
@@json=
'{
"vaultUri": "{{ vaultUri }}", 
"keyName": "{{ keyName }}", 
"keyVersion": "{{ keyVersion }}"
}'
;