PoolOperations.GetNodeFile Method

Definition

Gets information about a file on a compute node.

public Microsoft.Azure.Batch.NodeFile GetNodeFile (string poolId, string computeNodeId, string filePath, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);
member this.GetNodeFile : string * string * string * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> Microsoft.Azure.Batch.NodeFile
Public Function GetNodeFile (poolId As String, computeNodeId As String, filePath As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing) As 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.

Returns

A NodeFile containing information about the file, and which can be used to download the file (see CopyToStream(Stream, GetFileRequestByteRange, IEnumerable<BatchClientBehavior>)).

Remarks

This is a blocking operation. For a non-blocking equivalent, see GetNodeFileAsync(String, String, String, IEnumerable<BatchClientBehavior>, CancellationToken).

Applies to