CloudPool.EvaluateAutoScale Method

Definition

Namespace:

Microsoft.Azure.Batch

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.3.1

Source:

CloudPool.cs

Gets the result of evaluating an automatic scaling formula on this pool. This is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the pool.

public Microsoft.Azure.Batch.AutoScaleRun EvaluateAutoScale (string autoscaleFormula, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);

member this.EvaluateAutoScale : string * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> Microsoft.Azure.Batch.AutoScaleRun

Public Function EvaluateAutoScale (autoscaleFormula As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing) As AutoScaleRun

Parameters

autoscaleFormula

String

The formula to be evaluated on the pool.

additionalBehaviors

IEnumerable<BatchClientBehavior>

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

Returns

AutoScaleRun

The result of evaluating the autoscaleFormula on this pool.

Remarks

The formula is validated and its results calculated, but is not applied to the pool. To apply the formula to the pool, use EnableAutoScale(String, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>).

This method does not change any state of the pool, and does not affect the LastModified or ETag.

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