PoolOperations.CopyNodeFileContentToString(String, String, String, Encoding, GetFileRequestByteRange, IEnumerable<BatchClientBehavior>) Method

Definition

Reads the contents of a file from the specified node into a string.

public string CopyNodeFileContentToString (string poolId, string computeNodeId, string filePath, System.Text.Encoding encoding = default, Microsoft.Azure.Batch.GetFileRequestByteRange byteRange = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);
member this.CopyNodeFileContentToString : string * string * string * System.Text.Encoding * Microsoft.Azure.Batch.GetFileRequestByteRange * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> string

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.

encoding
Encoding

The encoding to use. If no value or null is specified, UTF8 is used.

byteRange
GetFileRequestByteRange

A byte range defining what section of the file to copy. If omitted, the entire file is downloaded.

additionalBehaviors
IEnumerable<BatchClientBehavior>

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

Returns

The contents of the file, as a string

Applies to