ResizeOperationStatus interface

Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).

Properties

errors

This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady.

nodeDeallocationOption

The default value is requeue.

resizeTimeout

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

startTime

The time when this resize operation was started.

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

errors

This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady.

errors?: ResizeError[]

Property Value

nodeDeallocationOption

The default value is requeue.

nodeDeallocationOption?: ComputeNodeDeallocationOption

Property Value

resizeTimeout

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

startTime

The time when this resize operation was started.

startTime?: Date

Property Value

Date

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