PoolOperations interface

Package:

@azure/arm-batch

Interface representing a Pool operations.

Properties

beginDelete
beginDeleteAndWait
create	Creates a new pool inside the specified account.
delete
disableAutoScale	Disables automatic scaling for a pool.
get	Gets information about the specified pool.
listByBatchAccount	Lists all of the pools in the specified account.
stopResize	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	Updates the properties of an existing pool.

Property Details

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

create

Creates a new pool inside the specified account.

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

Property Value

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

delete

delete: (resourceGroupName: string, accountName: string, poolName: string, options?: PoolDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, accountName: string, poolName: string, options?: PoolDeleteOptionalParams) => PollerLike<OperationState<void>, void>

disableAutoScale

Disables automatic scaling for a pool.

disableAutoScale: (resourceGroupName: string, accountName: string, poolName: string, options?: PoolDisableAutoScaleOptionalParams) => Promise<Pool>

Property Value

(resourceGroupName: string, accountName: string, poolName: string, options?: PoolDisableAutoScaleOptionalParams) => Promise<Pool>

get

Gets information about the specified pool.

get: (resourceGroupName: string, accountName: string, poolName: string, options?: PoolGetOptionalParams) => Promise<Pool>

Property Value

(resourceGroupName: string, accountName: string, poolName: string, options?: PoolGetOptionalParams) => Promise<Pool>

listByBatchAccount

Lists all of the pools in the specified account.

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

Property Value

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

stopResize

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.

stopResize: (resourceGroupName: string, accountName: string, poolName: string, options?: PoolStopResizeOptionalParams) => Promise<Pool>

Property Value

(resourceGroupName: string, accountName: string, poolName: string, options?: PoolStopResizeOptionalParams) => Promise<Pool>

update

Updates the properties of an existing pool.

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

Property Value

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