JobScheduleOperationsExtensions.UpdateAsync Method

Definition

Updates the properties of the specified Job Schedule.

public static System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.JobScheduleUpdateHeaders> UpdateAsync (this Microsoft.Azure.Batch.Protocol.IJobScheduleOperations operations, string jobScheduleId, Microsoft.Azure.Batch.Protocol.Models.JobScheduleUpdateParameter jobScheduleUpdateParameter, Microsoft.Azure.Batch.Protocol.Models.JobScheduleUpdateOptions jobScheduleUpdateOptions = default, System.Threading.CancellationToken cancellationToken = default);
static member UpdateAsync : Microsoft.Azure.Batch.Protocol.IJobScheduleOperations * string * Microsoft.Azure.Batch.Protocol.Models.JobScheduleUpdateParameter * Microsoft.Azure.Batch.Protocol.Models.JobScheduleUpdateOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.JobScheduleUpdateHeaders>
<Extension()>
Public Function UpdateAsync (operations As IJobScheduleOperations, jobScheduleId As String, jobScheduleUpdateParameter As JobScheduleUpdateParameter, Optional jobScheduleUpdateOptions As JobScheduleUpdateOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of JobScheduleUpdateHeaders)

Parameters

operations
IJobScheduleOperations

The operations group for this extension method.

jobScheduleId
System.String

The ID of the Job Schedule to update.

jobScheduleUpdateParameter
JobScheduleUpdateParameter

The parameters for the request.

jobScheduleUpdateOptions
JobScheduleUpdateOptions

Additional parameters for the operation

cancellationToken
System.Threading.CancellationToken

The cancellation token.

Returns

System.Threading.Tasks.Task<JobScheduleUpdateHeaders>

Remarks

This fully replaces all the updatable properties of the Job Schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove 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