PoolOperations.GetNodeFileAsync Method

Definition

Gets information about a file on a compute node.

public System.Threading.Tasks.Task<Microsoft.Azure.Batch.NodeFile> GetNodeFileAsync (string poolId, string computeNodeId, string filePath, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);
member this.GetNodeFileAsync : string * string * string * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.NodeFile>
Public Function GetNodeFileAsync (poolId As String, computeNodeId As String, filePath As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NodeFile)

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 retrieve.

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 NodeFile containing information about the file, and which can be used to download the file (see CopyToStreamAsync(Stream, GetFileRequestByteRange, IEnumerable<BatchClientBehavior>, CancellationToken)).

Remarks

The get file operation runs asynchronously.

Applies to