FileOperationsExtensions.ListFromTaskAsync Method

Definition

Namespace:

Microsoft.Azure.Batch.Protocol

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.2.0

Source:

FileOperationsExtensions.cs

Lists the files in a Task's directory on its Compute Node.

public static System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Batch.Protocol.Models.NodeFile>> ListFromTaskAsync (this Microsoft.Azure.Batch.Protocol.IFileOperations operations, string jobId, string taskId, bool? recursive = default, Microsoft.Azure.Batch.Protocol.Models.FileListFromTaskOptions fileListFromTaskOptions = default, System.Threading.CancellationToken cancellationToken = default);

static member ListFromTaskAsync : Microsoft.Azure.Batch.Protocol.IFileOperations * string * string * Nullable<bool> * Microsoft.Azure.Batch.Protocol.Models.FileListFromTaskOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Batch.Protocol.Models.NodeFile>>

<Extension()>
Public Function ListFromTaskAsync (operations As IFileOperations, jobId As String, taskId As String, Optional recursive As Nullable(Of Boolean) = Nothing, Optional fileListFromTaskOptions As FileListFromTaskOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IPage(Of NodeFile))

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 files you want to list.

recursive

Nullable<Boolean>

Whether to list children of the Task directory. This parameter can be used in combination with the filter parameter to list specific type of files.

fileListFromTaskOptions

FileListFromTaskOptions

Additional parameters for the operation

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<IPage<NodeFile>>