PoolOperations.EvaluateAutoScaleAsync Method (String, String, IEnumerable<BatchClientBehavior>)

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.

Namespace:   Microsoft.Azure.Batch
Assembly:  Microsoft.Azure.Batch (in Microsoft.Azure.Batch.dll)

Syntax

public Task<AutoScaleEvaluation> EvaluateAutoScaleAsync(
    string poolId,
    string autoscaleFormula,
    IEnumerable<BatchClientBehavior> additionalBehaviors = null
)

public:
Task<AutoScaleEvaluation^>^ EvaluateAutoScaleAsync(
    String^ poolId,
    String^ autoscaleFormula,
    IEnumerable<BatchClientBehavior^>^ additionalBehaviors = null
)

member EvaluateAutoScaleAsync : 
        poolId:string *
        autoscaleFormula:string *
        additionalBehaviors:IEnumerable<BatchClientBehavior> = null -> Task<AutoScaleEvaluation>

Public Function EvaluateAutoScaleAsync (
    poolId As String,
    autoscaleFormula As String,
    additionalBehaviors As IEnumerable(Of BatchClientBehavior)
) As Task(Of AutoScaleEvaluation)

Parameters

• poolId
  Type: System.String

  The id of the pool.

• autoscaleFormula
  Type: System.String

  The formula to be evaluated on the pool.

• additionalBehaviors
  Type: System.Collections.Generic.IEnumerable<BatchClientBehavior>

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

Return Value

Type: System.Threading.Tasks.Task<AutoScaleEvaluation>

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.

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

The evaluate operation runs asynchronously.

See Also

PoolOperations Class
Microsoft.Azure.Batch Namespace

Return to top