CloudPool.EnableAutoScaleAsync Method

Definition

Enables automatic scaling on this pool.

public System.Threading.Tasks.Task EnableAutoScaleAsync (string autoscaleFormula = default, TimeSpan? autoscaleEvaluationInterval = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);
member this.EnableAutoScaleAsync : string * Nullable<TimeSpan> * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function EnableAutoScaleAsync (Optional autoscaleFormula As String = Nothing, Optional autoscaleEvaluationInterval As Nullable(Of TimeSpan) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

autoscaleFormula
System.String

The formula for the desired number of compute nodes in the pool.

autoscaleEvaluationInterval
System.Nullable<System.TimeSpan>

The time interval at which to automatically adjust the pool size according to the AutoScale formula. The default value is 15 minutes. The minimum allowed value is 5 minutes.

additionalBehaviors
System.Collections.Generic.IEnumerable<BatchClientBehavior>

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

cancellationToken
System.Threading.CancellationToken

A System.Threading.CancellationToken for controlling the lifetime of the asynchronous operation.

Returns

System.Threading.Tasks.Task

A System.Threading.Tasks.Task that represents the asynchronous operation.

Remarks

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.

Applies to