ComputeNodeOperationsExtensions.Deallocate Method

Definition

Namespace:

Microsoft.Azure.Batch.Protocol

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.3.1

Deallocates the specified Compute Node.

public static Microsoft.Azure.Batch.Protocol.Models.ComputeNodeDeallocateHeaders Deallocate (this Microsoft.Azure.Batch.Protocol.IComputeNodeOperations operations, string poolId, string nodeId, Microsoft.Azure.Batch.Protocol.Models.ComputeNodeDeallocateOption? nodeDeallocateOption = default, Microsoft.Azure.Batch.Protocol.Models.ComputeNodeDeallocateOptions computeNodeDeallocateOptions = default);

static member Deallocate : Microsoft.Azure.Batch.Protocol.IComputeNodeOperations * string * string * Nullable<Microsoft.Azure.Batch.Protocol.Models.ComputeNodeDeallocateOption> * Microsoft.Azure.Batch.Protocol.Models.ComputeNodeDeallocateOptions -> Microsoft.Azure.Batch.Protocol.Models.ComputeNodeDeallocateHeaders

<Extension()>
Public Function Deallocate (operations As IComputeNodeOperations, poolId As String, nodeId As String, Optional nodeDeallocateOption As Nullable(Of ComputeNodeDeallocateOption) = Nothing, Optional computeNodeDeallocateOptions As ComputeNodeDeallocateOptions = Nothing) As ComputeNodeDeallocateHeaders

Parameters

operations

IComputeNodeOperations

The operations group for this extension method.

poolId

String

The ID of the Pool that contains the Compute Node.

nodeId

String

The ID of the Compute Node that you want to deallocate.

nodeDeallocateOption

Nullable<ComputeNodeDeallocateOption>

When to deallocate the Compute Node and what to do with currently running Tasks. The default value is requeue. Possible values include: 'requeue', 'terminate', 'taskCompletion', 'retainedData'

computeNodeDeallocateOptions

ComputeNodeDeallocateOptions

Additional parameters for the operation

Returns

ComputeNodeDeallocateHeaders

Remarks

You can deallocate a Compute Node only if it is in an idle or running state.