Pool - Evaluate Auto Scale

Gets the result of evaluating an automatic scaling formula on the Pool.
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.

POST {batchUrl}/pools/{poolId}/evaluateautoscale?api-version=2019-08-01.10.0
POST {batchUrl}/pools/{poolId}/evaluateautoscale?timeout={timeout}&api-version=2019-08-01.10.0

URI Parameters

Name In Required Type Description
batchUrl
path True
  • string

The base URL for all Azure Batch service requests.

poolId
path True
  • string

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

timeout
query
  • integer
int32

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.

api-version
query True
  • string

Client API Version.

Request Header

Media Types: "application/json; odata=minimalmetadata"

Name Required Type Description
client-request-id
  • string
uuid

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id
  • boolean

Whether the server should return the client-request-id in the response.

ocp-date
  • string
date-time-rfc1123

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Request Body

Media Types: "application/json; odata=minimalmetadata"

Name Required Type Description
autoScaleFormula True
  • 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/en-us/documentation/articles/batch-automatic-scaling).

Responses

Name Type Description
200 OK

A response containing the results of the autoscale evaluation.

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

The error from the Batch service.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Impersonate your user account

Authorization

Type: apiKey
In: header

Examples

Pool evaluate autoscale

Sample Request

POST account.region.batch.azure.com/pools/poolId/evaluateautoscale?api-version=2019-08-01.10.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT
{
  "autoScaleFormula": "$TargetDedicated=1"
}

Sample Response

{
  "timestamp": "2016-11-22T19:39:28.5246331Z",
  "results": "$TargetDedicated=1;$NodeDeallocationOption=requeue"
}

Definitions

AutoScaleRun

The results and errors from an execution of a Pool autoscale formula.

AutoScaleRunError

An error that occurred when executing or evaluating a Pool autoscale formula.

BatchError

An error response received from the Azure Batch service.

BatchErrorDetail

An item of additional information included in an Azure Batch error response.

ErrorMessage

An error message received in an Azure Batch error response.

NameValuePair

Represents a name-value pair.

PoolEvaluateAutoScaleParameter

Options for evaluating an automatic scaling formula on a Pool.

AutoScaleRun

The results and errors from an execution of a Pool autoscale formula.

Name Type Description
error

Details of the error encountered evaluating the autoscale formula on the Pool, if the evaluation was unsuccessful.

results
  • string

The final values of all variables used in the evaluation of the autoscale formula.
Each variable value is returned in the form $variable=value, and variables are separated by semicolons.

timestamp
  • string

The time at which the autoscale formula was last evaluated.

AutoScaleRunError

An error that occurred when executing or evaluating a Pool autoscale formula.

Name Type Description
code
  • string

An identifier for the autoscale error. Codes are invariant and are intended to be consumed programmatically.

message
  • string

A message describing the autoscale error, intended to be suitable for display in a user interface.

values

A list of additional error details related to the autoscale error.

BatchError

An error response received from the Azure Batch service.

Name Type Description
code
  • string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

message

A message describing the error, intended to be suitable for display in a user interface.

values

A collection of key-value pairs containing additional details about the error.

BatchErrorDetail

An item of additional information included in an Azure Batch error response.

Name Type Description
key
  • string

An identifier specifying the meaning of the Value property.

value
  • string

The additional information included with the error response.

ErrorMessage

An error message received in an Azure Batch error response.

Name Type Description
lang
  • string

The language code of the error message

value
  • string

The text of the message.

NameValuePair

Represents a name-value pair.

Name Type Description
name
  • string

The name in the name-value pair.

value
  • string

The value in the name-value pair.

PoolEvaluateAutoScaleParameter

Options for evaluating an automatic scaling formula on a Pool.

Name Type Description
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/en-us/documentation/articles/batch-automatic-scaling).