Share via


IComputeNodeOperations.ReimageWithHttpMessagesAsync Method

Definition

Reinstalls the operating system on the specified Compute Node.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationHeaderResponse<Microsoft.Azure.Batch.Protocol.Models.ComputeNodeReimageHeaders>> ReimageWithHttpMessagesAsync (string poolId, string nodeId, Microsoft.Azure.Batch.Protocol.Models.ComputeNodeReimageOption? nodeReimageOption = default, Microsoft.Azure.Batch.Protocol.Models.ComputeNodeReimageOptions computeNodeReimageOptions = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ReimageWithHttpMessagesAsync : string * string * Nullable<Microsoft.Azure.Batch.Protocol.Models.ComputeNodeReimageOption> * Microsoft.Azure.Batch.Protocol.Models.ComputeNodeReimageOptions * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationHeaderResponse<Microsoft.Azure.Batch.Protocol.Models.ComputeNodeReimageHeaders>>
Public Function ReimageWithHttpMessagesAsync (poolId As String, nodeId As String, Optional nodeReimageOption As Nullable(Of ComputeNodeReimageOption) = Nothing, Optional computeNodeReimageOptions As ComputeNodeReimageOptions = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationHeaderResponse(Of ComputeNodeReimageHeaders))

Parameters

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

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Exceptions

Thrown when the operation returned an invalid status code

Thrown when a required parameter is null

Remarks

You can reinstall the operating system on a Compute Node only if it is in an idle or running state.

Applies to