PoolOperations.StopResizePool Method

Definition

Namespace:

Microsoft.Azure.Batch

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.2.0

Source:

PoolOperations.cs

Stops a pool resize operation.

public void StopResizePool (string poolId, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);

member this.StopResizePool : string * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit

Public Sub StopResizePool (poolId As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)

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.

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.

This is a blocking operation. For a non-blocking equivalent, see StopResizePoolAsync(String, IEnumerable<BatchClientBehavior>, CancellationToken).