Pool - Enable Auto Scale
Enables automatic scaling for a Pool.
You cannot enable automatic scaling on a Pool if a resize operation is in progress on the Pool. If automatic scaling of the Pool is currently disabled, you must specify a valid autoscale formula as part of the request. If automatic scaling of the Pool is already enabled, you may specify a new autoscale formula and/or a new evaluation interval. You cannot call this API for the same Pool more than once every 30 seconds.
POST {batchUrl}/pools/{poolId}/enableautoscale?api-version=2024-07-01.20.0POST {batchUrl}/pools/{poolId}/enableautoscale?timeout={timeout}&api-version=2024-07-01.20.0URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
batch
|
path | True |
string |
The base URL for all Azure Batch service requests. |
|
pool
|
path | True |
string |
The ID of the Pool on which to enable automatic scaling. |
|
api-version
|
query | True |
string |
Client API Version. |
|
timeout
|
query |
integer int32 |
The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead. |
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. |
|
| If-Match |
string |
An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. |
|
| If-None-Match |
string |
An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. |
|
| If-Modified-Since |
string date-time-rfc1123 |
A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. |
|
| If-Unmodified-Since |
string date-time-rfc1123 |
A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time. |
Request Body
Media Types: "application/json; odata=minimalmetadata"
| Name | Type | Description |
|---|---|---|
| autoScaleEvaluationInterval |
string |
The time interval at which to automatically adjust the Pool size according to the autoscale formula. |
| autoScaleFormula |
string |
The formula for the desired number of Compute Nodes in the Pool. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
The request to the Batch service was successful. Headers
|
|
| Other Status Codes |
The error from the Batch service. |
Security
azure_auth
Microsoft Entra OAuth 2.0 auth code 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 enable autoscale
Sample request
POST account.region.batch.azure.com/pools/poolId/enableautoscale?api-version=2024-07-01.20.0
{
"autoScaleFormula": "$TargetDedicated=0",
"autoScaleEvaluationInterval": "PT8M"
}
Sample response
Definitions
| Name | Description |
|---|---|
|
Batch |
An error response received from the Azure Batch service. |
|
Batch |
An item of additional information included in an Azure Batch error response. |
|
Error |
An error message received in an Azure Batch error response. |
|
Pool |
Options for enabling automatic scaling on a Pool. |
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. |
PoolEnableAutoScaleParameter
Options for enabling automatic scaling on a Pool.
| Name | Type | Description |
|---|---|---|
| autoScaleEvaluationInterval |
string |
The time interval at which to automatically adjust the Pool size according to the autoscale formula. |
| autoScaleFormula |
string |
The formula for the desired number of Compute Nodes in the Pool. |