PoolOperationsExtensions.EvaluateAutoScaleAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Batch.Protocol

Assembly:: Microsoft.Azure.Batch.dll

Package:: Microsoft.Azure.Batch v16.3.1

Source:: PoolOperationsExtensions.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 Pool.

public static System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.AutoScaleRun> EvaluateAutoScaleAsync (this Microsoft.Azure.Batch.Protocol.IPoolOperations operations, string poolId, string autoScaleFormula, Microsoft.Azure.Batch.Protocol.Models.PoolEvaluateAutoScaleOptions poolEvaluateAutoScaleOptions = default, System.Threading.CancellationToken cancellationToken = default);

static member EvaluateAutoScaleAsync : Microsoft.Azure.Batch.Protocol.IPoolOperations * string * string * Microsoft.Azure.Batch.Protocol.Models.PoolEvaluateAutoScaleOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.AutoScaleRun>

<Extension()>
Public Function EvaluateAutoScaleAsync (operations As IPoolOperations, poolId As String, autoScaleFormula As String, Optional poolEvaluateAutoScaleOptions As PoolEvaluateAutoScaleOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AutoScaleRun)

Parameters

operations: IPoolOperations

The operations group for this extension method.

poolId: String

The ID of the Pool on which to evaluate the automatic scaling formula.

autoScaleFormula: String

The formula for the desired number of Compute Nodes in the Pool. The formula is validated and its results calculated, but it is not applied to the Pool. To apply the formula to the Pool, 'Enable automatic scaling on a Pool'. For more information about specifying this formula, see Automatically scale Compute Nodes in an Azure Batch Pool (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling).

poolEvaluateAutoScaleOptions: PoolEvaluateAutoScaleOptions

Additional parameters for the operation

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<AutoScaleRun>

Remarks

This API is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the Pool. The Pool must have auto scaling enabled in order to evaluate a formula.

Applies to

Delen via