CloudPool.EnableAutoScaleAsync Method (String, IEnumerable<BatchClientBehavior>)

Enables automatic scaling on this pool.

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

Syntax

public Task EnableAutoScaleAsync(
    string autoscaleFormula,
    IEnumerable<BatchClientBehavior> additionalBehaviors = null
)

public:
Task^ EnableAutoScaleAsync(
    String^ autoscaleFormula,
    IEnumerable<BatchClientBehavior^>^ additionalBehaviors = null
)

member EnableAutoScaleAsync : 
        autoscaleFormula:string *
        additionalBehaviors:IEnumerable<BatchClientBehavior> = null -> Task

Public Function EnableAutoScaleAsync (
    autoscaleFormula As String,
    additionalBehaviors As IEnumerable(Of BatchClientBehavior)
) As Task

autoscaleFormula
Type: System.String

The formula for the desired number of compute nodes in 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.

A Task that represents the asynchronous operation.

The formula is checked for validity before it is applied to the pool. If the formula is not valid, an exception occurs.

You cannot enable automatic scaling on a pool if a resize operation is in progress on the pool.

The enable autoscale operation runs asynchronously.