Share via

PoolOperations.Reboot Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Batch
Assembly:
Microsoft.Azure.Batch.dll
Package:
Microsoft.Azure.Batch v16.3.1
Source:
PoolOperations.cs

Reboots the specified compute node.

public void Reboot (string poolId, string computeNodeId, Microsoft.Azure.Batch.Common.ComputeNodeRebootOption? rebootOption = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);
member this.Reboot : string * string * Nullable<Microsoft.Azure.Batch.Common.ComputeNodeRebootOption> * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit
Public Sub Reboot (poolId As String, computeNodeId As String, Optional rebootOption As Nullable(Of ComputeNodeRebootOption) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)

Parameters

poolId
String

The id of the pool that contains the compute node.

computeNodeId
String

The id of the compute node to reboot.

rebootOption
Nullable<ComputeNodeRebootOption>

Specifies when to reboot 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.

Remarks

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

This is a blocking operation. For a non-blocking equivalent, see RebootAsync(String, String, Nullable<ComputeNodeRebootOption>, IEnumerable<BatchClientBehavior>, CancellationToken).

Applies to