ComputeBatchModelFactory.BatchPoolEnableAutoScaleOptions Method
Definition
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.
Parameters for enabling automatic scaling on an Azure Batch Pool.
public static Azure.Compute.Batch.BatchPoolEnableAutoScaleOptions BatchPoolEnableAutoScaleOptions(string autoScaleFormula = default, TimeSpan? autoScaleEvaluationInterval = default);static member BatchPoolEnableAutoScaleOptions : string * Nullable<TimeSpan> -> Azure.Compute.Batch.BatchPoolEnableAutoScaleOptionsPublic Shared Function BatchPoolEnableAutoScaleOptions (Optional autoScaleFormula As String = Nothing, Optional autoScaleEvaluationInterval As Nullable(Of TimeSpan) = Nothing) As BatchPoolEnableAutoScaleOptionsParameters
- autoScaleFormula
- String
The formula for the desired number of Compute Nodes in the Pool. 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.
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.
Returns
A new BatchPoolEnableAutoScaleOptions instance for mocking.
