Pool resize start event

  • Article

This event is emitted when a pool resize has started. Since the pool resize is an asynchronous event, you can expect a pool resize complete event to be emitted once the resize operation completes.

The following example shows the body of a pool resize start event for a pool resizing from 0 to 2 nodes with a manual resize.

{
   "id": "myPool1",
   "nodeDeallocationOption": "Invalid",
   "currentDedicatedNodes": 0,
   "targetDedicatedNodes": 2,
   "currentLowPriorityNodes": 0,
   "targetLowPriorityNodes": 2,
   "enableAutoScale": false,
   "isAutoPool": false
}
Element Type Notes
id String The ID of the pool.
nodeDeallocationOption String Specifies when nodes may be removed from the pool, if the pool size is decreasing.

Possible values are:

requeue - Terminate running tasks and requeue them. The tasks will run again when the job is enabled. Remove nodes as soon as tasks have been terminated.

terminate - Terminate running tasks. The tasks will not run again. Remove nodes as soon as tasks have been terminated.

taskcompletion - Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed.

Retaineddata - Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired.

The default value is requeue.

If the pool size is increasing then the value is set to invalid.
currentDedicatedNodes Int32 The number of dedicated compute nodes currently assigned to the pool.
targetDedicatedNodes Int32 The number of dedicated compute nodes that are requested for the pool.
enableAutoScale Bool Specifies whether the pool size automatically adjusts over time.
isAutoPool Bool Specifies whether the pool was created via a job's AutoPool mechanism.