IJobScheduleOperations.PatchWithHttpMessagesAsync Method

Definition

Updates the properties of the specified Job Schedule.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationHeaderResponse<Microsoft.Azure.Batch.Protocol.Models.JobSchedulePatchHeaders>> PatchWithHttpMessagesAsync (string jobScheduleId, Microsoft.Azure.Batch.Protocol.Models.JobSchedulePatchParameter jobSchedulePatchParameter, Microsoft.Azure.Batch.Protocol.Models.JobSchedulePatchOptions jobSchedulePatchOptions = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member PatchWithHttpMessagesAsync : string * Microsoft.Azure.Batch.Protocol.Models.JobSchedulePatchParameter * Microsoft.Azure.Batch.Protocol.Models.JobSchedulePatchOptions * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationHeaderResponse<Microsoft.Azure.Batch.Protocol.Models.JobSchedulePatchHeaders>>
Public Function PatchWithHttpMessagesAsync (jobScheduleId As String, jobSchedulePatchParameter As JobSchedulePatchParameter, Optional jobSchedulePatchOptions As JobSchedulePatchOptions = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationHeaderResponse(Of JobSchedulePatchHeaders))

Parameters

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

customHeaders
System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>

The headers that will be added to request.

cancellationToken
System.Threading.CancellationToken

The cancellation token.

Returns

System.Threading.Tasks.Task<AzureOperationHeaderResponse<JobSchedulePatchHeaders>>

Exceptions

Thrown when the operation returned an invalid status code

Thrown when a required parameter is null

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