FileOperationsExtensions.DeleteFromComputeNodeAsync Method

Definition

Namespace:

Microsoft.Azure.Batch.Protocol

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.3.1

Source:

FileOperationsExtensions.cs

Deletes the specified file from the Compute Node.

public static System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.FileDeleteFromComputeNodeHeaders> DeleteFromComputeNodeAsync (this Microsoft.Azure.Batch.Protocol.IFileOperations operations, string poolId, string nodeId, string filePath, bool? recursive = default, Microsoft.Azure.Batch.Protocol.Models.FileDeleteFromComputeNodeOptions fileDeleteFromComputeNodeOptions = default, System.Threading.CancellationToken cancellationToken = default);

static member DeleteFromComputeNodeAsync : Microsoft.Azure.Batch.Protocol.IFileOperations * string * string * string * Nullable<bool> * Microsoft.Azure.Batch.Protocol.Models.FileDeleteFromComputeNodeOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.Protocol.Models.FileDeleteFromComputeNodeHeaders>

<Extension()>
Public Function DeleteFromComputeNodeAsync (operations As IFileOperations, poolId As String, nodeId As String, filePath As String, Optional recursive As Nullable(Of Boolean) = Nothing, Optional fileDeleteFromComputeNodeOptions As FileDeleteFromComputeNodeOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of FileDeleteFromComputeNodeHeaders)

Parameters

operations

IFileOperations

The operations group for this extension method.

poolId

String

The ID of the Pool that contains the Compute Node.

nodeId

String

The ID of the Compute Node from which you want to delete the file.

filePath

String

The path to the 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.

fileDeleteFromComputeNodeOptions

FileDeleteFromComputeNodeOptions

Additional parameters for the operation

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<FileDeleteFromComputeNodeHeaders>