Package version:

Interface ClusterPools

Interface representing a ClusterPools.

interface ClusterPools {
    beginCreateOrUpdate(resourceGroupName: string, clusterPoolName: string, clusterPool: ClusterPool, options?: ClusterPoolsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ClusterPool>, ClusterPool>>;
    beginCreateOrUpdateAndWait(resourceGroupName: string, clusterPoolName: string, clusterPool: ClusterPool, options?: ClusterPoolsCreateOrUpdateOptionalParams): Promise<ClusterPool>;
    beginDelete(resourceGroupName: string, clusterPoolName: string, options?: ClusterPoolsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, clusterPoolName: string, options?: ClusterPoolsDeleteOptionalParams): Promise<void>;
    beginUpdateTags(resourceGroupName: string, clusterPoolName: string, clusterPoolTags: TagsObject, options?: ClusterPoolsUpdateTagsOptionalParams): Promise<SimplePollerLike<OperationState<ClusterPool>, ClusterPool>>;
    beginUpdateTagsAndWait(resourceGroupName: string, clusterPoolName: string, clusterPoolTags: TagsObject, options?: ClusterPoolsUpdateTagsOptionalParams): Promise<ClusterPool>;
    beginUpgrade(resourceGroupName: string, clusterPoolName: string, clusterPoolUpgradeRequest: ClusterPoolUpgrade, options?: ClusterPoolsUpgradeOptionalParams): Promise<SimplePollerLike<OperationState<ClusterPool>, ClusterPool>>;
    beginUpgradeAndWait(resourceGroupName: string, clusterPoolName: string, clusterPoolUpgradeRequest: ClusterPoolUpgrade, options?: ClusterPoolsUpgradeOptionalParams): Promise<ClusterPool>;
    get(resourceGroupName: string, clusterPoolName: string, options?: ClusterPoolsGetOptionalParams): Promise<ClusterPool>;
    listByResourceGroup(resourceGroupName: string, options?: ClusterPoolsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ClusterPool>;
    listBySubscription(options?: ClusterPoolsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ClusterPool>;
}

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginUpdateTags beginUpdateTagsAndWait beginUpgrade beginUpgradeAndWait get listByResourceGroup listBySubscription

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName, clusterPoolName, clusterPool, options?): Promise<SimplePollerLike<OperationState<ClusterPool>, ClusterPool>>
Creates or updates a cluster pool.
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.
- Optionaloptions: ClusterPoolsCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ClusterPool>, ClusterPool>>
- Defined in operationsInterfaces/clusterPools.ts:65

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName, clusterPoolName, clusterPool, options?): Promise<ClusterPool>
Creates or updates a cluster pool.
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.
- Optionaloptions: ClusterPoolsCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<ClusterPool>
- Defined in operationsInterfaces/clusterPools.ts:83

beginDelete

beginDelete(resourceGroupName, clusterPoolName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Deletes a Cluster Pool.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- clusterPoolName: string
  The name of the cluster pool.
- Optionaloptions: ClusterPoolsDeleteOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/clusterPools.ts:126

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName, clusterPoolName, options?): Promise<void>
Deletes a Cluster Pool.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- clusterPoolName: string
  The name of the cluster pool.
- Optionaloptions: ClusterPoolsDeleteOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/clusterPools.ts:137

beginUpdateTags

beginUpdateTags(resourceGroupName, clusterPoolName, clusterPoolTags, options?): Promise<SimplePollerLike<OperationState<ClusterPool>, ClusterPool>>
Updates an existing Cluster Pool Tags.
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.
- Optionaloptions: ClusterPoolsUpdateTagsOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ClusterPool>, ClusterPool>>
- Defined in operationsInterfaces/clusterPools.ts:96

beginUpdateTagsAndWait

beginUpdateTagsAndWait(resourceGroupName, clusterPoolName, clusterPoolTags, options?): Promise<ClusterPool>
Updates an existing Cluster Pool Tags.
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.
- Optionaloptions: ClusterPoolsUpdateTagsOptionalParams
  The options parameters.
Returns Promise<ClusterPool>
- Defined in operationsInterfaces/clusterPools.ts:114

beginUpgrade

beginUpgrade(resourceGroupName, clusterPoolName, clusterPoolUpgradeRequest, options?): Promise<SimplePollerLike<OperationState<ClusterPool>, ClusterPool>>
Upgrade a cluster pool.
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.
- Optionaloptions: ClusterPoolsUpgradeOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ClusterPool>, ClusterPool>>
- Defined in operationsInterfaces/clusterPools.ts:149

beginUpgradeAndWait

beginUpgradeAndWait(resourceGroupName, clusterPoolName, clusterPoolUpgradeRequest, options?): Promise<ClusterPool>
Upgrade a cluster pool.
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.
- Optionaloptions: ClusterPoolsUpgradeOptionalParams
  The options parameters.
Returns Promise<ClusterPool>
- Defined in operationsInterfaces/clusterPools.ts:167

get

get(resourceGroupName, clusterPoolName, options?): Promise<ClusterPool>
Gets a cluster pool.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- clusterPoolName: string
  The name of the cluster pool.
- Optionaloptions: ClusterPoolsGetOptionalParams
  The options parameters.
Returns Promise<ClusterPool>
- Defined in operationsInterfaces/clusterPools.ts:53

listByResourceGroup

listByResourceGroup(resourceGroupName, options?): PagedAsyncIterableIterator<ClusterPool>
Lists the HDInsight cluster pools under a resource group.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- Optionaloptions: ClusterPoolsListByResourceGroupOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<ClusterPool>
- Defined in operationsInterfaces/clusterPools.ts:43

listBySubscription

listBySubscription(options?): PagedAsyncIterableIterator<ClusterPool>
Gets the list of Cluster Pools within a Subscription.
Parameters
- Optionaloptions: ClusterPoolsListBySubscriptionOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<ClusterPool>
- Defined in operationsInterfaces/clusterPools.ts:35

Interface ClusterPools

Index

Methods

Methods

beginCreateOrUpdate

Parameters

Returns Promise<SimplePollerLike<OperationState<ClusterPool>, ClusterPool>>

beginCreateOrUpdateAndWait

Parameters

Returns Promise<ClusterPool>

beginDelete

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Parameters

Returns Promise<void>

beginUpdateTags

Parameters

Returns Promise<SimplePollerLike<OperationState<ClusterPool>, ClusterPool>>

beginUpdateTagsAndWait

Parameters

Returns Promise<ClusterPool>

beginUpgrade

Parameters

Returns Promise<SimplePollerLike<OperationState<ClusterPool>, ClusterPool>>

beginUpgradeAndWait

Parameters

Returns Promise<ClusterPool>

get

Parameters

Returns Promise<ClusterPool>

listByResourceGroup

Parameters

Returns PagedAsyncIterableIterator<ClusterPool>

listBySubscription

Parameters

Returns PagedAsyncIterableIterator<ClusterPool>

Settings