ComputeBatchModelFactory.BatchNodeRemoveOptions Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Parameters for removing nodes from an Azure Batch Pool.
public static Azure.Compute.Batch.BatchNodeRemoveOptions BatchNodeRemoveOptions(System.Collections.Generic.IEnumerable<string> nodeIds = default, TimeSpan? resizeTimeout = default, Azure.Compute.Batch.BatchNodeDeallocationOption? nodeDeallocationOption = default);static member BatchNodeRemoveOptions : seq<string> * Nullable<TimeSpan> * Nullable<Azure.Compute.Batch.BatchNodeDeallocationOption> -> Azure.Compute.Batch.BatchNodeRemoveOptionsPublic Shared Function BatchNodeRemoveOptions (Optional nodeIds As IEnumerable(Of String) = Nothing, Optional resizeTimeout As Nullable(Of TimeSpan) = Nothing, Optional nodeDeallocationOption As Nullable(Of BatchNodeDeallocationOption) = Nothing) As BatchNodeRemoveOptionsParameters
- nodeIds
- IEnumerable<String>
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.
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).
- nodeDeallocationOption
- Nullable<BatchNodeDeallocationOption>
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.
Returns
A new BatchNodeRemoveOptions instance for mocking.
