PoolOperations.DeleteNodeFileAsync(String, String, String, Nullable<Boolean>, IEnumerable<BatchClientBehavior>, CancellationToken) Method

Definition

Deletes the specified file from the specified compute node.

public System.Threading.Tasks.Task DeleteNodeFileAsync (string poolId, string computeNodeId, string filePath, Nullable<bool> recursive = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);
member this.DeleteNodeFileAsync : string * string * string * Nullable<bool> * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Parameters

poolId
String

The id of the pool that contains the compute node.

computeNodeId
String

The id of the compute node.

filePath
String

The path of the file to delete.

recursive
Nullable<Boolean>

If the file-path parameter represents a directory instead of a file, you can set the optional recursive parameter 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.

additionalBehaviors
IEnumerable<BatchClientBehavior>

A collection of BatchClientBehavior instances that are applied to the Batch service request after the CustomBehaviors.

cancellationToken
CancellationToken

A CancellationToken for controlling the lifetime of the asynchronous operation.

Returns

A Task that represents the asynchronous operation.

Remarks

The delete operation runs asynchronously.

Applies to