IJobOperations.UpdateWithHttpMessagesAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Batch.Protocol

Assembly:: Microsoft.Azure.Batch.dll

Package:: Microsoft.Azure.Batch v16.2.0

Source:: IJobOperations.cs

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.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationHeaderResponse<Microsoft.Azure.Batch.Protocol.Models.JobUpdateHeaders>> UpdateWithHttpMessagesAsync (string jobId, Microsoft.Azure.Batch.Protocol.Models.JobUpdateParameter jobUpdateParameter, Microsoft.Azure.Batch.Protocol.Models.JobUpdateOptions jobUpdateOptions = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member UpdateWithHttpMessagesAsync : string * Microsoft.Azure.Batch.Protocol.Models.JobUpdateParameter * Microsoft.Azure.Batch.Protocol.Models.JobUpdateOptions * 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.JobUpdateHeaders>>

Public Function UpdateWithHttpMessagesAsync (jobId As String, jobUpdateParameter As JobUpdateParameter, Optional jobUpdateOptions As JobUpdateOptions = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationHeaderResponse(Of JobUpdateHeaders))

Parameters

jobId: String

The ID of the Job whose properties you want to update.

jobUpdateParameter: JobUpdateParameter

The parameters for the request.

jobUpdateOptions: JobUpdateOptions

Additional parameters for the operation

customHeaders: Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<AzureOperationHeaderResponse<JobUpdateHeaders>>

Exceptions

BatchErrorException

Thrown when the operation returned an invalid status code

ValidationException

Thrown when a required parameter is null

Remarks

This fully replaces all the updatable properties of the Job. For example, if the Job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.

Applies to