JobOperations.TerminateJobAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Batch

Assembly:: Microsoft.Azure.Batch.dll

Package:: Microsoft.Azure.Batch v16.2.0

Source:: JobOperations.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 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