JobOperations.TerminateJobAsync(String, String, IEnumerable<BatchClientBehavior>, CancellationToken) Method

Definition

Terminates the specified job, marking it as completed.

public System.Threading.Tasks.Task TerminateJobAsync (string jobId, string terminateReason = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);
member this.TerminateJobAsync : string * string * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function TerminateJobAsync (jobId As String, Optional terminateReason As String = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

jobId
String

The id of the job.

terminateReason
String

The text you want to appear as the job's TerminateReason.

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

Task

A Task object that represents the asynchronous operation.

Remarks

The terminate operation runs asynchronously.

Applies to