ComputeNodeOperationsExtensions.Reimage(IComputeNodeOperations, String, String, Nullable<ComputeNodeReimageOption>, ComputeNodeReimageOptions) Method

Definition

Reinstalls the operating system on the specified compute node.

public static Microsoft.Azure.Batch.Protocol.Models.ComputeNodeReimageHeaders Reimage (this Microsoft.Azure.Batch.Protocol.IComputeNodeOperations operations, string poolId, string nodeId, Nullable<Microsoft.Azure.Batch.Protocol.Models.ComputeNodeReimageOption> nodeReimageOption = null, Microsoft.Azure.Batch.Protocol.Models.ComputeNodeReimageOptions computeNodeReimageOptions = null);
static member Reimage : Microsoft.Azure.Batch.Protocol.IComputeNodeOperations * string * string * Nullable<Microsoft.Azure.Batch.Protocol.Models.ComputeNodeReimageOption> * Microsoft.Azure.Batch.Protocol.Models.ComputeNodeReimageOptions -> Microsoft.Azure.Batch.Protocol.Models.ComputeNodeReimageHeaders

Parameters

operations
IComputeNodeOperations

The operations group for this extension method.

poolId
System.String

The ID of the pool that contains the compute node.

nodeId
System.String

The ID of the compute node that you want to restart.

nodeReimageOption
System.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

Returns

ComputeNodeReimageHeaders

Remarks

You can reinstall the operating system on a 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