PoolOperations.CopyNodeFileContentToStreamAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Copies the contents of a file from the specified node to the given Stream.
public System.Threading.Tasks.Task CopyNodeFileContentToStreamAsync (string poolId, string computeNodeId, string filePath, System.IO.Stream stream, Microsoft.Azure.Batch.GetFileRequestByteRange byteRange = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);member this.CopyNodeFileContentToStreamAsync : string * string * string * System.IO.Stream * Microsoft.Azure.Batch.GetFileRequestByteRange * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Function CopyNodeFileContentToStreamAsync (poolId As String, computeNodeId As String, filePath As String, stream As Stream, Optional byteRange As GetFileRequestByteRange = Nothing, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As TaskParameters
- 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.
- stream
- Stream
The stream to copy the file contents to.
- 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.
- cancellationToken
- CancellationToken
A CancellationToken for controlling the lifetime of the asynchronous operation.
Returns
Remarks
The get file operation runs asynchronously.
