CloudTask.ListNodeFiles Method

Definition

Namespace:

Microsoft.Azure.Batch

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.3.1

Source:

CloudTask.cs

Enumerates the files in the CloudTask's directory on its compute node.

public Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.NodeFile> ListNodeFiles (bool? recursive = default, Microsoft.Azure.Batch.DetailLevel detailLevel = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);

member this.ListNodeFiles : Nullable<bool> * Microsoft.Azure.Batch.DetailLevel * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> Microsoft.Azure.Batch.IPagedEnumerable<Microsoft.Azure.Batch.NodeFile>

Public Function ListNodeFiles (Optional recursive As Nullable(Of Boolean) = Nothing, Optional detailLevel As DetailLevel = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing) As IPagedEnumerable(Of NodeFile)

Parameters

recursive

Nullable<Boolean>

If true, performs a recursive list of all files of the task. If false, returns only the files in the root task directory.

detailLevel

DetailLevel

A DetailLevel used for filtering the list and for controlling which properties are retrieved from the service.

additionalBehaviors

IEnumerable<BatchClientBehavior>

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

Returns

IPagedEnumerable<NodeFile>

An IPagedEnumerable<T> that can be used to enumerate files asynchronously or synchronously.

Remarks

This method returns immediately; the file data is retrieved from the Batch service only when the collection is enumerated. Retrieval is non-atomic; file data is retrieved in pages during enumeration of the collection.