JobScheduleOperationsExtensions.UpdateAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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
- String
The ID of the Job Schedule to update.
- jobScheduleUpdateParameter
- JobScheduleUpdateParameter
The parameters for the request.
- jobScheduleUpdateOptions
- JobScheduleUpdateOptions
Additional parameters for the operation
- cancellationToken
- CancellationToken
The cancellation token.
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.
