BatchPoolResizeOptions interface

Package:

@azure-rest/batch

Parameters for changing the size of an Azure Batch Pool.

Properties

nodeDeallocationOption	Determines what to do with a Compute Node and its running task(s) if the Pool size is decreasing. The default value is requeue. Possible values: "requeue", "terminate", "taskcompletion", "retaineddata"
resizeTimeout	The timeout for allocation of Nodes to the Pool or removal of Compute Nodes from the Pool. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
targetDedicatedNodes	The desired number of dedicated Compute Nodes in the Pool.
targetLowPriorityNodes	The desired number of Spot/Low-priority Compute Nodes in the Pool.

Property Details

nodeDeallocationOption

Determines what to do with a Compute Node and its running task(s) if the Pool size is decreasing. The default value is requeue.

Possible values: "requeue", "terminate", "taskcompletion", "retaineddata"

nodeDeallocationOption?: string

Property Value

string

resizeTimeout

The timeout for allocation of Nodes to the Pool or removal of Compute Nodes from the Pool. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

resizeTimeout?: string

Property Value

string

targetDedicatedNodes

The desired number of dedicated Compute Nodes in the Pool.

targetDedicatedNodes?: number

Property Value

number

targetLowPriorityNodes

The desired number of Spot/Low-priority Compute Nodes in the Pool.

targetLowPriorityNodes?: number

Property Value

number