TaskOperationsExtensions.Reactivate Method

Reference

Definition

Namespace:: Microsoft.Azure.Batch.Protocol

Assembly:: Microsoft.Azure.Batch.dll

Package:: Microsoft.Azure.Batch v16.3.1

Source:: TaskOperationsExtensions.cs

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.

Reactivates a Task, allowing it to run again even if its retry count has been exhausted.

public static Microsoft.Azure.Batch.Protocol.Models.TaskReactivateHeaders Reactivate (this Microsoft.Azure.Batch.Protocol.ITaskOperations operations, string jobId, string taskId, Microsoft.Azure.Batch.Protocol.Models.TaskReactivateOptions taskReactivateOptions = default);

static member Reactivate : Microsoft.Azure.Batch.Protocol.ITaskOperations * string * string * Microsoft.Azure.Batch.Protocol.Models.TaskReactivateOptions -> Microsoft.Azure.Batch.Protocol.Models.TaskReactivateHeaders

<Extension()>
Public Function Reactivate (operations As ITaskOperations, jobId As String, taskId As String, Optional taskReactivateOptions As TaskReactivateOptions = Nothing) As TaskReactivateHeaders

Parameters

operations: ITaskOperations

The operations group for this extension method.

jobId: String

The ID of the Job containing the Task.

taskId: String

The ID of the Task to reactivate.

taskReactivateOptions: TaskReactivateOptions

Additional parameters for the operation

Returns

TaskReactivateHeaders

Remarks

Reactivation makes a Task eligible to be retried again up to its maximum retry count. The Task's state is changed to active. As the Task is no longer in the completed state, any previous exit code or failure information is no longer available after reactivation. Each time a Task is reactivated, its retry count is reset to 0. Reactivation will fail for Tasks that are not completed or that previously completed successfully (with an exit code of 0). Additionally, it will fail if the Job has completed (or is terminating or deleting).

Applies to

Share via