Clusters interface

Package:

@azure/arm-hdinsightcontainers

Interface representing a Clusters.

Methods

beginCreate(string, string, string, Cluster, ClustersCreateOptionalParams)	Creates a cluster.
beginCreateAndWait(string, string, string, Cluster, ClustersCreateOptionalParams)	Creates a cluster.
beginDelete(string, string, string, ClustersDeleteOptionalParams)	Deletes a cluster.
beginDeleteAndWait(string, string, string, ClustersDeleteOptionalParams)	Deletes a cluster.
beginResize(string, string, string, ClusterResizeData, ClustersResizeOptionalParams)	Resize an existing Cluster.
beginResizeAndWait(string, string, string, ClusterResizeData, ClustersResizeOptionalParams)	Resize an existing Cluster.
beginUpdate(string, string, string, ClusterPatch, ClustersUpdateOptionalParams)	Updates an existing Cluster.
beginUpdateAndWait(string, string, string, ClusterPatch, ClustersUpdateOptionalParams)	Updates an existing Cluster.
beginUpgrade(string, string, string, ClusterUpgrade, ClustersUpgradeOptionalParams)	Upgrade a cluster.
beginUpgradeAndWait(string, string, string, ClusterUpgrade, ClustersUpgradeOptionalParams)	Upgrade a cluster.
beginUpgradeManualRollback(string, string, string, ClusterUpgradeRollback, ClustersUpgradeManualRollbackOptionalParams)	Manual rollback upgrade for a cluster.
beginUpgradeManualRollbackAndWait(string, string, string, ClusterUpgradeRollback, ClustersUpgradeManualRollbackOptionalParams)	Manual rollback upgrade for a cluster.
get(string, string, string, ClustersGetOptionalParams)	Gets a HDInsight cluster.
getInstanceView(string, string, string, ClustersGetInstanceViewOptionalParams)	Gets the status of a cluster instance.
listByClusterPoolName(string, string, ClustersListByClusterPoolNameOptionalParams)	Lists the HDInsight cluster pools under a resource group.
listInstanceViews(string, string, string, ClustersListInstanceViewsOptionalParams)	Lists the lists of instance views
listServiceConfigs(string, string, string, ClustersListServiceConfigsOptionalParams)	Lists the config dump of all services running in cluster.

Method Details

beginCreate(string, string, string, Cluster, ClustersCreateOptionalParams)

Creates a cluster.

function beginCreate(resourceGroupName: string, clusterPoolName: string, clusterName: string, hDInsightCluster: Cluster, options?: ClustersCreateOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterPoolName

string

The name of the cluster pool.

clusterName

string

The name of the HDInsight cluster.

hDInsightCluster

Cluster

The cluster to create.

options

ClustersCreateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>

beginCreateAndWait(string, string, string, Cluster, ClustersCreateOptionalParams)

Creates a cluster.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterPoolName

string

The name of the cluster pool.

clusterName

string

The name of the HDInsight cluster.

hDInsightCluster

Cluster

The cluster to create.

options

ClustersCreateOptionalParams

The options parameters.

Returns

Promise<Cluster>

beginDelete(string, string, string, ClustersDeleteOptionalParams)

Deletes a cluster.

function beginDelete(resourceGroupName: string, clusterPoolName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterPoolName

string

The name of the cluster pool.

clusterName

string

The name of the HDInsight cluster.

options

ClustersDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, ClustersDeleteOptionalParams)

Deletes a cluster.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterPoolName

string

The name of the cluster pool.

clusterName

string

The name of the HDInsight cluster.

options

ClustersDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginResize(string, string, string, ClusterResizeData, ClustersResizeOptionalParams)

Resize an existing Cluster.

function beginResize(resourceGroupName: string, clusterPoolName: string, clusterName: string, clusterResizeRequest: ClusterResizeData, options?: ClustersResizeOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterPoolName

string

The name of the cluster pool.

clusterName

string

The name of the HDInsight cluster.

clusterResizeRequest

ClusterResizeData

Resize a cluster.

options

ClustersResizeOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>

beginResizeAndWait(string, string, string, ClusterResizeData, ClustersResizeOptionalParams)

Resize an existing Cluster.

function beginResizeAndWait(resourceGroupName: string, clusterPoolName: string, clusterName: string, clusterResizeRequest: ClusterResizeData, options?: ClustersResizeOptionalParams): Promise<Cluster>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterPoolName

string

The name of the cluster pool.

clusterName

string

The name of the HDInsight cluster.

clusterResizeRequest

ClusterResizeData

Resize a cluster.

options

ClustersResizeOptionalParams

The options parameters.

Returns

Promise<Cluster>

beginUpdate(string, string, string, ClusterPatch, ClustersUpdateOptionalParams)

Updates an existing Cluster.

function beginUpdate(resourceGroupName: string, clusterPoolName: string, clusterName: string, clusterPatchRequest: ClusterPatch, options?: ClustersUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterPoolName

string

The name of the cluster pool.

clusterName

string

The name of the HDInsight cluster.

clusterPatchRequest

ClusterPatch

Patch a cluster.

options

ClustersUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>

beginUpdateAndWait(string, string, string, ClusterPatch, ClustersUpdateOptionalParams)

Updates an existing Cluster.

function beginUpdateAndWait(resourceGroupName: string, clusterPoolName: string, clusterName: string, clusterPatchRequest: ClusterPatch, options?: ClustersUpdateOptionalParams): Promise<Cluster>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterPoolName

string

The name of the cluster pool.

clusterName

string

The name of the HDInsight cluster.

clusterPatchRequest

ClusterPatch

Patch a cluster.

options

ClustersUpdateOptionalParams

The options parameters.

Returns

Promise<Cluster>

beginUpgrade(string, string, string, ClusterUpgrade, ClustersUpgradeOptionalParams)

Upgrade a cluster.

function beginUpgrade(resourceGroupName: string, clusterPoolName: string, clusterName: string, clusterUpgradeRequest: ClusterUpgrade, options?: ClustersUpgradeOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterPoolName

string

The name of the cluster pool.

clusterName

string

The name of the HDInsight cluster.

clusterUpgradeRequest

ClusterUpgrade

Upgrade a cluster.

options

ClustersUpgradeOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>

beginUpgradeAndWait(string, string, string, ClusterUpgrade, ClustersUpgradeOptionalParams)

Upgrade a cluster.

function beginUpgradeAndWait(resourceGroupName: string, clusterPoolName: string, clusterName: string, clusterUpgradeRequest: ClusterUpgrade, options?: ClustersUpgradeOptionalParams): Promise<Cluster>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterPoolName

string

The name of the cluster pool.

clusterName

string

The name of the HDInsight cluster.

clusterUpgradeRequest

ClusterUpgrade

Upgrade a cluster.

options

ClustersUpgradeOptionalParams

The options parameters.

Returns

Promise<Cluster>

beginUpgradeManualRollback(string, string, string, ClusterUpgradeRollback, ClustersUpgradeManualRollbackOptionalParams)

Manual rollback upgrade for a cluster.

function beginUpgradeManualRollback(resourceGroupName: string, clusterPoolName: string, clusterName: string, clusterRollbackUpgradeRequest: ClusterUpgradeRollback, options?: ClustersUpgradeManualRollbackOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterPoolName

string

The name of the cluster pool.

clusterName

string

The name of the HDInsight cluster.

clusterRollbackUpgradeRequest

ClusterUpgradeRollback

Manual rollback upgrade for a cluster.

options

ClustersUpgradeManualRollbackOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>

beginUpgradeManualRollbackAndWait(string, string, string, ClusterUpgradeRollback, ClustersUpgradeManualRollbackOptionalParams)

Manual rollback upgrade for a cluster.

function beginUpgradeManualRollbackAndWait(resourceGroupName: string, clusterPoolName: string, clusterName: string, clusterRollbackUpgradeRequest: ClusterUpgradeRollback, options?: ClustersUpgradeManualRollbackOptionalParams): Promise<Cluster>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterPoolName

string

The name of the cluster pool.

clusterName

string

The name of the HDInsight cluster.

clusterRollbackUpgradeRequest

ClusterUpgradeRollback

Manual rollback upgrade for a cluster.

options

ClustersUpgradeManualRollbackOptionalParams

The options parameters.

Returns

Promise<Cluster>

get(string, string, string, ClustersGetOptionalParams)

Gets a HDInsight cluster.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterPoolName

string

The name of the cluster pool.

clusterName

string

The name of the HDInsight cluster.

options

ClustersGetOptionalParams

The options parameters.

Returns

Promise<Cluster>

getInstanceView(string, string, string, ClustersGetInstanceViewOptionalParams)

Gets the status of a cluster instance.

function getInstanceView(resourceGroupName: string, clusterPoolName: string, clusterName: string, options?: ClustersGetInstanceViewOptionalParams): Promise<ClusterInstanceViewResult>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterPoolName

string

The name of the cluster pool.

clusterName

string

The name of the HDInsight cluster.

options

ClustersGetInstanceViewOptionalParams

The options parameters.

Returns

Promise<ClusterInstanceViewResult>

listByClusterPoolName(string, string, ClustersListByClusterPoolNameOptionalParams)

Lists the HDInsight cluster pools under a resource group.

function listByClusterPoolName(resourceGroupName: string, clusterPoolName: string, options?: ClustersListByClusterPoolNameOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterPoolName

string

The name of the cluster pool.

options

ClustersListByClusterPoolNameOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

listInstanceViews(string, string, string, ClustersListInstanceViewsOptionalParams)

Lists the lists of instance views

function listInstanceViews(resourceGroupName: string, clusterPoolName: string, clusterName: string, options?: ClustersListInstanceViewsOptionalParams): PagedAsyncIterableIterator<ClusterInstanceViewResult, ClusterInstanceViewResult[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterPoolName

string

The name of the cluster pool.

clusterName

string

The name of the HDInsight cluster.

options

ClustersListInstanceViewsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ClusterInstanceViewResult, ClusterInstanceViewResult[], PageSettings>

listServiceConfigs(string, string, string, ClustersListServiceConfigsOptionalParams)

Lists the config dump of all services running in cluster.

function listServiceConfigs(resourceGroupName: string, clusterPoolName: string, clusterName: string, options?: ClustersListServiceConfigsOptionalParams): PagedAsyncIterableIterator<ServiceConfigResult, ServiceConfigResult[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

clusterPoolName

string

The name of the cluster pool.

clusterName

string

The name of the HDInsight cluster.

options

ClustersListServiceConfigsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ServiceConfigResult, ServiceConfigResult[], PageSettings>