JobScheduleOperationsExtensions.PatchAsync Method

Definition

Updates the properties of the specified Job Schedule.

public static System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.JobSchedulePatchHeaders> PatchAsync (this Microsoft.Azure.Batch.Protocol.IJobScheduleOperations operations, string jobScheduleId, Microsoft.Azure.Batch.Protocol.Models.JobSchedulePatchParameter jobSchedulePatchParameter, Microsoft.Azure.Batch.Protocol.Models.JobSchedulePatchOptions jobSchedulePatchOptions = default, System.Threading.CancellationToken cancellationToken = default);
static member PatchAsync : Microsoft.Azure.Batch.Protocol.IJobScheduleOperations * string * Microsoft.Azure.Batch.Protocol.Models.JobSchedulePatchParameter * Microsoft.Azure.Batch.Protocol.Models.JobSchedulePatchOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.JobSchedulePatchHeaders>
<Extension()>
Public Function PatchAsync (operations As IJobScheduleOperations, jobScheduleId As String, jobSchedulePatchParameter As JobSchedulePatchParameter, Optional jobSchedulePatchOptions As JobSchedulePatchOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of JobSchedulePatchHeaders)

Parameters

operations
IJobScheduleOperations

The operations group for this extension method.

jobScheduleId
System.String

The ID of the Job Schedule to update.

jobSchedulePatchParameter
JobSchedulePatchParameter

The parameters for the request.

jobSchedulePatchOptions
JobSchedulePatchOptions

Additional parameters for the operation

cancellationToken
System.Threading.CancellationToken

The cancellation token.

Returns

System.Threading.Tasks.Task<JobSchedulePatchHeaders>

Remarks

This replaces only the Job Schedule properties specified in the request. For example, if the schedule property is not specified with this request, then the Batch service will keep the existing schedule. Changes to a Job Schedule only impact Jobs created by the schedule after the update has taken place; currently running Jobs are unaffected.

Applies to