ComputeNodeOperationsExtensions.Reboot Method

Definition

Namespace:

Microsoft.Azure.Batch.Protocol

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.3.1

Source:

ComputeNodeOperationsExtensions.cs

Restarts the specified Compute Node.

public static Microsoft.Azure.Batch.Protocol.Models.ComputeNodeRebootHeaders Reboot (this Microsoft.Azure.Batch.Protocol.IComputeNodeOperations operations, string poolId, string nodeId, Microsoft.Azure.Batch.Protocol.Models.ComputeNodeRebootOption? nodeRebootOption = default, Microsoft.Azure.Batch.Protocol.Models.ComputeNodeRebootOptions computeNodeRebootOptions = default);

static member Reboot : Microsoft.Azure.Batch.Protocol.IComputeNodeOperations * string * string * Nullable<Microsoft.Azure.Batch.Protocol.Models.ComputeNodeRebootOption> * Microsoft.Azure.Batch.Protocol.Models.ComputeNodeRebootOptions -> Microsoft.Azure.Batch.Protocol.Models.ComputeNodeRebootHeaders

<Extension()>
Public Function Reboot (operations As IComputeNodeOperations, poolId As String, nodeId As String, Optional nodeRebootOption As Nullable(Of ComputeNodeRebootOption) = Nothing, Optional computeNodeRebootOptions As ComputeNodeRebootOptions = Nothing) As ComputeNodeRebootHeaders

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.

nodeRebootOption

Nullable<ComputeNodeRebootOption>

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

computeNodeRebootOptions

ComputeNodeRebootOptions

Additional parameters for the operation

Returns

ComputeNodeRebootHeaders

Remarks

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