Share via


BatchClient.GetNodeFilePropertiesAsync Method

Definition

[Protocol Method] Gets the properties of the specified Compute Node file.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Compute.Batch.BatchFileProperties>> GetNodeFilePropertiesAsync (string poolId, string nodeId, string filePath, int? timeOutInSeconds = default, DateTimeOffset? ocpdate = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetNodeFilePropertiesAsync : string * string * string * Nullable<int> * Nullable<DateTimeOffset> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Compute.Batch.BatchFileProperties>>
override this.GetNodeFilePropertiesAsync : string * string * string * Nullable<int> * Nullable<DateTimeOffset> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Compute.Batch.BatchFileProperties>>
Public Overridable Function GetNodeFilePropertiesAsync (poolId As String, nodeId As String, filePath As String, Optional timeOutInSeconds As Nullable(Of Integer) = Nothing, Optional ocpdate As Nullable(Of DateTimeOffset) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of BatchFileProperties))

Parameters

poolId
String

The ID of the Pool that contains the Compute Node.

nodeId
String

The ID of the Compute Node.

filePath
String

The path to the file or directory.

timeOutInSeconds
Nullable<Int32>

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".

ocpdate
Nullable<DateTimeOffset>

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

The response returned from the service.

Exceptions

poolId, nodeId or filePath is null.

poolId, nodeId or filePath is an empty string, and was expected to be non-empty.

Service returned a non-success status code.

Applies to