Share via


ComputeBatchModelFactory.BatchPoolResizeOptions Method

Definition

Parameters for changing the size of an Azure Batch Pool.

public static Azure.Compute.Batch.BatchPoolResizeOptions BatchPoolResizeOptions(int? targetDedicatedNodes = default, int? targetLowPriorityNodes = default, TimeSpan? resizeTimeout = default, Azure.Compute.Batch.BatchNodeDeallocationOption? nodeDeallocationOption = default);
static member BatchPoolResizeOptions : Nullable<int> * Nullable<int> * Nullable<TimeSpan> * Nullable<Azure.Compute.Batch.BatchNodeDeallocationOption> -> Azure.Compute.Batch.BatchPoolResizeOptions
Public Shared Function BatchPoolResizeOptions (Optional targetDedicatedNodes As Nullable(Of Integer) = Nothing, Optional targetLowPriorityNodes As Nullable(Of Integer) = Nothing, Optional resizeTimeout As Nullable(Of TimeSpan) = Nothing, Optional nodeDeallocationOption As Nullable(Of BatchNodeDeallocationOption) = Nothing) As BatchPoolResizeOptions

Parameters

targetDedicatedNodes
Nullable<Int32>

The desired number of dedicated Compute Nodes in the Pool.

targetLowPriorityNodes
Nullable<Int32>

The desired number of Spot/Low-priority Compute Nodes in the Pool.

resizeTimeout
Nullable<TimeSpan>

The timeout for allocation of Nodes to the Pool or removal of Compute Nodes from 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) if the Pool size is decreasing. The default value is requeue.

Returns

A new BatchPoolResizeOptions instance for mocking.

Applies to