ClustersOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:clusters> attribute.

Constructor

ClustersOperations(*args, **kwargs)

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, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Cluster]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
cluster_name Required	str The name of the cluster. Required.
parameters Required	ClusterCreateParametersExtended or IO[bytes] The cluster create request. Is either a ClusterCreateParametersExtended type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[Cluster]	An instance of LROPoller that returns either Cluster or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

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. Required.
cluster_name Required	str The name of the cluster. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

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, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
cluster_name Required	str The name of the cluster. Required.
parameters Required	ExecuteScriptActionParameters or IO[bytes] The parameters for executing script actions. Is either a ExecuteScriptActionParameters type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

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, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
cluster_name Required	str The name of the cluster. Required.
role_name Required	str or RoleName The constant value for the roleName. "workernode" Required.
parameters Required	ClusterResizeParameters or IO[bytes] The parameters for the resize operation. Is either a ClusterResizeParameters type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

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, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
cluster_name Required	str The name of the cluster. Required.
parameters Required	ClusterDiskEncryptionParameters or IO[bytes] The parameters for the disk encryption operation. Is either a ClusterDiskEncryptionParameters type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

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, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
cluster_name Required	str The name of the cluster. Required.
role_name Required	str or RoleName The constant value for the roleName. "workernode" Required.
parameters Required	AutoscaleConfigurationUpdateParameter or IO[bytes] The parameters for the update autoscale configuration operation. Is either a AutoscaleConfigurationUpdateParameter type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

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, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
cluster_name Required	str The name of the cluster. Required.
parameters Required	UpdateGatewaySettingsParameters or IO[bytes] The cluster configurations. Is either a UpdateGatewaySettingsParameters type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update_identity_certificate

Updates the cluster identity certificate.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
cluster_name Required	str The name of the cluster. Required.
parameters Required	UpdateClusterIdentityCertificateParameters or IO[bytes] The cluster configurations. Is either a UpdateClusterIdentityCertificateParameters type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets the specified cluster.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
cluster_name Required	str The name of the cluster. Required.

Returns

Type	Description
Cluster	Cluster or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

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) -> AsyncOperationResult

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
cluster_name Required	str The name of the cluster. Required.
operation_id Required	str The long running operation id. Required.

Returns

Type	Description
AsyncOperationResult	AsyncOperationResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_gateway_settings

Gets the gateway settings for the specified cluster.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
cluster_name Required	str The name of the cluster. Required.

Returns

Type	Description
GatewaySettings	GatewaySettings or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Lists all the HDInsight clusters under the subscription.

list(**kwargs: Any) -> ItemPaged[Cluster]

Returns

Type	Description
ItemPaged[Cluster]	An iterator like instance of either Cluster or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Lists the HDInsight clusters in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> ItemPaged[Cluster]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.

Returns

Type	Description
ItemPaged[Cluster]	An iterator like instance of either Cluster or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update

Patch HDInsight cluster with the specified parameters.

update(resource_group_name: str, cluster_name: str, parameters: _models.ClusterPatchParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Cluster

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
cluster_name Required	str The name of the cluster. Required.
parameters Required	ClusterPatchParameters or IO[bytes] The cluster patch request. Is either a ClusterPatchParameters type or a IO[bytes] type. Required.

Returns

Type	Description
Cluster	Cluster or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.hdinsight.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv145\\Lib\\site-packages\\azure\\mgmt\\hdinsight\\models\\__init__.py'>

피드백

이 페이지가 도움이 되었나요?