JobOperationsExtensions.UpdateAsync Method

Definition

Namespace:

Microsoft.Azure.Batch.Protocol

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.3.1

Source:

JobOperationsExtensions.cs

Updates the properties of the specified Job.

public static System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.JobUpdateHeaders> UpdateAsync (this Microsoft.Azure.Batch.Protocol.IJobOperations operations, string jobId, Microsoft.Azure.Batch.Protocol.Models.JobUpdateParameter jobUpdateParameter, Microsoft.Azure.Batch.Protocol.Models.JobUpdateOptions jobUpdateOptions = default, System.Threading.CancellationToken cancellationToken = default);

static member UpdateAsync : Microsoft.Azure.Batch.Protocol.IJobOperations * string * Microsoft.Azure.Batch.Protocol.Models.JobUpdateParameter * Microsoft.Azure.Batch.Protocol.Models.JobUpdateOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.JobUpdateHeaders>

<Extension()>
Public Function UpdateAsync (operations As IJobOperations, jobId As String, jobUpdateParameter As JobUpdateParameter, Optional jobUpdateOptions As JobUpdateOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of JobUpdateHeaders)

Parameters

operations

IJobOperations

The operations group for this extension method.

jobId

String

The ID of the Job whose properties you want to update.

jobUpdateParameter

JobUpdateParameter

The parameters for the request.

jobUpdateOptions

JobUpdateOptions

Additional parameters for the operation

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<JobUpdateHeaders>

Remarks

This fully replaces all the updatable properties of the Job. For example, if the Job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.