CloudJob.CommitChangesAsync(IEnumerable<BatchClientBehavior>, CancellationToken) Method

Definition

Commits all pending changes to this CloudJob to the Azure Batch service.

public System.Threading.Tasks.Task CommitChangesAsync (System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = null, System.Threading.CancellationToken cancellationToken = null);
member this.CommitChangesAsync : seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Parameters

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

A Task that represents the asynchronous operation.

Remarks

Updates an existing CloudJob on the Batch service by replacing its properties with the properties of this CloudJob which have been changed. Unchanged properties are ignored. All changes since the last time this entity was retrieved from the Batch service (either via Refresh(DetailLevel, IEnumerable<BatchClientBehavior>), GetJob(String, DetailLevel, IEnumerable<BatchClientBehavior>), or ListJobs(DetailLevel, IEnumerable<BatchClientBehavior>)) are applied. Properties which are explicitly set to null will cause an exception because the Batch service does not support partial updates which set a property to null. If you need to set a property to null, use Commit(IEnumerable<BatchClientBehavior>).

This operation runs asynchronously.

Applies to