ComputeNodeOperationsExtensions.DeallocateAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Batch.Protocol

Assembly:: Microsoft.Azure.Batch.dll

Package:: Microsoft.Azure.Batch v16.3.1

Source:: ComputeNodeOperationsExtensions.cs

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.

Deallocates the specified Compute Node.

public static System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.ComputeNodeDeallocateHeaders> DeallocateAsync (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, System.Threading.CancellationToken cancellationToken = default);

static member DeallocateAsync : Microsoft.Azure.Batch.Protocol.IComputeNodeOperations * string * string * Nullable<Microsoft.Azure.Batch.Protocol.Models.ComputeNodeDeallocateOption> * Microsoft.Azure.Batch.Protocol.Models.ComputeNodeDeallocateOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.ComputeNodeDeallocateHeaders>

<Extension()>
Public Function DeallocateAsync (operations As IComputeNodeOperations, poolId As String, nodeId As String, Optional nodeDeallocateOption As Nullable(Of ComputeNodeDeallocateOption) = Nothing, Optional computeNodeDeallocateOptions As ComputeNodeDeallocateOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<ComputeNodeDeallocateHeaders>

Remarks

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

Applies to

Share via