JobOperationsExtensions.PatchAsync 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.JobPatchHeaders> PatchAsync (this Microsoft.Azure.Batch.Protocol.IJobOperations operations, string jobId, Microsoft.Azure.Batch.Protocol.Models.JobPatchParameter jobPatchParameter, Microsoft.Azure.Batch.Protocol.Models.JobPatchOptions jobPatchOptions = default, System.Threading.CancellationToken cancellationToken = default);

static member PatchAsync : Microsoft.Azure.Batch.Protocol.IJobOperations * string * Microsoft.Azure.Batch.Protocol.Models.JobPatchParameter * Microsoft.Azure.Batch.Protocol.Models.JobPatchOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.JobPatchHeaders>

<Extension()>
Public Function PatchAsync (operations As IJobOperations, jobId As String, jobPatchParameter As JobPatchParameter, Optional jobPatchOptions As JobPatchOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of JobPatchHeaders)

Parameters

operations

IJobOperations

The operations group for this extension method.

jobId

String

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

jobPatchParameter

JobPatchParameter

The parameters for the request.

jobPatchOptions

JobPatchOptions

Additional parameters for the operation

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<JobPatchHeaders>

Remarks

This replaces only the Job properties specified in the request. For example, if the Job has constraints, and a request does not specify the constraints element, then the Job keeps the existing constraints.