IFileOperations.GetFromTaskWithHttpMessagesAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Batch.Protocol

Assembly:: Microsoft.Azure.Batch.dll

Package:: Microsoft.Azure.Batch v16.2.0

Source:: IFileOperations.cs

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.

Returns the content of the specified Task file.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<System.IO.Stream,Microsoft.Azure.Batch.Protocol.Models.FileGetFromTaskHeaders>> GetFromTaskWithHttpMessagesAsync (string jobId, string taskId, string filePath, Microsoft.Azure.Batch.Protocol.Models.FileGetFromTaskOptions fileGetFromTaskOptions = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetFromTaskWithHttpMessagesAsync : string * string * string * Microsoft.Azure.Batch.Protocol.Models.FileGetFromTaskOptions * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<System.IO.Stream, Microsoft.Azure.Batch.Protocol.Models.FileGetFromTaskHeaders>>

Public Function GetFromTaskWithHttpMessagesAsync (jobId As String, taskId As String, filePath As String, Optional fileGetFromTaskOptions As FileGetFromTaskOptions = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of Stream, FileGetFromTaskHeaders))

Parameters

jobId: String

The ID of the Job that contains the Task.

taskId: String

The ID of the Task whose file you want to retrieve.

filePath: String

The path to the Task file that you want to get the content of.

fileGetFromTaskOptions: FileGetFromTaskOptions

Additional parameters for the operation

customHeaders: Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<Stream,FileGetFromTaskHeaders>>

Exceptions

BatchErrorException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

Thrown when a required parameter is null

Applies to

Share via