PoolOperations.EnableAutoScale Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Enables automatic scaling on the specified pool.
public void EnableAutoScale (string poolId, string autoscaleFormula = default, TimeSpan? autoscaleEvaluationInterval = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);member this.EnableAutoScale : string * string * Nullable<TimeSpan> * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unitPublic Sub EnableAutoScale (poolId As String, Optional autoscaleFormula As String = Nothing, Optional autoscaleEvaluationInterval As Nullable(Of TimeSpan) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)Parameters
- poolId
- String
The id of the pool.
- autoscaleFormula
- String
The formula for the desired number of compute nodes in the pool.
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
- IEnumerable<BatchClientBehavior>
A collection of BatchClientBehavior instances that are applied to the Batch service request after the CustomBehaviors.
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.
This is a blocking operation. For a non-blocking equivalent, see EnableAutoScaleAsync(String, String, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>, CancellationToken).
