BatchNodeRemoveOptions interface
Parameters for removing nodes from an Azure Batch Pool.
Properties
| node |
Determines what to do with a Compute Node and its running task(s) after it has been selected for deallocation. The default value is requeue. |
| node |
A list containing the IDs of the Compute Nodes to be removed from the specified Pool. A maximum of 100 nodes may be removed per request. |
| resize |
The timeout for removal of Compute Nodes to 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). The time duration is specified in ISO 8601 format. |
Property Details
nodeDeallocationOption
Determines what to do with a Compute Node and its running task(s) after it has been selected for deallocation. The default value is requeue.
nodeDeallocationOption?: BatchNodeDeallocationOptionProperty Value
nodeIds
A list containing the IDs of the Compute Nodes to be removed from the specified Pool. A maximum of 100 nodes may be removed per request.
nodeIds: string[]Property Value
string[]
resizeTimeout
The timeout for removal of Compute Nodes to 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). The time duration is specified in ISO 8601 format.
resizeTimeout?: stringProperty Value
string