CloudJob.TerminateAsync(String, IEnumerable<BatchClientBehavior>, CancellationToken) Method

Definition

Terminates this CloudJob, marking it as completed.

public System.Threading.Tasks.Task TerminateAsync (string terminateReason = null, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = null, System.Threading.CancellationToken cancellationToken = null);
member this.TerminateAsync : string * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Parameters

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

A Task object that represents the asynchronous operation.

Remarks

The terminate operation runs asynchronously.

Applies to