CloudJob.CommitChangesAsync Method

Definition

Namespace:

Microsoft.Azure.Batch

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.3.1

Source:

CloudJob.cs

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 = default, System.Threading.CancellationToken cancellationToken = default);

member this.CommitChangesAsync : seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function CommitChangesAsync (Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As 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

Task

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.