TaskOperationsExtensions.Delete Method

Reference

Definition

Namespace:: Microsoft.Azure.Batch.Protocol

Assembly:: Microsoft.Azure.Batch.dll

Package:: Microsoft.Azure.Batch v16.3.1

Source:: TaskOperationsExtensions.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.

Deletes a Task from the specified Job.

public static Microsoft.Azure.Batch.Protocol.Models.TaskDeleteHeaders Delete (this Microsoft.Azure.Batch.Protocol.ITaskOperations operations, string jobId, string taskId, Microsoft.Azure.Batch.Protocol.Models.TaskDeleteOptions taskDeleteOptions = default);

static member Delete : Microsoft.Azure.Batch.Protocol.ITaskOperations * string * string * Microsoft.Azure.Batch.Protocol.Models.TaskDeleteOptions -> Microsoft.Azure.Batch.Protocol.Models.TaskDeleteHeaders

<Extension()>
Public Function Delete (operations As ITaskOperations, jobId As String, taskId As String, Optional taskDeleteOptions As TaskDeleteOptions = Nothing) As TaskDeleteHeaders

Parameters

operations: ITaskOperations

The operations group for this extension method.

jobId: String

The ID of the Job from which to delete the Task.

taskId: String

The ID of the Task to delete.

taskDeleteOptions: TaskDeleteOptions

Additional parameters for the operation

Returns

TaskDeleteHeaders

Remarks

When a Task is deleted, all of the files in its directory on the Compute Node where it ran are also deleted (regardless of the retention time). For multi-instance Tasks, the delete Task operation applies synchronously to the primary task; subtasks and their files are then deleted asynchronously in the background.

Applies to

Share via