Clusters interface

Interface representing a Clusters.

Methods

beginCreate(string, string, ClusterCreateParametersExtended, ClustersCreateOptionalParams)

Creates a new HDInsight cluster with the specified parameters.

beginCreateAndWait(string, string, ClusterCreateParametersExtended, ClustersCreateOptionalParams)

Creates a new HDInsight cluster with the specified parameters.

beginDelete(string, string, ClustersDeleteOptionalParams)

Deletes the specified HDInsight cluster.

beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)

Deletes the specified HDInsight cluster.

beginExecuteScriptActions(string, string, ExecuteScriptActionParameters, ClustersExecuteScriptActionsOptionalParams)

Executes script actions on the specified HDInsight cluster.

beginExecuteScriptActionsAndWait(string, string, ExecuteScriptActionParameters, ClustersExecuteScriptActionsOptionalParams)

Executes script actions on the specified HDInsight cluster.

beginResize(string, string, string, ClusterResizeParameters, ClustersResizeOptionalParams)

Resizes the specified HDInsight cluster to the specified size.

beginResizeAndWait(string, string, string, ClusterResizeParameters, ClustersResizeOptionalParams)

Resizes the specified HDInsight cluster to the specified size.

beginRotateDiskEncryptionKey(string, string, ClusterDiskEncryptionParameters, ClustersRotateDiskEncryptionKeyOptionalParams)

Rotate disk encryption key of the specified HDInsight cluster.

beginRotateDiskEncryptionKeyAndWait(string, string, ClusterDiskEncryptionParameters, ClustersRotateDiskEncryptionKeyOptionalParams)

Rotate disk encryption key of the specified HDInsight cluster.

beginUpdateAutoScaleConfiguration(string, string, string, AutoscaleConfigurationUpdateParameter, ClustersUpdateAutoScaleConfigurationOptionalParams)

Updates the Autoscale Configuration for HDInsight cluster.

beginUpdateAutoScaleConfigurationAndWait(string, string, string, AutoscaleConfigurationUpdateParameter, ClustersUpdateAutoScaleConfigurationOptionalParams)

Updates the Autoscale Configuration for HDInsight cluster.

beginUpdateGatewaySettings(string, string, UpdateGatewaySettingsParameters, ClustersUpdateGatewaySettingsOptionalParams)

Configures the gateway settings on the specified cluster.

beginUpdateGatewaySettingsAndWait(string, string, UpdateGatewaySettingsParameters, ClustersUpdateGatewaySettingsOptionalParams)

Configures the gateway settings on the specified cluster.

beginUpdateIdentityCertificate(string, string, UpdateClusterIdentityCertificateParameters, ClustersUpdateIdentityCertificateOptionalParams)

Updates the cluster identity certificate.

beginUpdateIdentityCertificateAndWait(string, string, UpdateClusterIdentityCertificateParameters, ClustersUpdateIdentityCertificateOptionalParams)

Updates the cluster identity certificate.

get(string, string, ClustersGetOptionalParams)

Gets the specified cluster.

getAzureAsyncOperationStatus(string, string, string, ClustersGetAzureAsyncOperationStatusOptionalParams)

The the async operation status.

getGatewaySettings(string, string, ClustersGetGatewaySettingsOptionalParams)

Gets the gateway settings for the specified cluster.

list(ClustersListOptionalParams)

Lists all the HDInsight clusters under the subscription.

listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)

Lists the HDInsight clusters in a resource group.

update(string, string, ClusterPatchParameters, ClustersUpdateOptionalParams)

Patch HDInsight cluster with the specified parameters.

Method Details

beginCreate(string, string, ClusterCreateParametersExtended, ClustersCreateOptionalParams)

Creates a new HDInsight cluster with the specified parameters.

function beginCreate(resourceGroupName: string, clusterName: string, parameters: ClusterCreateParametersExtended, options?: ClustersCreateOptionalParams): Promise<PollerLike<PollOperationState<Cluster>, Cluster>>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

parameters
ClusterCreateParametersExtended

The cluster create request.

options
ClustersCreateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<Cluster>, Cluster>>

beginCreateAndWait(string, string, ClusterCreateParametersExtended, ClustersCreateOptionalParams)

Creates a new HDInsight cluster with the specified parameters.

function beginCreateAndWait(resourceGroupName: string, clusterName: string, parameters: ClusterCreateParametersExtended, options?: ClustersCreateOptionalParams): Promise<Cluster>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

parameters
ClusterCreateParametersExtended

The cluster create request.

options
ClustersCreateOptionalParams

The options parameters.

Returns

Promise<Cluster>

beginDelete(string, string, ClustersDeleteOptionalParams)

Deletes the specified HDInsight cluster.

function beginDelete(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

options
ClustersDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)

Deletes the specified HDInsight cluster.

function beginDeleteAndWait(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

options
ClustersDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginExecuteScriptActions(string, string, ExecuteScriptActionParameters, ClustersExecuteScriptActionsOptionalParams)

Executes script actions on the specified HDInsight cluster.

function beginExecuteScriptActions(resourceGroupName: string, clusterName: string, parameters: ExecuteScriptActionParameters, options?: ClustersExecuteScriptActionsOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

parameters
ExecuteScriptActionParameters

The parameters for executing script actions.

options
ClustersExecuteScriptActionsOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginExecuteScriptActionsAndWait(string, string, ExecuteScriptActionParameters, ClustersExecuteScriptActionsOptionalParams)

Executes script actions on the specified HDInsight cluster.

function beginExecuteScriptActionsAndWait(resourceGroupName: string, clusterName: string, parameters: ExecuteScriptActionParameters, options?: ClustersExecuteScriptActionsOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

parameters
ExecuteScriptActionParameters

The parameters for executing script actions.

options
ClustersExecuteScriptActionsOptionalParams

The options parameters.

Returns

Promise<void>

beginResize(string, string, string, ClusterResizeParameters, ClustersResizeOptionalParams)

Resizes the specified HDInsight cluster to the specified size.

function beginResize(resourceGroupName: string, clusterName: string, roleName: string, parameters: ClusterResizeParameters, options?: ClustersResizeOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

roleName

string

The constant value for the roleName

parameters
ClusterResizeParameters

The parameters for the resize operation.

options
ClustersResizeOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginResizeAndWait(string, string, string, ClusterResizeParameters, ClustersResizeOptionalParams)

Resizes the specified HDInsight cluster to the specified size.

function beginResizeAndWait(resourceGroupName: string, clusterName: string, roleName: string, parameters: ClusterResizeParameters, options?: ClustersResizeOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

roleName

string

The constant value for the roleName

parameters
ClusterResizeParameters

The parameters for the resize operation.

options
ClustersResizeOptionalParams

The options parameters.

Returns

Promise<void>

beginRotateDiskEncryptionKey(string, string, ClusterDiskEncryptionParameters, ClustersRotateDiskEncryptionKeyOptionalParams)

Rotate disk encryption key of the specified HDInsight cluster.

function beginRotateDiskEncryptionKey(resourceGroupName: string, clusterName: string, parameters: ClusterDiskEncryptionParameters, options?: ClustersRotateDiskEncryptionKeyOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

parameters
ClusterDiskEncryptionParameters

The parameters for the disk encryption operation.

options
ClustersRotateDiskEncryptionKeyOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginRotateDiskEncryptionKeyAndWait(string, string, ClusterDiskEncryptionParameters, ClustersRotateDiskEncryptionKeyOptionalParams)

Rotate disk encryption key of the specified HDInsight cluster.

function beginRotateDiskEncryptionKeyAndWait(resourceGroupName: string, clusterName: string, parameters: ClusterDiskEncryptionParameters, options?: ClustersRotateDiskEncryptionKeyOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

parameters
ClusterDiskEncryptionParameters

The parameters for the disk encryption operation.

options
ClustersRotateDiskEncryptionKeyOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdateAutoScaleConfiguration(string, string, string, AutoscaleConfigurationUpdateParameter, ClustersUpdateAutoScaleConfigurationOptionalParams)

Updates the Autoscale Configuration for HDInsight cluster.

function beginUpdateAutoScaleConfiguration(resourceGroupName: string, clusterName: string, roleName: string, parameters: AutoscaleConfigurationUpdateParameter, options?: ClustersUpdateAutoScaleConfigurationOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

roleName

string

The constant value for the roleName

parameters
AutoscaleConfigurationUpdateParameter

The parameters for the update autoscale configuration operation.

options
ClustersUpdateAutoScaleConfigurationOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginUpdateAutoScaleConfigurationAndWait(string, string, string, AutoscaleConfigurationUpdateParameter, ClustersUpdateAutoScaleConfigurationOptionalParams)

Updates the Autoscale Configuration for HDInsight cluster.

function beginUpdateAutoScaleConfigurationAndWait(resourceGroupName: string, clusterName: string, roleName: string, parameters: AutoscaleConfigurationUpdateParameter, options?: ClustersUpdateAutoScaleConfigurationOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

roleName

string

The constant value for the roleName

parameters
AutoscaleConfigurationUpdateParameter

The parameters for the update autoscale configuration operation.

options
ClustersUpdateAutoScaleConfigurationOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdateGatewaySettings(string, string, UpdateGatewaySettingsParameters, ClustersUpdateGatewaySettingsOptionalParams)

Configures the gateway settings on the specified cluster.

function beginUpdateGatewaySettings(resourceGroupName: string, clusterName: string, parameters: UpdateGatewaySettingsParameters, options?: ClustersUpdateGatewaySettingsOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

parameters
UpdateGatewaySettingsParameters

The cluster configurations.

options
ClustersUpdateGatewaySettingsOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginUpdateGatewaySettingsAndWait(string, string, UpdateGatewaySettingsParameters, ClustersUpdateGatewaySettingsOptionalParams)

Configures the gateway settings on the specified cluster.

function beginUpdateGatewaySettingsAndWait(resourceGroupName: string, clusterName: string, parameters: UpdateGatewaySettingsParameters, options?: ClustersUpdateGatewaySettingsOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

parameters
UpdateGatewaySettingsParameters

The cluster configurations.

options
ClustersUpdateGatewaySettingsOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdateIdentityCertificate(string, string, UpdateClusterIdentityCertificateParameters, ClustersUpdateIdentityCertificateOptionalParams)

Updates the cluster identity certificate.

function beginUpdateIdentityCertificate(resourceGroupName: string, clusterName: string, parameters: UpdateClusterIdentityCertificateParameters, options?: ClustersUpdateIdentityCertificateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

parameters
UpdateClusterIdentityCertificateParameters

The cluster configurations.

options
ClustersUpdateIdentityCertificateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginUpdateIdentityCertificateAndWait(string, string, UpdateClusterIdentityCertificateParameters, ClustersUpdateIdentityCertificateOptionalParams)

Updates the cluster identity certificate.

function beginUpdateIdentityCertificateAndWait(resourceGroupName: string, clusterName: string, parameters: UpdateClusterIdentityCertificateParameters, options?: ClustersUpdateIdentityCertificateOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

parameters
UpdateClusterIdentityCertificateParameters

The cluster configurations.

options
ClustersUpdateIdentityCertificateOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, ClustersGetOptionalParams)

Gets the specified cluster.

function get(resourceGroupName: string, clusterName: string, options?: ClustersGetOptionalParams): Promise<Cluster>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

options
ClustersGetOptionalParams

The options parameters.

Returns

Promise<Cluster>

getAzureAsyncOperationStatus(string, string, string, ClustersGetAzureAsyncOperationStatusOptionalParams)

The the async operation status.

function getAzureAsyncOperationStatus(resourceGroupName: string, clusterName: string, operationId: string, options?: ClustersGetAzureAsyncOperationStatusOptionalParams): Promise<AsyncOperationResult>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

operationId

string

The long running operation id.

options
ClustersGetAzureAsyncOperationStatusOptionalParams

The options parameters.

Returns

getGatewaySettings(string, string, ClustersGetGatewaySettingsOptionalParams)

Gets the gateway settings for the specified cluster.

function getGatewaySettings(resourceGroupName: string, clusterName: string, options?: ClustersGetGatewaySettingsOptionalParams): Promise<GatewaySettings>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

options
ClustersGetGatewaySettingsOptionalParams

The options parameters.

Returns

Promise<GatewaySettings>

list(ClustersListOptionalParams)

Lists all the HDInsight clusters under the subscription.

function list(options?: ClustersListOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

Parameters

options
ClustersListOptionalParams

The options parameters.

Returns

listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)

Lists the HDInsight clusters in a resource group.

function listByResourceGroup(resourceGroupName: string, options?: ClustersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

options
ClustersListByResourceGroupOptionalParams

The options parameters.

Returns

update(string, string, ClusterPatchParameters, ClustersUpdateOptionalParams)

Patch HDInsight cluster with the specified parameters.

function update(resourceGroupName: string, clusterName: string, parameters: ClusterPatchParameters, options?: ClustersUpdateOptionalParams): Promise<Cluster>

Parameters

resourceGroupName

string

The name of the resource group.

clusterName

string

The name of the cluster.

parameters
ClusterPatchParameters

The cluster patch request.

options
ClustersUpdateOptionalParams

The options parameters.

Returns

Promise<Cluster>