PoolOperations.EvaluateAutoScale Method

Reference

Definition

Namespace:: Microsoft.Azure.Batch

Assembly:: Microsoft.Azure.Batch.dll

Package:: Microsoft.Azure.Batch v16.2.0

Source:: PoolOperations.cs

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.

Gets the result of evaluating an automatic scaling formula on the specified 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 poolId, string autoscaleFormula, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);

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

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

Parameters

poolId: String

The id of the pool.

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 the specified 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, 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, String, IEnumerable<BatchClientBehavior>, CancellationToken).

Applies to