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

Stops a pool resize operation.

Namespace:   Microsoft.Azure.Batch
Assembly:  Microsoft.Azure.Batch (in Microsoft.Azure.Batch.dll)

Syntax

public Task StopResizePoolAsync(
    string poolId,
    IEnumerable<BatchClientBehavior> additionalBehaviors = null
)

public:
Task^ StopResizePoolAsync(
    String^ poolId,
    IEnumerable<BatchClientBehavior^>^ additionalBehaviors = null
)

member StopResizePoolAsync : 
        poolId:string *
        additionalBehaviors:IEnumerable<BatchClientBehavior> = null -> Task

Public Function StopResizePoolAsync (
    poolId As String,
    additionalBehaviors As IEnumerable(Of BatchClientBehavior)
) As Task

Parameters

• poolId
  Type: System.String

  The id of the pool.

• additionalBehaviors
  Type: System.Collections.Generic.IEnumerable<BatchClientBehavior>

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

Return Value

Type: System.Threading.Tasks.Task

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.

See Also

PoolOperations Class
Microsoft.Azure.Batch Namespace

Return to top