NodeRemoveParameter | @azure/batch

An interface representing NodeRemoveParameter.

summary: Options for removing compute nodes from a pool.

Hierarchy

NodeRemoveParameter

Index

Properties

nodeDeallocationOption
nodeList
resizeTimeout

Properties

Optional nodeDeallocationOption

nodeDeallocationOption: ComputeNodeDeallocationOption

Determines what to do with a 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'

nodeList

nodeList: string[]

A list containing the IDs of the compute nodes to be removed from the specified pool.

Optional resizeTimeout

resizeTimeout: undefined | string

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