ComputeNodeOperationsExtensions.ReimageAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Batch.Protocol

Assembly:: Microsoft.Azure.Batch.dll

Package:: Microsoft.Azure.Batch v16.2.0

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.

Reinstalls the operating system on the specified Compute Node.

public static System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.ComputeNodeReimageHeaders> ReimageAsync (this Microsoft.Azure.Batch.Protocol.IComputeNodeOperations operations, string poolId, string nodeId, Microsoft.Azure.Batch.Protocol.Models.ComputeNodeReimageOption? nodeReimageOption = default, Microsoft.Azure.Batch.Protocol.Models.ComputeNodeReimageOptions computeNodeReimageOptions = default, System.Threading.CancellationToken cancellationToken = default);

static member ReimageAsync : Microsoft.Azure.Batch.Protocol.IComputeNodeOperations * string * string * Nullable<Microsoft.Azure.Batch.Protocol.Models.ComputeNodeReimageOption> * Microsoft.Azure.Batch.Protocol.Models.ComputeNodeReimageOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.ComputeNodeReimageHeaders>

<Extension()>
Public Function ReimageAsync (operations As IComputeNodeOperations, poolId As String, nodeId As String, Optional nodeReimageOption As Nullable(Of ComputeNodeReimageOption) = Nothing, Optional computeNodeReimageOptions As ComputeNodeReimageOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ComputeNodeReimageHeaders)

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 restart.

nodeReimageOption: Nullable<ComputeNodeReimageOption>

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

computeNodeReimageOptions: ComputeNodeReimageOptions

Additional parameters for the operation

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<ComputeNodeReimageHeaders>

Remarks

You can reinstall the operating system on a Compute Node only if it is in an idle or running state. This API can be invoked only on Pools created with the cloud service configuration property.

Applies to

Share via