CloudJob.CommitChanges(IEnumerable<BatchClientBehavior>) 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 void CommitChanges (System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);

member this.CommitChanges : seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit

Public Sub CommitChanges (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

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 is a blocking operation. For a non-blocking equivalent, see CommitChangesAsync(IEnumerable<BatchClientBehavior>, CancellationToken).