Share via

Tasks - Get Task File

Service:
Batch Service
API Version:
2025-06-01

Returns the content of the specified Task file.

GET {endpoint}/jobs/{jobId}/tasks/{taskId}/files/{filePath}?api-version=2025-06-01
With optional parameters: 
GET {endpoint}/jobs/{jobId}/tasks/{taskId}/files/{filePath}?api-version=2025-06-01&timeOut={timeOut}

URI Parameters

Name In Required Type Description
endpoint
 path True

string (uri)

Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com).
filePath
 path True

string

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

string

The ID of the Job that contains the Task.
taskId
 path True

string

The ID of the Task whose file you want to retrieve.
api-version
 query True

string

minLength: 1

The API version to use for this operation.
timeOut
 query

integer (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.".

Request Header

Name Required Type Description
client-request-id

string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Whether the server should return the client-request-id in the response.
ocp-date

string (date-time-rfc7231)

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.
If-Modified-Since

string (date-time-rfc7231)

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
If-Unmodified-Since

string (date-time-rfc7231)

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
ocp-range

string

The byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange.

Responses

Name Type Description
200 OK

file

The request has succeeded.

Media Types: "application/octet-stream", "application/json"

Headers

  • Content-Length: string
  • ETag: string
  • Last-Modified: string
  • client-request-id: string
  • ocp-batch-file-isdirectory: boolean
  • ocp-batch-file-mode: string
  • ocp-batch-file-url: string
  • ocp-creation-time: string
  • request-id: string
Other Status Codes

BatchError

An unexpected error response.

Media Types: "application/octet-stream", "application/json"

Security

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Scopes

Name Description
https://batch.core.windows.net//.default

Examples

Get File From Task

Sample request

GET {endpoint}/jobs/jobId/tasks/task1/files/wd\testFile.txt?api-version=2025-06-01

Sample response

Status code:
200 
"This is actually a byte stream. This request/response is being presented as a string for readability in the example"

Definitions

Name Description
BatchError

An error response received from the Azure Batch service.
BatchErrorDetail

An item of additional information included in an Azure Batch error response.
BatchErrorMessage

An error message received in an Azure Batch error response.

BatchError

Object

An error response received from the Azure Batch service.

Name Type Description
code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
message

BatchErrorMessage

A message describing the error, intended to be suitable for display in a user interface.
values

BatchErrorDetail[]

A collection of key-value pairs containing additional details about the error.

BatchErrorDetail

Object

An item of additional information included in an Azure Batch error response.

Name Type Description
key

string

An identifier specifying the meaning of the Value property.
value

string

The additional information included with the error response.

BatchErrorMessage

Object

An error message received in an Azure Batch error response.

Name Type Description
lang

string

The language code of the error message.
value

string

The text of the message.