PoolOperations.EvaluateAutoScaleAsync Method

Definition

Namespace:

Microsoft.Azure.Batch

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.2.0

Source:

PoolOperations.cs

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 System.Threading.Tasks.Task<Microsoft.Azure.Batch.AutoScaleRun> EvaluateAutoScaleAsync (string poolId, string autoscaleFormula, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);

member this.EvaluateAutoScaleAsync : string * string * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.AutoScaleRun>

Public Function EvaluateAutoScaleAsync (poolId As String, autoscaleFormula As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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.

cancellationToken

CancellationToken

A CancellationToken for controlling the lifetime of the asynchronous operation.

Returns

Task<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 EnableAutoScaleAsync(String, String, Nullable<TimeSpan>, IEnumerable<BatchClientBehavior>, CancellationToken).

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

The evaluate operation runs asynchronously.