Automatic scaling of batch pools - az batch pool autoscale

Manage automatic scaling of your Batch pools.

Commands

az batch pool autoscale disable Disables automatic scaling for a pool.
az batch pool autoscale enable Enables automatic scaling for a pool.
az batch pool autoscale evaluate Gets the result of evaluating an automatic scaling formula on the pool.

az batch pool autoscale disable

Disables automatic scaling for a pool.

az batch pool autoscale disable --pool-id
[--account-endpoint]
[--account-key]
[--account-name]

Required Parameters

--pool-id

The ID of the pool on which to disable automatic scaling.

Optional Parameters

--account-endpoint

Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.

--account-key

Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.

--account-name

Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.

az batch pool autoscale enable

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.

az batch pool autoscale enable --pool-id
[--account-endpoint]
[--account-key]
[--account-name]
[--auto-scale-evaluation-interval]
[--auto-scale-formula]
[--if-match]
[--if-modified-since]
[--if-none-match]
[--if-unmodified-since]

Required Parameters

--pool-id

The ID of the pool on which to enable automatic scaling.

Optional Parameters

--account-endpoint

Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.

--account-key

Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.

--account-name

Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.

--auto-scale-evaluation-interval

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.

--auto-scale-formula

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://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).

--if-match

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-modified-since

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-none-match

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-unmodified-since

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.

az batch pool autoscale evaluate

This API is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the pool.

az batch pool autoscale evaluate --auto-scale-formula
--pool-id
[--account-endpoint]
[--account-key]
[--account-name]

Required Parameters

--auto-scale-formula

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).

--pool-id

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

Optional Parameters

--account-endpoint

Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.

--account-key

Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.

--account-name

Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.