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

必要

長時間執行的作業識別碼。

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'>