FileOperationsExtensions.DeleteFromTaskAsync Method

Definition

Namespace:

Microsoft.Azure.Batch.Protocol

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.2.0

Source:

FileOperationsExtensions.cs

Deletes the specified Task file from the Compute Node where the Task ran.

public static System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.FileDeleteFromTaskHeaders> DeleteFromTaskAsync (this Microsoft.Azure.Batch.Protocol.IFileOperations operations, string jobId, string taskId, string filePath, bool? recursive = default, Microsoft.Azure.Batch.Protocol.Models.FileDeleteFromTaskOptions fileDeleteFromTaskOptions = default, System.Threading.CancellationToken cancellationToken = default);

static member DeleteFromTaskAsync : Microsoft.Azure.Batch.Protocol.IFileOperations * string * string * string * Nullable<bool> * Microsoft.Azure.Batch.Protocol.Models.FileDeleteFromTaskOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.FileDeleteFromTaskHeaders>

<Extension()>
Public Function DeleteFromTaskAsync (operations As IFileOperations, jobId As String, taskId As String, filePath As String, Optional recursive As Nullable(Of Boolean) = Nothing, Optional fileDeleteFromTaskOptions As FileDeleteFromTaskOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of FileDeleteFromTaskHeaders)

Parameters

operations

IFileOperations

The operations group for this extension method.

jobId

String

The ID of the Job that contains the Task.

taskId

String

The ID of the Task whose file you want to delete.

filePath

String

The path to the Task file or directory that you want to delete.

recursive

Nullable<Boolean>

Whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail.

fileDeleteFromTaskOptions

FileDeleteFromTaskOptions

Additional parameters for the operation

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<FileDeleteFromTaskHeaders>