PoolOperations.RebootAsync Method
Definition
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.
Reboots the specified compute node.
public System.Threading.Tasks.Task RebootAsync (string poolId, string computeNodeId, Microsoft.Azure.Batch.Common.ComputeNodeRebootOption? rebootOption = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);
member this.RebootAsync : string * string * Nullable<Microsoft.Azure.Batch.Common.ComputeNodeRebootOption> * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function RebootAsync (poolId As String, computeNodeId As String, Optional rebootOption As Nullable(Of ComputeNodeRebootOption) = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task
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.
- cancellationToken
- CancellationToken
A CancellationToken for controlling the lifetime of the asynchronous operation.
Returns
A Task that represents the asynchronous operation.
Remarks
You can reboot a compute node only when it is in the Idle or Running state.
The reboot operation runs asynchronously.