CloudJobSchedule.Terminate(IEnumerable<BatchClientBehavior>) Method
Definition
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 this CloudJobSchedule. Terminated schedules remain in the system but do not create new jobs.
public void Terminate (System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);
member this.Terminate : seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit
Public Sub Terminate (Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)
Parameters
- additionalBehaviors
- IEnumerable<BatchClientBehavior>
A collection of BatchClientBehavior instances that are applied to the Batch service request after the CustomBehaviors.
Remarks
The terminate operation requests that the job schedule be terminated. The request puts the schedule in the Terminating state. The Batch service will wait for any active job to terminate, and perform the actual job schedule termination without any further client action.
This is a blocking operation. For a non-blocking equivalent, see TerminateAsync(IEnumerable<BatchClientBehavior>, CancellationToken).