PoolOperationsExtensions.StopResizeAsync Method

Definition

Namespace:

Microsoft.Azure.Management.Batch

Assembly:

Microsoft.Azure.Management.Batch.dll

Package:

Microsoft.Azure.Management.Batch v15.0.0

Stops an ongoing resize operation on the pool.

public static System.Threading.Tasks.Task<Microsoft.Azure.Management.Batch.Models.Pool> StopResizeAsync (this Microsoft.Azure.Management.Batch.IPoolOperations operations, string resourceGroupName, string accountName, string poolName, System.Threading.CancellationToken cancellationToken = default);

static member StopResizeAsync : Microsoft.Azure.Management.Batch.IPoolOperations * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Management.Batch.Models.Pool>

<Extension()>
Public Function StopResizeAsync (operations As IPoolOperations, resourceGroupName As String, accountName As String, poolName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Pool)

Parameters

operations

IPoolOperations

The operations group for this extension method.

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.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<Pool>

Remarks

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.