ClustersOperations class

Definition

ClustersOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

ClustersOperations(client, config, serializer, deserializer)
Inheritance
builtins.object
ClustersOperations

Parameters

client

Client for service requests.

config

Configuration of service client.

serializer

An object model serializer.

deserializer

An object model deserializer.

Variables

api_version
class
The HDInsight client API Version. Constant value: "2018-06-01-preview".
role_name
class
The constant value for the roleName. Constant value: "workernode".

Methods

create(resource_group_name, cluster_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

Creates a new HDInsight cluster with the specified parameters.

delete(resource_group_name, cluster_name, custom_headers=None, raw=False, polling=True, **operation_config)

Deletes the specified HDInsight cluster.

execute_script_actions(resource_group_name, cluster_name, persist_on_success, script_actions=None, custom_headers=None, raw=False, polling=True, **operation_config)

Executes script actions on the specified HDInsight cluster.

get(resource_group_name, cluster_name, custom_headers=None, raw=False, **operation_config)

Gets the specified cluster.

get_gateway_settings(resource_group_name, cluster_name, custom_headers=None, raw=False, **operation_config)

Gets the gateway settings for the specified cluster.

list(custom_headers=None, raw=False, **operation_config)

Lists all the HDInsight clusters under the subscription.

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)

Lists the HDInsight clusters in a resource group.

resize(resource_group_name, cluster_name, target_instance_count=None, custom_headers=None, raw=False, polling=True, **operation_config)

Resizes the specified HDInsight cluster to the specified size.

rotate_disk_encryption_key(resource_group_name, cluster_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

Rotate disk encryption key of the specified HDInsight cluster.

update(resource_group_name, cluster_name, tags=None, custom_headers=None, raw=False, **operation_config)

Patch HDInsight cluster with the specified parameters.

update_gateway_settings(resource_group_name, cluster_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

Configures the gateway settings on the specified cluster.

create(resource_group_name, cluster_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

Creates a new HDInsight cluster with the specified parameters.

create(resource_group_name, cluster_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

resource_group_name
str

The name of the resource group.

cluster_name
str

The name of the cluster.

parameters
ClusterCreateParametersExtended

The cluster create request.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

default value: False
polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

default value: True

Returns

An instance of LROPoller that returns Cluster or ClientRawResponse if raw==True

Return type

Exceptions

delete(resource_group_name, cluster_name, custom_headers=None, raw=False, polling=True, **operation_config)

Deletes the specified HDInsight cluster.

delete(resource_group_name, cluster_name, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

resource_group_name
str

The name of the resource group.

cluster_name
str

The name of the cluster.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

default value: False
polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

default value: True

Returns

An instance of LROPoller that returns None or ClientRawResponse if raw==True

Return type

Exceptions

execute_script_actions(resource_group_name, cluster_name, persist_on_success, script_actions=None, custom_headers=None, raw=False, polling=True, **operation_config)

Executes script actions on the specified HDInsight cluster.

execute_script_actions(resource_group_name, cluster_name, persist_on_success, script_actions=None, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

resource_group_name
str

The name of the resource group.

cluster_name
str

The name of the cluster.

persist_on_success
bool

Gets or sets if the scripts needs to be persisted.

script_actions
list[RuntimeScriptAction]

The list of run time script actions.

default value: None
custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

default value: False
polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

default value: True

Returns

An instance of LROPoller that returns None or ClientRawResponse if raw==True

Return type

Exceptions

get(resource_group_name, cluster_name, custom_headers=None, raw=False, **operation_config)

Gets the specified cluster.

get(resource_group_name, cluster_name, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name
str

The name of the resource group.

cluster_name
str

The name of the cluster.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

Cluster or ClientRawResponse if raw=true

Return type

Exceptions

get_gateway_settings(resource_group_name, cluster_name, custom_headers=None, raw=False, **operation_config)

Gets the gateway settings for the specified cluster.

get_gateway_settings(resource_group_name, cluster_name, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name
str

The name of the resource group.

cluster_name
str

The name of the cluster.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

GatewaySettings or ClientRawResponse if raw=true

Return type

Exceptions

list(custom_headers=None, raw=False, **operation_config)

Lists all the HDInsight clusters under the subscription.

list(custom_headers=None, raw=False, **operation_config)

Parameters

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

An iterator like instance of Cluster

Return type

Exceptions

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)

Lists the HDInsight clusters in a resource group.

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name
str

The name of the resource group.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

An iterator like instance of Cluster

Return type

Exceptions

resize(resource_group_name, cluster_name, target_instance_count=None, custom_headers=None, raw=False, polling=True, **operation_config)

Resizes the specified HDInsight cluster to the specified size.

resize(resource_group_name, cluster_name, target_instance_count=None, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

resource_group_name
str

The name of the resource group.

cluster_name
str

The name of the cluster.

target_instance_count
int

The target instance count for the operation.

default value: None
custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

default value: False
polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

default value: True

Returns

An instance of LROPoller that returns None or ClientRawResponse if raw==True

Return type

Exceptions

rotate_disk_encryption_key(resource_group_name, cluster_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

Rotate disk encryption key of the specified HDInsight cluster.

rotate_disk_encryption_key(resource_group_name, cluster_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

resource_group_name
str

The name of the resource group.

cluster_name
str

The name of the cluster.

parameters
ClusterDiskEncryptionParameters

The parameters for the disk encryption operation.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

default value: False
polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

default value: True

Returns

An instance of LROPoller that returns None or ClientRawResponse if raw==True

Return type

Exceptions

update(resource_group_name, cluster_name, tags=None, custom_headers=None, raw=False, **operation_config)

Patch HDInsight cluster with the specified parameters.

update(resource_group_name, cluster_name, tags=None, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name
str

The name of the resource group.

cluster_name
str

The name of the cluster.

tags
dict[str or str]

The resource tags.

default value: None
custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

Cluster or ClientRawResponse if raw=true

Return type

Exceptions

update_gateway_settings(resource_group_name, cluster_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

Configures the gateway settings on the specified cluster.

update_gateway_settings(resource_group_name, cluster_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

resource_group_name
str

The name of the resource group.

cluster_name
str

The name of the cluster.

parameters
UpdateGatewaySettingsParameters

The cluster configurations.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

default value: False
polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

default value: True

Returns

An instance of LROPoller that returns None or ClientRawResponse if raw==True

Return type

Exceptions

Attributes

models

models = <module 'azure.mgmt.hdinsight.models' from 'c:\\hostedtoolcache\\windows\\python\\3.6.8\\x64\\lib\\site-packages\\azure\\mgmt\\hdinsight\\models\\__init__.py'>