ClusterPools interface

Package:

@azure/arm-hdinsightcontainers

Interface representing a ClusterPools.

Methods

beginCreateOrUpdate(string, string, ClusterPool, ClusterPoolsCreateOrUpdateOptionalParams)	Creates or updates a cluster pool.
beginCreateOrUpdateAndWait(string, string, ClusterPool, ClusterPoolsCreateOrUpdateOptionalParams)	Creates or updates a cluster pool.
beginDelete(string, string, ClusterPoolsDeleteOptionalParams)	Deletes a Cluster Pool.
beginDeleteAndWait(string, string, ClusterPoolsDeleteOptionalParams)	Deletes a Cluster Pool.
beginUpdateTags(string, string, TagsObject, ClusterPoolsUpdateTagsOptionalParams)	Updates an existing Cluster Pool Tags.
beginUpdateTagsAndWait(string, string, TagsObject, ClusterPoolsUpdateTagsOptionalParams)	Updates an existing Cluster Pool Tags.
beginUpgrade(string, string, ClusterPoolUpgrade, ClusterPoolsUpgradeOptionalParams)	Upgrade a cluster pool.
beginUpgradeAndWait(string, string, ClusterPoolUpgrade, ClusterPoolsUpgradeOptionalParams)	Upgrade a cluster pool.
get(string, string, ClusterPoolsGetOptionalParams)	Gets a cluster pool.
listByResourceGroup(string, ClusterPoolsListByResourceGroupOptionalParams)	Lists the HDInsight cluster pools under a resource group.
listBySubscription(ClusterPoolsListBySubscriptionOptionalParams)	Gets the list of Cluster Pools within a Subscription.

Method Details

beginCreateOrUpdate(string, string, ClusterPool, ClusterPoolsCreateOrUpdateOptionalParams)

Creates or updates a cluster pool.

function beginCreateOrUpdate(resourceGroupName: string, clusterPoolName: string, clusterPool: ClusterPool, options?: ClusterPoolsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ClusterPool>, ClusterPool>>

Parameters

resourceGroupName

string

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

clusterPoolName

string

The name of the cluster pool.

clusterPool

ClusterPool

The Cluster Pool to create.

options

ClusterPoolsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, ClusterPool, ClusterPoolsCreateOrUpdateOptionalParams)

Creates or updates a cluster pool.

function beginCreateOrUpdateAndWait(resourceGroupName: string, clusterPoolName: string, clusterPool: ClusterPool, options?: ClusterPoolsCreateOrUpdateOptionalParams): Promise<ClusterPool>

Parameters

resourceGroupName

string

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

clusterPoolName

string

The name of the cluster pool.

clusterPool

ClusterPool

The Cluster Pool to create.

options

ClusterPoolsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ClusterPool>

beginDelete(string, string, ClusterPoolsDeleteOptionalParams)

Deletes a Cluster Pool.

function beginDelete(resourceGroupName: string, clusterPoolName: string, options?: ClusterPoolsDeleteOptionalParams): 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.

options

ClusterPoolsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, ClusterPoolsDeleteOptionalParams)

Deletes a Cluster Pool.

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

Parameters

resourceGroupName

string

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

clusterPoolName

string

The name of the cluster pool.

options

ClusterPoolsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdateTags(string, string, TagsObject, ClusterPoolsUpdateTagsOptionalParams)

Updates an existing Cluster Pool Tags.

function beginUpdateTags(resourceGroupName: string, clusterPoolName: string, clusterPoolTags: TagsObject, options?: ClusterPoolsUpdateTagsOptionalParams): Promise<SimplePollerLike<OperationState<ClusterPool>, ClusterPool>>

Parameters

resourceGroupName

string

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

clusterPoolName

string

The name of the cluster pool.

clusterPoolTags

TagsObject

Parameters supplied to update tags.

options

ClusterPoolsUpdateTagsOptionalParams

The options parameters.

Returns

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

beginUpdateTagsAndWait(string, string, TagsObject, ClusterPoolsUpdateTagsOptionalParams)

Updates an existing Cluster Pool Tags.

function beginUpdateTagsAndWait(resourceGroupName: string, clusterPoolName: string, clusterPoolTags: TagsObject, options?: ClusterPoolsUpdateTagsOptionalParams): Promise<ClusterPool>

Parameters

resourceGroupName

string

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

clusterPoolName

string

The name of the cluster pool.

clusterPoolTags

TagsObject

Parameters supplied to update tags.

options

ClusterPoolsUpdateTagsOptionalParams

The options parameters.

Returns

Promise<ClusterPool>

beginUpgrade(string, string, ClusterPoolUpgrade, ClusterPoolsUpgradeOptionalParams)

Upgrade a cluster pool.

function beginUpgrade(resourceGroupName: string, clusterPoolName: string, clusterPoolUpgradeRequest: ClusterPoolUpgrade, options?: ClusterPoolsUpgradeOptionalParams): Promise<SimplePollerLike<OperationState<ClusterPool>, ClusterPool>>

Parameters

resourceGroupName

string

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

clusterPoolName

string

The name of the cluster pool.

clusterPoolUpgradeRequest

ClusterPoolUpgrade

Upgrade a cluster pool.

options

ClusterPoolsUpgradeOptionalParams

The options parameters.

Returns

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

beginUpgradeAndWait(string, string, ClusterPoolUpgrade, ClusterPoolsUpgradeOptionalParams)

Upgrade a cluster pool.

function beginUpgradeAndWait(resourceGroupName: string, clusterPoolName: string, clusterPoolUpgradeRequest: ClusterPoolUpgrade, options?: ClusterPoolsUpgradeOptionalParams): Promise<ClusterPool>

Parameters

resourceGroupName

string

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

clusterPoolName

string

The name of the cluster pool.

clusterPoolUpgradeRequest

ClusterPoolUpgrade

Upgrade a cluster pool.

options

ClusterPoolsUpgradeOptionalParams

The options parameters.

Returns

Promise<ClusterPool>

get(string, string, ClusterPoolsGetOptionalParams)

Gets a cluster pool.

function get(resourceGroupName: string, clusterPoolName: string, options?: ClusterPoolsGetOptionalParams): Promise<ClusterPool>

Parameters

resourceGroupName

string

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

clusterPoolName

string

The name of the cluster pool.

options

ClusterPoolsGetOptionalParams

The options parameters.

Returns

Promise<ClusterPool>

listByResourceGroup(string, ClusterPoolsListByResourceGroupOptionalParams)

Lists the HDInsight cluster pools under a resource group.

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

Parameters

resourceGroupName

string

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

options

ClusterPoolsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ClusterPool, ClusterPool[], PageSettings>

listBySubscription(ClusterPoolsListBySubscriptionOptionalParams)

Gets the list of Cluster Pools within a Subscription.

function listBySubscription(options?: ClusterPoolsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ClusterPool, ClusterPool[], PageSettings>

Parameters

options

ClusterPoolsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ClusterPool, ClusterPool[], PageSettings>