CloudTask.GetNodeFileAsync Method

Definition

Namespace:

Microsoft.Azure.Batch

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.2.0

Source:

CloudTask.cs

Gets the specified NodeFile from the CloudTask's directory on its compute node.

public System.Threading.Tasks.Task<Microsoft.Azure.Batch.NodeFile> GetNodeFileAsync (string filePath, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);

member this.GetNodeFileAsync : string * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Batch.NodeFile>

Public Function GetNodeFileAsync (filePath As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NodeFile)

Parameters

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

Task<NodeFile>

A NodeFile representing the specified file.

Remarks

The get file operation runs asynchronously.