PoolOperations.StopResizePoolAsync(String, IEnumerable<BatchClientBehavior>, CancellationToken) Method

Definition

Stops a pool resize operation.

public System.Threading.Tasks.Task StopResizePoolAsync (string poolId, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);
member this.StopResizePoolAsync : string * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Parameters

poolId
String

The id of the pool.

additionalBehaviors
IEnumerable<BatchClientBehavior>

A collection of BatchClientBehavior instances that are applied to the Batch service request after the CustomBehaviors.

cancellationToken
CancellationToken

A CancellationToken for controlling the lifetime of the asynchronous operation.

Returns

A Task that represents the asynchronous operation.

Remarks

This operation stops an ongoing resize operation on the pool. The pool size will stabilize at the number of nodes it is at when the stop operation is done. During the stop operation, the pool AllocationState changes first to Stopping and then to Steady.

The stop resize operation runs asynchronously.

Applies to