Share via


ResizeOperationStatus Class

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

Constructor

ResizeOperationStatus(*, target_dedicated_nodes: int | None = None, target_low_priority_nodes: int | None = None, resize_timeout: timedelta | None = None, node_deallocation_option: str | _models.ComputeNodeDeallocationOption | None = None, start_time: datetime | None = None, errors: List[_models.ResizeError] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
target_dedicated_nodes
int

The desired number of dedicated compute nodes in the pool.

Default value: None
target_low_priority_nodes
int

The desired number of Spot/low-priority compute nodes in the pool.

Default value: None
resize_timeout

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

Default value: None
node_deallocation_option

The default value is requeue. Known values are: "Requeue", "Terminate", "TaskCompletion", and "RetainedData".

Default value: None
start_time

The time when this resize operation was started.

Default value: None
errors

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

Default value: None

Variables

Name Description
target_dedicated_nodes
int

The desired number of dedicated compute nodes in the pool.

target_low_priority_nodes
int

The desired number of Spot/low-priority compute nodes in the pool.

resize_timeout

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

node_deallocation_option

The default value is requeue. Known values are: "Requeue", "Terminate", "TaskCompletion", and "RetainedData".

start_time

The time when this resize operation was started.

errors

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