JobOperations.TerminateJob Method

Definition

Namespace:

Microsoft.Azure.Batch

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.3.1

Source:

JobOperations.cs

Terminates the specified job, marking it as completed.

public void TerminateJob(string jobId, string terminateReason = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);

member this.TerminateJob : string * string * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit

Public Sub TerminateJob (jobId As String, Optional terminateReason As String = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)

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.

Remarks

This is a blocking operation. For a non-blocking equivalent, see TerminateJobAsync(String, String, IEnumerable<BatchClientBehavior>, CancellationToken).