ClustersOperations Class

ClustersOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance
builtins.object
ClustersOperations

Constructor

ClustersOperations(client, config, serializer, deserializer)

Parameters

Name Description
client
Required

Client for service requests.

config
Required

Configuration of service client.

serializer
Required

An object model serializer.

deserializer
Required

An object model deserializer.

Variables

Name Description
models

Alias to model classes used in this operation group.

Methods

begin_create

Creates a new HDInsight cluster with the specified parameters.

begin_delete

Deletes the specified HDInsight cluster.

begin_execute_script_actions

Executes script actions on the specified HDInsight cluster.

begin_resize

Resizes the specified HDInsight cluster to the specified size.

begin_rotate_disk_encryption_key

Rotate disk encryption key of the specified HDInsight cluster.

begin_update_auto_scale_configuration

Updates the Autoscale Configuration for HDInsight cluster.

begin_update_gateway_settings

Configures the gateway settings on the specified cluster.

begin_update_identity_certificate

Updates the cluster identity certificate.

get

Gets the specified cluster.

get_azure_async_operation_status

The the async operation status.

get_gateway_settings

Gets the gateway settings for the specified cluster.

list

Lists all the HDInsight clusters under the subscription.

list_by_resource_group

Lists the HDInsight clusters in a resource group.

update

Patch HDInsight cluster with the specified parameters.

begin_create

Creates a new HDInsight cluster with the specified parameters.

begin_create(resource_group_name: str, cluster_name: str, parameters: '_models.ClusterCreateParametersExtended', **kwargs: Any) -> LROPoller['_models.Cluster']

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.

cluster_name
Required
str

The name of the cluster.

parameters
Required

The cluster create request.

Keyword-Only Parameters

Name Description
cls

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description

An instance of LROPoller that returns either Cluster or the result of cls(response)

Exceptions

Type Description

begin_delete

Deletes the specified HDInsight cluster.

begin_delete(resource_group_name: str, cluster_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.

cluster_name
Required
str

The name of the cluster.

Keyword-Only Parameters

Name Description
cls

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description

begin_execute_script_actions

Executes script actions on the specified HDInsight cluster.

begin_execute_script_actions(resource_group_name: str, cluster_name: str, parameters: '_models.ExecuteScriptActionParameters', **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.

cluster_name
Required
str

The name of the cluster.

parameters
Required

The parameters for executing script actions.

Keyword-Only Parameters

Name Description
cls

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description

begin_resize

Resizes the specified HDInsight cluster to the specified size.

begin_resize(resource_group_name: str, cluster_name: str, role_name: str | '_models.RoleName', parameters: '_models.ClusterResizeParameters', **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.

cluster_name
Required
str

The name of the cluster.

role_name
Required

The constant value for the roleName.

parameters
Required

The parameters for the resize operation.

Keyword-Only Parameters

Name Description
cls

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description

begin_rotate_disk_encryption_key

Rotate disk encryption key of the specified HDInsight cluster.

begin_rotate_disk_encryption_key(resource_group_name: str, cluster_name: str, parameters: '_models.ClusterDiskEncryptionParameters', **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.

cluster_name
Required
str

The name of the cluster.

parameters
Required

The parameters for the disk encryption operation.

Keyword-Only Parameters

Name Description
cls

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description

begin_update_auto_scale_configuration

Updates the Autoscale Configuration for HDInsight cluster.

begin_update_auto_scale_configuration(resource_group_name: str, cluster_name: str, role_name: str | '_models.RoleName', parameters: '_models.AutoscaleConfigurationUpdateParameter', **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.

cluster_name
Required
str

The name of the cluster.

role_name
Required

The constant value for the roleName.

parameters
Required

The parameters for the update autoscale configuration operation.

Keyword-Only Parameters

Name Description
cls

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description

begin_update_gateway_settings

Configures the gateway settings on the specified cluster.

begin_update_gateway_settings(resource_group_name: str, cluster_name: str, parameters: '_models.UpdateGatewaySettingsParameters', **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.

cluster_name
Required
str

The name of the cluster.

parameters
Required

The cluster configurations.

Keyword-Only Parameters

Name Description
cls

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description

begin_update_identity_certificate

Updates the cluster identity certificate.

begin_update_identity_certificate(resource_group_name: str, cluster_name: str, parameters: '_models.UpdateClusterIdentityCertificateParameters', **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.

cluster_name
Required
str

The name of the cluster.

parameters
Required

The cluster configurations.

Keyword-Only Parameters

Name Description
cls

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description

get

Gets the specified cluster.

get(resource_group_name: str, cluster_name: str, **kwargs: Any) -> _models.Cluster

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.

cluster_name
Required
str

The name of the cluster.

Keyword-Only Parameters

Name Description
cls

A custom type or function that will be passed the direct response

Returns

Type Description

Cluster, or the result of cls(response)

Exceptions

Type Description

get_azure_async_operation_status

The the async operation status.

get_azure_async_operation_status(resource_group_name: str, cluster_name: str, operation_id: str, **kwargs: Any) -> _models.AsyncOperationResult

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.

cluster_name
Required
str

The name of the cluster.

operation_id
Required
str

The long running operation id.

Keyword-Only Parameters

Name Description
cls

A custom type or function that will be passed the direct response

Returns

Type Description

AsyncOperationResult, or the result of cls(response)

Exceptions

Type Description

get_gateway_settings

Gets the gateway settings for the specified cluster.

get_gateway_settings(resource_group_name: str, cluster_name: str, **kwargs: Any) -> _models.GatewaySettings

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.

cluster_name
Required
str

The name of the cluster.

Keyword-Only Parameters

Name Description
cls

A custom type or function that will be passed the direct response

Returns

Type Description

GatewaySettings, or the result of cls(response)

Exceptions

Type Description

list

Lists all the HDInsight clusters under the subscription.

list(**kwargs: Any) -> Iterable['_models.ClusterListResult']

Keyword-Only Parameters

Name Description
cls

A custom type or function that will be passed the direct response

Returns

Type Description

An iterator like instance of either ClusterListResult or the result of cls(response)

Exceptions

Type Description

list_by_resource_group

Lists the HDInsight clusters in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable['_models.ClusterListResult']

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.

Keyword-Only Parameters

Name Description
cls

A custom type or function that will be passed the direct response

Returns

Type Description

An iterator like instance of either ClusterListResult or the result of cls(response)

Exceptions

Type Description

update

Patch HDInsight cluster with the specified parameters.

update(resource_group_name: str, cluster_name: str, parameters: '_models.ClusterPatchParameters', **kwargs: Any) -> _models.Cluster

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.

cluster_name
Required
str

The name of the cluster.

parameters
Required

The cluster patch request.

Keyword-Only Parameters

Name Description
cls

A custom type or function that will be passed the direct response

Returns

Type Description

Cluster, or the result of cls(response)

Exceptions

Type Description

Attributes

models

models = <module 'azure.mgmt.hdinsight.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\hdinsight\\models\\__init__.py'>