TaskOperationsExtensions.TerminateAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Batch.Protocol

Assembly:: Microsoft.Azure.Batch.dll

Package:: Microsoft.Azure.Batch v16.2.0

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.

Terminates the specified Task.

public static System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.TaskTerminateHeaders> TerminateAsync (this Microsoft.Azure.Batch.Protocol.ITaskOperations operations, string jobId, string taskId, Microsoft.Azure.Batch.Protocol.Models.TaskTerminateOptions taskTerminateOptions = default, System.Threading.CancellationToken cancellationToken = default);

static member TerminateAsync : Microsoft.Azure.Batch.Protocol.ITaskOperations * string * string * Microsoft.Azure.Batch.Protocol.Models.TaskTerminateOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.TaskTerminateHeaders>

<Extension()>
Public Function TerminateAsync (operations As ITaskOperations, jobId As String, taskId As String, Optional taskTerminateOptions As TaskTerminateOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of TaskTerminateHeaders)

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 terminate.

taskTerminateOptions: TaskTerminateOptions

Additional parameters for the operation

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<TaskTerminateHeaders>

Remarks

When the Task has been terminated, it moves to the completed state. For multi-instance Tasks, the terminate Task operation applies synchronously to the primary task; subtasks are then terminated asynchronously in the background.

Applies to