TaskOperationsExtensions.UpdateAsync Method

Definition

Namespace:

Microsoft.Azure.Batch.Protocol

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.2.0

Source:

TaskOperationsExtensions.cs

Updates the properties of the specified Task.

public static System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.TaskUpdateHeaders> UpdateAsync (this Microsoft.Azure.Batch.Protocol.ITaskOperations operations, string jobId, string taskId, Microsoft.Azure.Batch.Protocol.Models.TaskConstraints constraints = default, Microsoft.Azure.Batch.Protocol.Models.TaskUpdateOptions taskUpdateOptions = default, System.Threading.CancellationToken cancellationToken = default);

static member UpdateAsync : Microsoft.Azure.Batch.Protocol.ITaskOperations * string * string * Microsoft.Azure.Batch.Protocol.Models.TaskConstraints * Microsoft.Azure.Batch.Protocol.Models.TaskUpdateOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.TaskUpdateHeaders>

<Extension()>
Public Function UpdateAsync (operations As ITaskOperations, jobId As String, taskId As String, Optional constraints As TaskConstraints = Nothing, Optional taskUpdateOptions As TaskUpdateOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of TaskUpdateHeaders)

Parameters

operations

ITaskOperations

The operations group for this extension method.

jobId

String

The ID of the Job containing the Task.

taskId

String

The ID of the Task to update.

constraints

TaskConstraints

Constraints that apply to this Task. If omitted, the Task is given the default constraints. For multi-instance Tasks, updating the retention time applies only to the primary Task and not subtasks.

taskUpdateOptions

TaskUpdateOptions

Additional parameters for the operation

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<TaskUpdateHeaders>