JobScheduleOperationsExtensions.Update Method

Definition

Updates the properties of the specified Job Schedule.

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

Parameters

operations
IJobScheduleOperations

The operations group for this extension method.

jobScheduleId
String

The ID of the Job Schedule to update.

jobScheduleUpdateParameter
JobScheduleUpdateParameter

The parameters for the request.

jobScheduleUpdateOptions
JobScheduleUpdateOptions

Additional parameters for the operation

Returns

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