CloudJob.Terminate(String, IEnumerable<BatchClientBehavior>) Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Batch
Assembly:
Microsoft.Azure.Batch.dll
Package:
Microsoft.Azure.Batch v16.2.0
Source:
CloudJob.cs

Terminates this CloudJob, marking it as completed.

public void Terminate (string terminateReason = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);
member this.Terminate : string * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit
Public Sub Terminate (Optional terminateReason As String = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)

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.

Remarks

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

Applies to