你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

ClustersOperations 类

ClustersOperations 操作。

不应直接实例化此类。 相反，应创建一个客户端实例来实例化它，并将其作为属性附加。

继承

builtins.object

ClustersOperations

构造函数

ClustersOperations(client, config, serializer, deserializer)

参数

client

必需

服务请求的客户端。

config

必需

服务客户端的配置。

serializer

必需

对象模型序列化程序。

deserializer

必需

对象模型反序列化程序。

变量

models

此操作组中使用的模型类的别名。

方法

begin_create	使用指定的参数创建新的 HDInsight 群集。
begin_delete	删除指定的 HDInsight 群集。
begin_execute_script_actions	在指定的 HDInsight 群集上执行脚本操作。
begin_resize	将指定的 HDInsight 群集大小调整为指定大小。
begin_rotate_disk_encryption_key	轮换指定 HDInsight 群集的磁盘加密密钥。
begin_update_auto_scale_configuration	汇报 HDInsight 群集的自动缩放配置。
begin_update_gateway_settings	在指定群集上配置网关设置。
begin_update_identity_certificate	汇报群集标识证书。
get	获取指定的群集。
get_azure_async_operation_status	异步操作状态。
get_gateway_settings	获取指定群集的网关设置。
list	列出订阅下的所有 HDInsight 群集。
list_by_resource_group	列出资源组中的 HDInsight 群集。
update	使用指定的参数修补 HDInsight 群集。

begin_create

使用指定的参数创建新的 HDInsight 群集。

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

参数

resource_group_name

str

必需

资源组的名称。

cluster_name

str

必需

群集的名称。

parameters

ClusterCreateParametersExtended

必需

群集创建请求。

cls

callable

将传递直接响应的自定义类型或函数

continuation_token

str

用于从保存状态重启轮询的延续标记。

polling

bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。 如果此操作不轮询，则传入 False，或者为个人轮询策略传入你自己的初始化轮询对象。

polling_interval

int

如果没有Retry-After标头，则 LRO 操作的两次轮询之间的默认等待时间。

返回

LROPoller 的实例，返回群集或 cls (响应结果)

返回类型

LROPoller[Cluster]

例外

HttpResponseError

begin_delete

删除指定的 HDInsight 群集。

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

参数

resource_group_name

str

必需

资源组的名称。

cluster_name

str

必需

群集的名称。

cls

callable

将传递直接响应的自定义类型或函数

continuation_token

str

用于从保存状态重启轮询的延续标记。

polling

bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。 如果此操作不轮询，则传入 False，或者为个人轮询策略传入你自己的初始化轮询对象。

polling_interval

int

如果没有Retry-After标头，则 LRO 操作的两次轮询之间的默认等待时间。

返回

LROPoller 的实例，返回 None 或 cls 的结果 (响应)

返回类型

LROPoller[None]

例外

HttpResponseError

begin_execute_script_actions

在指定的 HDInsight 群集上执行脚本操作。

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

参数

resource_group_name

str

必需

资源组的名称。

cluster_name

str

必需

群集的名称。

parameters

ExecuteScriptActionParameters

必需

用于执行脚本操作的参数。

cls

callable

将传递直接响应的自定义类型或函数

continuation_token

str

用于从保存状态重启轮询的延续标记。

polling

bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。 如果此操作不轮询，则传入 False，或者为个人轮询策略传入你自己的初始化轮询对象。

polling_interval

int

如果没有Retry-After标头，则 LRO 操作的两次轮询之间的默认等待时间。

返回

LROPoller 的实例，返回 None 或 cls 的结果 (响应)

返回类型

LROPoller[None]

例外

HttpResponseError

begin_resize

将指定的 HDInsight 群集大小调整为指定大小。

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

参数

resource_group_name

str

必需

资源组的名称。

cluster_name

str

必需

群集的名称。

role_name

str 或 RoleName

必需

roleName 的常量值。

parameters

ClusterResizeParameters

必需

重设大小操作的参数。

cls

callable

将传递直接响应的自定义类型或函数

continuation_token

str

用于从保存状态重启轮询的延续标记。

polling

bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。 如果此操作不轮询，则传入 False，或者为个人轮询策略传入你自己的初始化轮询对象。

polling_interval

int

如果没有Retry-After标头，则 LRO 操作的两次轮询之间的默认等待时间。

返回

LROPoller 的实例，返回 None 或 cls 的结果 (响应)

返回类型

LROPoller[None]

例外

HttpResponseError

begin_rotate_disk_encryption_key

轮换指定 HDInsight 群集的磁盘加密密钥。

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

参数

resource_group_name

str

必需

资源组的名称。

cluster_name

str

必需

群集的名称。

parameters

ClusterDiskEncryptionParameters

必需

磁盘加密操作的参数。

cls

callable

将传递直接响应的自定义类型或函数

continuation_token

str

用于从保存状态重启轮询的延续标记。

polling

bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。 如果此操作不轮询，则传入 False，或者为个人轮询策略传入你自己的初始化轮询对象。

polling_interval

int

如果没有Retry-After标头，则 LRO 操作的两次轮询之间的默认等待时间。

返回

LROPoller 的实例，返回 None 或 cls 的结果 (响应)

返回类型

LROPoller[None]

例外

HttpResponseError

begin_update_auto_scale_configuration

汇报 HDInsight 群集的自动缩放配置。

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

参数

resource_group_name

str

必需

资源组的名称。

cluster_name

str

必需

群集的名称。

role_name

str 或 RoleName

必需

roleName 的常量值。

parameters

AutoscaleConfigurationUpdateParameter

必需

更新自动缩放配置操作的参数。

cls

callable

将传递直接响应的自定义类型或函数

continuation_token

str

用于从保存状态重启轮询的延续标记。

polling

bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。 如果此操作不轮询，则传入 False，或者为个人轮询策略传入你自己的初始化轮询对象。

polling_interval

int

如果没有Retry-After标头，则 LRO 操作的两次轮询之间的默认等待时间。

返回

LROPoller 的实例，返回 None 或 cls 的结果 (响应)

返回类型

LROPoller[None]

例外

HttpResponseError

begin_update_gateway_settings

在指定群集上配置网关设置。

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

参数

resource_group_name

str

必需

资源组的名称。

cluster_name

str

必需

群集的名称。

parameters

UpdateGatewaySettingsParameters

必需

群集配置。

cls

callable

将传递直接响应的自定义类型或函数

continuation_token

str

用于从保存状态重启轮询的延续标记。

polling

bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。 如果此操作不轮询，则传入 False，或者为个人轮询策略传入你自己的初始化轮询对象。

polling_interval

int

如果没有Retry-After标头，则 LRO 操作的两次轮询之间的默认等待时间。

返回

LROPoller 的实例，返回 None 或 cls 的结果 (响应)

返回类型

LROPoller[None]

例外

HttpResponseError

begin_update_identity_certificate

汇报群集标识证书。

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

参数

resource_group_name

str

必需

资源组的名称。

cluster_name

str

必需

群集的名称。

parameters

UpdateClusterIdentityCertificateParameters

必需

群集配置。

cls

callable

将传递直接响应的自定义类型或函数

continuation_token

str

用于从保存状态重启轮询的延续标记。

polling

bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。 如果此操作不轮询，则传入 False，或者为个人轮询策略传入你自己的初始化轮询对象。

polling_interval

int

如果没有Retry-After标头，则 LRO 操作的两次轮询之间的默认等待时间。

返回

LROPoller 的实例，返回 None 或 cls 的结果 (响应)

返回类型

LROPoller[None]

例外

HttpResponseError

get

获取指定的群集。

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

参数

resource_group_name

str

必需

资源组的名称。

cluster_name

str

必需

群集的名称。

cls

callable

将传递直接响应的自定义类型或函数

返回

群集或 cls 的结果 (响应)

返回类型

Cluster

例外

HttpResponseError

get_azure_async_operation_status

异步操作状态。

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

参数

resource_group_name

str

必需

资源组的名称。

cluster_name

str

必需

群集的名称。

operation_id

str

必需

长时间运行的操作 ID。

cls

callable

将传递直接响应的自定义类型或函数

返回

AsyncOperationResult，或 cls 的结果 (响应)

返回类型

AsyncOperationResult

例外

HttpResponseError

get_gateway_settings

获取指定群集的网关设置。

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

参数

resource_group_name

str

必需

资源组的名称。

cluster_name

str

必需

群集的名称。

cls

callable

将传递直接响应的自定义类型或函数

返回

GatewaySettings 或 cls 的结果 (响应)

返回类型

GatewaySettings

例外

HttpResponseError

list

列出订阅下的所有 HDInsight 群集。

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

参数

cls

callable

将传递直接响应的自定义类型或函数

返回

一个迭代器，例如 ClusterListResult 的实例或 cls (响应的结果)

返回类型

ItemPaged[ClusterListResult]

例外

HttpResponseError

list_by_resource_group

列出资源组中的 HDInsight 群集。

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

参数

resource_group_name

str

必需

资源组的名称。

cls

callable

将传递直接响应的自定义类型或函数

返回

一个迭代器，例如 ClusterListResult 的实例或 cls (响应的结果)

返回类型

ItemPaged[ClusterListResult]

例外

HttpResponseError

update

使用指定的参数修补 HDInsight 群集。

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

参数

resource_group_name

str

必需

资源组的名称。

cluster_name

str

必需

群集的名称。

parameters

ClusterPatchParameters

必需

群集修补程序请求。

cls

callable

将传递直接响应的自定义类型或函数

返回

群集或 cls 的结果 (响应)

返回类型

Cluster

例外

HttpResponseError

属性

models

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