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

 

Terminates the specified job, marking it as completed.

Namespace:   Microsoft.Azure.Batch
Assembly:  Microsoft.Azure.Batch (in Microsoft.Azure.Batch.dll)

Syntax

public Task TerminateJobAsync(
    string jobId,
    string terminateReason = null,
    IEnumerable<BatchClientBehavior> additionalBehaviors = null
)

public:
Task^ TerminateJobAsync(
    String^ jobId,
    String^ terminateReason = null,
    IEnumerable<BatchClientBehavior^>^ additionalBehaviors = null
)

member TerminateJobAsync : 
        jobId:string *
        terminateReason:string = null *
        additionalBehaviors:IEnumerable<BatchClientBehavior> = null -> Task

Public Function TerminateJobAsync (
    jobId As String,
    terminateReason As String,
    additionalBehaviors As IEnumerable(Of BatchClientBehavior)
) As Task

Parameters

• jobId
  Type: System.String

  The id of the job.

• terminateReason
  Type: System.String

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

• additionalBehaviors
  Type: System.Collections.Generic.IEnumerable<BatchClientBehavior>

  A collection of BatchClientBehavior instances that are applied to the Batch service request after the CustomBehaviors.

Return Value

Type: System.Threading.Tasks.Task

A Task object that represents the asynchronous operation.

Remarks

The terminate operation runs asynchronously.

See Also

JobOperations Class
Microsoft.Azure.Batch Namespace

Return to top