NodeRemoveParameter interface
An interface representing NodeRemoveParameter.
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. Possible values include: 'requeue', 'terminate', 'taskCompletion', 'retainedData' |
node |
A list containing the IDs of the Compute Nodes to be removed from the specified Pool. |
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). |
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. Possible values include: 'requeue', 'terminate', 'taskCompletion', 'retainedData'
nodeDeallocationOption?: ComputeNodeDeallocationOption
Property Value
nodeList
A list containing the IDs of the Compute Nodes to be removed from the specified Pool.
nodeList: 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).
resizeTimeout?: string
Property Value
string