ComputeNodeOperationsExtensions.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.
Restarts the specified Compute Node.
public static System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.ComputeNodeRebootHeaders> RebootAsync (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, System.Threading.CancellationToken cancellationToken = default);
static member RebootAsync : Microsoft.Azure.Batch.Protocol.IComputeNodeOperations * string * string * Nullable<Microsoft.Azure.Batch.Protocol.Models.ComputeNodeRebootOption> * Microsoft.Azure.Batch.Protocol.Models.ComputeNodeRebootOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.ComputeNodeRebootHeaders>
<Extension()>
Public Function RebootAsync (operations As IComputeNodeOperations, poolId As String, nodeId As String, Optional nodeRebootOption As Nullable(Of ComputeNodeRebootOption) = Nothing, Optional computeNodeRebootOptions As ComputeNodeRebootOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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
- cancellationToken
- CancellationToken
The cancellation token.
Returns
Remarks
You can restart a Compute Node only if it is in an idle or running state.
Applies to
Azure SDK for .NET
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for