PoolOperations.ReimageAsync(String, String, Nullable<ComputeNodeReimageOption>, IEnumerable<BatchClientBehavior>, CancellationToken) Method

Definition

Reinstalls the operating system on the specified compute node.

public System.Threading.Tasks.Task ReimageAsync (string poolId, string computeNodeId, Microsoft.Azure.Batch.Common.ComputeNodeReimageOption? reimageOption = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);
member this.ReimageAsync : string * string * Nullable<Microsoft.Azure.Batch.Common.ComputeNodeReimageOption> * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function ReimageAsync (poolId As String, computeNodeId As String, Optional reimageOption As Nullable(Of ComputeNodeReimageOption) = null, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = null, Optional cancellationToken As CancellationToken = null) As Task

Parameters

poolId
String

The id of the pool that contains the compute node.

computeNodeId
String

The id of the compute node to reimage.

reimageOption
Nullable<ComputeNodeReimageOption>

Specifies when to reimage the node and what to do with currently running tasks. The default is Requeue.

additionalBehaviors
IEnumerable<BatchClientBehavior>

A collection of BatchClientBehavior instances that are applied to the Batch service request after the CustomBehaviors.

cancellationToken
CancellationToken

A CancellationToken for controlling the lifetime of the asynchronous operation.

Returns

A Task that represents the asynchronous operation.

Remarks

You can reimage a compute node only when it is in the Idle or Running state.

The reimage operation runs asynchronously.

Applies to