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.0With optional parameters:
POST {batchUrl}/pools/{poolId}/enableautoscale?timeout={timeout}&api-version=2024-07-01.20.0batchUrl
path Truestring
The base URL for all Azure Batch service requests.
poolId
path Truestring
The ID of the Pool on which to enable automatic scaling.
api-version
query Truestring
Client API Version.
timeout
queryinteger (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.
Media Types: "application/json; odata=minimalmetadata"
Name Required Type Description client-request-idstring (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-idboolean
Whether the server should return the client-request-id in the response.
ocp-datestring (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-Matchstring
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-Matchstring
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-Sincestring (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-Sincestring (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 BodyMedia Types: "application/json; odata=minimalmetadata"
Name Type Description autoScaleEvaluationIntervalstring (duration)
The time interval at which to automatically adjust the Pool size according to the autoscale formula.
The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). If you specify a new interval, then the existing autoscale evaluation schedule will be stopped and a new autoscale evaluation schedule will be started, with its starting time being the time when this request was issued.
string
The formula for the desired number of Compute Nodes in the Pool.
The formula is checked for validity before it is applied to the Pool. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see 'Automatically scale Compute Nodes in an Azure Batch Pool' (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).
The request to the Batch service was successful.
Headers
The error from the Batch service.
Security azure_authMicrosoft Entra OAuth 2.0 auth code flow
Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Type: apiKey
In: header
POST account.region.batch.azure.com/pools/poolId/enableautoscale?api-version=2024-07-01.20.0
{
"autoScaleFormula": "$TargetDedicated=0",
"autoScaleEvaluationInterval": "PT8M"
}
An error response received from the Azure Batch service.
BatchErrorDetailAn item of additional information included in an Azure Batch error response.
ErrorMessageAn error message received in an Azure Batch error response.
PoolEnableAutoScaleParameterOptions for enabling automatic scaling on a Pool.
BatchErrorObject
An error response received from the Azure Batch service.
Name Type Description codestring
An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
messageA message describing the error, intended to be suitable for display in a user interface.
valuesA collection of key-value pairs containing additional details about the error.
BatchErrorDetailObject
An item of additional information included in an Azure Batch error response.
Name Type Description keystring
An identifier specifying the meaning of the Value property.
valuestring
The additional information included with the error response.
ErrorMessageObject
An error message received in an Azure Batch error response.
Name Type Description langstring
The language code of the error message
valuestring
The text of the message.
PoolEnableAutoScaleParameterObject
Options for enabling automatic scaling on a Pool.
Name Type Description autoScaleEvaluationIntervalstring (duration)
The time interval at which to automatically adjust the Pool size according to the autoscale formula.
The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). If you specify a new interval, then the existing autoscale evaluation schedule will be stopped and a new autoscale evaluation schedule will be started, with its starting time being the time when this request was issued.
string
The formula for the desired number of Compute Nodes in the Pool.
The formula is checked for validity before it is applied to the Pool. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see 'Automatically scale Compute Nodes in an Azure Batch Pool' (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4