Clusters interface
表示群集的接口。
方法
方法详细信息
beginCreate(string, string, ClusterCreateParametersExtended, ClustersCreateOptionalParams)
使用指定的参数创建新的 HDInsight 群集。
function beginCreate(resourceGroupName: string, clusterName: string, parameters: ClusterCreateParametersExtended, options?: ClustersCreateOptionalParams): Promise<PollerLike<PollOperationState<Cluster>, Cluster>>
参数
- resourceGroupName
-
string
资源组的名称。
- clusterName
-
string
群集的名称。
- parameters
- ClusterCreateParametersExtended
群集创建请求。
- options
- ClustersCreateOptionalParams
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<Cluster>, Cluster>>
beginCreateAndWait(string, string, ClusterCreateParametersExtended, ClustersCreateOptionalParams)
使用指定的参数创建新的 HDInsight 群集。
function beginCreateAndWait(resourceGroupName: string, clusterName: string, parameters: ClusterCreateParametersExtended, options?: ClustersCreateOptionalParams): Promise<Cluster>
参数
- resourceGroupName
-
string
资源组的名称。
- clusterName
-
string
群集的名称。
- parameters
- ClusterCreateParametersExtended
群集创建请求。
- options
- ClustersCreateOptionalParams
选项参数。
返回
Promise<Cluster>
beginDelete(string, string, ClustersDeleteOptionalParams)
删除指定的 HDInsight 群集。
function beginDelete(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
参数
- resourceGroupName
-
string
资源组的名称。
- clusterName
-
string
群集的名称。
- options
- ClustersDeleteOptionalParams
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)
删除指定的 HDInsight 群集。
function beginDeleteAndWait(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<void>
参数
- resourceGroupName
-
string
资源组的名称。
- clusterName
-
string
群集的名称。
- options
- ClustersDeleteOptionalParams
选项参数。
返回
Promise<void>
beginExecuteScriptActions(string, string, ExecuteScriptActionParameters, ClustersExecuteScriptActionsOptionalParams)
对指定的 HDInsight 群集执行脚本作。
function beginExecuteScriptActions(resourceGroupName: string, clusterName: string, parameters: ExecuteScriptActionParameters, options?: ClustersExecuteScriptActionsOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
参数
- resourceGroupName
-
string
资源组的名称。
- clusterName
-
string
群集的名称。
- parameters
- ExecuteScriptActionParameters
用于执行脚本作的参数。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginExecuteScriptActionsAndWait(string, string, ExecuteScriptActionParameters, ClustersExecuteScriptActionsOptionalParams)
对指定的 HDInsight 群集执行脚本作。
function beginExecuteScriptActionsAndWait(resourceGroupName: string, clusterName: string, parameters: ExecuteScriptActionParameters, options?: ClustersExecuteScriptActionsOptionalParams): Promise<void>
参数
- resourceGroupName
-
string
资源组的名称。
- clusterName
-
string
群集的名称。
- parameters
- ExecuteScriptActionParameters
用于执行脚本作的参数。
选项参数。
返回
Promise<void>
beginResize(string, string, string, ClusterResizeParameters, ClustersResizeOptionalParams)
将指定的 HDInsight 群集大小调整为指定大小。
function beginResize(resourceGroupName: string, clusterName: string, roleName: string, parameters: ClusterResizeParameters, options?: ClustersResizeOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
参数
- resourceGroupName
-
string
资源组的名称。
- clusterName
-
string
群集的名称。
- roleName
-
string
roleName 的常量值
- parameters
- ClusterResizeParameters
调整大小作的参数。
- options
- ClustersResizeOptionalParams
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginResizeAndWait(string, string, string, ClusterResizeParameters, ClustersResizeOptionalParams)
将指定的 HDInsight 群集大小调整为指定大小。
function beginResizeAndWait(resourceGroupName: string, clusterName: string, roleName: string, parameters: ClusterResizeParameters, options?: ClustersResizeOptionalParams): Promise<void>
参数
- resourceGroupName
-
string
资源组的名称。
- clusterName
-
string
群集的名称。
- roleName
-
string
roleName 的常量值
- parameters
- ClusterResizeParameters
调整大小作的参数。
- options
- ClustersResizeOptionalParams
选项参数。
返回
Promise<void>
beginRotateDiskEncryptionKey(string, string, ClusterDiskEncryptionParameters, ClustersRotateDiskEncryptionKeyOptionalParams)
轮换指定的 HDInsight 群集的磁盘加密密钥。
function beginRotateDiskEncryptionKey(resourceGroupName: string, clusterName: string, parameters: ClusterDiskEncryptionParameters, options?: ClustersRotateDiskEncryptionKeyOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
参数
- resourceGroupName
-
string
资源组的名称。
- clusterName
-
string
群集的名称。
- parameters
- ClusterDiskEncryptionParameters
磁盘加密作的参数。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginRotateDiskEncryptionKeyAndWait(string, string, ClusterDiskEncryptionParameters, ClustersRotateDiskEncryptionKeyOptionalParams)
轮换指定的 HDInsight 群集的磁盘加密密钥。
function beginRotateDiskEncryptionKeyAndWait(resourceGroupName: string, clusterName: string, parameters: ClusterDiskEncryptionParameters, options?: ClustersRotateDiskEncryptionKeyOptionalParams): Promise<void>
参数
- resourceGroupName
-
string
资源组的名称。
- clusterName
-
string
群集的名称。
- parameters
- ClusterDiskEncryptionParameters
磁盘加密作的参数。
选项参数。
返回
Promise<void>
beginUpdateAutoScaleConfiguration(string, string, string, AutoscaleConfigurationUpdateParameter, ClustersUpdateAutoScaleConfigurationOptionalParams)
更新 HDInsight 群集的自动缩放配置。
function beginUpdateAutoScaleConfiguration(resourceGroupName: string, clusterName: string, roleName: string, parameters: AutoscaleConfigurationUpdateParameter, options?: ClustersUpdateAutoScaleConfigurationOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
参数
- resourceGroupName
-
string
资源组的名称。
- clusterName
-
string
群集的名称。
- roleName
-
string
roleName 的常量值
- parameters
- AutoscaleConfigurationUpdateParameter
更新自动缩放配置作的参数。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginUpdateAutoScaleConfigurationAndWait(string, string, string, AutoscaleConfigurationUpdateParameter, ClustersUpdateAutoScaleConfigurationOptionalParams)
更新 HDInsight 群集的自动缩放配置。
function beginUpdateAutoScaleConfigurationAndWait(resourceGroupName: string, clusterName: string, roleName: string, parameters: AutoscaleConfigurationUpdateParameter, options?: ClustersUpdateAutoScaleConfigurationOptionalParams): Promise<void>
参数
- resourceGroupName
-
string
资源组的名称。
- clusterName
-
string
群集的名称。
- roleName
-
string
roleName 的常量值
- parameters
- AutoscaleConfigurationUpdateParameter
更新自动缩放配置作的参数。
选项参数。
返回
Promise<void>
beginUpdateGatewaySettings(string, string, UpdateGatewaySettingsParameters, ClustersUpdateGatewaySettingsOptionalParams)
在指定的群集上配置网关设置。
function beginUpdateGatewaySettings(resourceGroupName: string, clusterName: string, parameters: UpdateGatewaySettingsParameters, options?: ClustersUpdateGatewaySettingsOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
参数
- resourceGroupName
-
string
资源组的名称。
- clusterName
-
string
群集的名称。
- parameters
- UpdateGatewaySettingsParameters
群集配置。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginUpdateGatewaySettingsAndWait(string, string, UpdateGatewaySettingsParameters, ClustersUpdateGatewaySettingsOptionalParams)
在指定的群集上配置网关设置。
function beginUpdateGatewaySettingsAndWait(resourceGroupName: string, clusterName: string, parameters: UpdateGatewaySettingsParameters, options?: ClustersUpdateGatewaySettingsOptionalParams): Promise<void>
参数
- resourceGroupName
-
string
资源组的名称。
- clusterName
-
string
群集的名称。
- parameters
- UpdateGatewaySettingsParameters
群集配置。
选项参数。
返回
Promise<void>
beginUpdateIdentityCertificate(string, string, UpdateClusterIdentityCertificateParameters, ClustersUpdateIdentityCertificateOptionalParams)
更新群集标识证书。
function beginUpdateIdentityCertificate(resourceGroupName: string, clusterName: string, parameters: UpdateClusterIdentityCertificateParameters, options?: ClustersUpdateIdentityCertificateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
参数
- resourceGroupName
-
string
资源组的名称。
- clusterName
-
string
群集的名称。
- parameters
- UpdateClusterIdentityCertificateParameters
群集配置。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginUpdateIdentityCertificateAndWait(string, string, UpdateClusterIdentityCertificateParameters, ClustersUpdateIdentityCertificateOptionalParams)
更新群集标识证书。
function beginUpdateIdentityCertificateAndWait(resourceGroupName: string, clusterName: string, parameters: UpdateClusterIdentityCertificateParameters, options?: ClustersUpdateIdentityCertificateOptionalParams): Promise<void>
参数
- resourceGroupName
-
string
资源组的名称。
- clusterName
-
string
群集的名称。
- parameters
- UpdateClusterIdentityCertificateParameters
群集配置。
选项参数。
返回
Promise<void>
get(string, string, ClustersGetOptionalParams)
获取指定的群集。
function get(resourceGroupName: string, clusterName: string, options?: ClustersGetOptionalParams): Promise<Cluster>
参数
- resourceGroupName
-
string
资源组的名称。
- clusterName
-
string
群集的名称。
- options
- ClustersGetOptionalParams
选项参数。
返回
Promise<Cluster>
getAzureAsyncOperationStatus(string, string, string, ClustersGetAzureAsyncOperationStatusOptionalParams)
异步作状态。
function getAzureAsyncOperationStatus(resourceGroupName: string, clusterName: string, operationId: string, options?: ClustersGetAzureAsyncOperationStatusOptionalParams): Promise<AsyncOperationResult>
参数
- resourceGroupName
-
string
资源组的名称。
- clusterName
-
string
群集的名称。
- operationId
-
string
长时间运行的作 ID。
选项参数。
返回
Promise<AsyncOperationResult>
getGatewaySettings(string, string, ClustersGetGatewaySettingsOptionalParams)
获取指定群集的网关设置。
function getGatewaySettings(resourceGroupName: string, clusterName: string, options?: ClustersGetGatewaySettingsOptionalParams): Promise<GatewaySettings>
参数
- resourceGroupName
-
string
资源组的名称。
- clusterName
-
string
群集的名称。
选项参数。
返回
Promise<GatewaySettings>
list(ClustersListOptionalParams)
列出订阅下的所有 HDInsight 群集。
function list(options?: ClustersListOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>
参数
- options
- ClustersListOptionalParams
选项参数。
返回
listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)
列出资源组中的 HDInsight 群集。
function listByResourceGroup(resourceGroupName: string, options?: ClustersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>
参数
- resourceGroupName
-
string
资源组的名称。
选项参数。
返回
update(string, string, ClusterPatchParameters, ClustersUpdateOptionalParams)
使用指定的参数修补 HDInsight 群集。
function update(resourceGroupName: string, clusterName: string, parameters: ClusterPatchParameters, options?: ClustersUpdateOptionalParams): Promise<Cluster>
参数
- resourceGroupName
-
string
资源组的名称。
- clusterName
-
string
群集的名称。
- parameters
- ClusterPatchParameters
群集修补请求。
- options
- ClustersUpdateOptionalParams
选项参数。
返回
Promise<Cluster>