PoolOperations interface

Package:

@azure/arm-batch

Interface representing a PoolOperations.

Methods

beginDelete(string, string, string, PoolDeleteOptionalParams)	Deletes the specified pool.
beginDeleteAndWait(string, string, string, PoolDeleteOptionalParams)	Deletes the specified pool.
create(string, string, string, Pool, PoolCreateOptionalParams)	Creates a new pool inside the specified account.
disableAutoScale(string, string, string, PoolDisableAutoScaleOptionalParams)	Disables automatic scaling for a pool.
get(string, string, string, PoolGetOptionalParams)	Gets information about the specified pool.
listByBatchAccount(string, string, PoolListByBatchAccountOptionalParams)	Lists all of the pools in the specified account.
stopResize(string, string, string, PoolStopResizeOptionalParams)	This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.
update(string, string, string, Pool, PoolUpdateOptionalParams)	Updates the properties of an existing pool.

Method Details

beginDelete(string, string, string, PoolDeleteOptionalParams)

Deletes the specified pool.

function beginDelete(resourceGroupName: string, accountName: string, poolName: string, options?: PoolDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group that contains the Batch account.

accountName

string

The name of the Batch account.

poolName

string

The pool name. This must be unique within the account.

options

PoolDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, PoolDeleteOptionalParams)

Deletes the specified pool.

function beginDeleteAndWait(resourceGroupName: string, accountName: string, poolName: string, options?: PoolDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group that contains the Batch account.

accountName

string

The name of the Batch account.

poolName

string

The pool name. This must be unique within the account.

options

PoolDeleteOptionalParams

The options parameters.

Returns

Promise<void>

create(string, string, string, Pool, PoolCreateOptionalParams)

Creates a new pool inside the specified account.

function create(resourceGroupName: string, accountName: string, poolName: string, parameters: Pool, options?: PoolCreateOptionalParams): Promise<PoolCreateResponse>

Parameters

resourceGroupName

string

The name of the resource group that contains the Batch account.

accountName

string

The name of the Batch account.

poolName

string

The pool name. This must be unique within the account.

parameters

Pool

Additional parameters for pool creation.

options

PoolCreateOptionalParams

The options parameters.

Returns

Promise<PoolCreateResponse>

disableAutoScale(string, string, string, PoolDisableAutoScaleOptionalParams)

Disables automatic scaling for a pool.

function disableAutoScale(resourceGroupName: string, accountName: string, poolName: string, options?: PoolDisableAutoScaleOptionalParams): Promise<PoolDisableAutoScaleResponse>

Parameters

resourceGroupName

string

The name of the resource group that contains the Batch account.

accountName

string

The name of the Batch account.

poolName

string

The pool name. This must be unique within the account.

options

PoolDisableAutoScaleOptionalParams

The options parameters.

Returns

Promise<PoolDisableAutoScaleResponse>

get(string, string, string, PoolGetOptionalParams)

Gets information about the specified pool.

function get(resourceGroupName: string, accountName: string, poolName: string, options?: PoolGetOptionalParams): Promise<PoolGetResponse>

Parameters

resourceGroupName

string

The name of the resource group that contains the Batch account.

accountName

string

The name of the Batch account.

poolName

string

The pool name. This must be unique within the account.

options

PoolGetOptionalParams

The options parameters.

Returns

Promise<PoolGetResponse>

listByBatchAccount(string, string, PoolListByBatchAccountOptionalParams)

Lists all of the pools in the specified account.

function listByBatchAccount(resourceGroupName: string, accountName: string, options?: PoolListByBatchAccountOptionalParams): PagedAsyncIterableIterator<Pool, Pool[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group that contains the Batch account.

accountName

string

The name of the Batch account.

options

PoolListByBatchAccountOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Pool, Pool[], PageSettings>

stopResize(string, string, string, PoolStopResizeOptionalParams)

This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.

function stopResize(resourceGroupName: string, accountName: string, poolName: string, options?: PoolStopResizeOptionalParams): Promise<PoolStopResizeResponse>

Parameters

resourceGroupName

string

The name of the resource group that contains the Batch account.

accountName

string

The name of the Batch account.

poolName

string

The pool name. This must be unique within the account.

options

PoolStopResizeOptionalParams

The options parameters.

Returns

Promise<PoolStopResizeResponse>

update(string, string, string, Pool, PoolUpdateOptionalParams)

Updates the properties of an existing pool.

function update(resourceGroupName: string, accountName: string, poolName: string, parameters: Pool, options?: PoolUpdateOptionalParams): Promise<PoolUpdateResponse>

Parameters

resourceGroupName

string

The name of the resource group that contains the Batch account.

accountName

string

The name of the Batch account.

poolName

string

The pool name. This must be unique within the account.

parameters

Pool

Pool properties that should be updated. Properties that are supplied will be updated, any property not supplied will be unchanged.

options

PoolUpdateOptionalParams

The options parameters.

Returns

Promise<PoolUpdateResponse>