File - List From Task

Service:

Batch Service

API Version:

2023-11-01.18.0

Lists the files in a Task's directory on its Compute Node.

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/files?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/files?$filter={$filter}&recursive={recursive}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

URI Parameters

Name	In	Required	Type	Description
batchUrl	path	True	string	The base URL for all Azure Batch service requests.
jobId	path	True	string	The ID of the Job that contains the Task.
taskId	path	True	string	The ID of the Task whose files you want to list.
api-version	query	True	string	Client API Version.
$filter	query		string	An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files.
maxresults	query		integer int32	The maximum number of items to return in the response. A maximum of 1000 files can be returned.
recursive	query		boolean	Whether to list children of the Task directory. This parameter can be used in combination with the filter parameter to list specific type of files.
timeout	query		integer int32	The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.

Request Header

Media Types: "application/json; odata=minimalmetadata"

Name	Required	Type	Description
client-request-id		string uuid	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-rfc1123	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.

Responses

Name	Type	Description
200 OK	NodeFileListResult	A response containing the list of files. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	The error from the Batch service.

Security

azure_auth

Microsoft Entra OAuth 2.0 auth code flow

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

Scopes

Name	Description
user_impersonation	Impersonate your user account

Authorization

Type: apiKey
In: header

Examples

File list from task

Sample Request

HTTP

GET account.region.batch.azure.com/jobs/jobId/tasks/taskId/files?recursive=False&api-version=2023-11-01.18.0

Sample Response

Status code:

200

{
  "value": [
    {
      "name": "startup\\ProcessEnv.cmd",
      "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup\\ProcessEnv.cmd",
      "isDirectory": false,
      "properties": {
        "creationTime": "2014-09-19T21:56:17.679195Z",
        "lastModified": "2014-09-19T21:56:17.679195Z",
        "contentLength": 1813,
        "contentType": "application/octet-stream"
      }
    },
    {
      "name": "startup\\stderr.txt",
      "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup\\stderr.txt",
      "isDirectory": false,
      "properties": {
        "creationTime": "2014-09-19T21:56:17.5590855Z",
        "lastModified": "2014-09-19T21:56:17.5590855Z",
        "contentLength": 0,
        "contentType": "application/octet-stream"
      }
    }
  ]
}

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.
ErrorMessage	An error message received in an Azure Batch error response.
FileProperties	The properties of a file on a Compute Node.
NodeFile	Information about a file or directory on a Compute Node.
NodeFileListResult	The result of listing the files on a Compute Node, or the files associated with a Task on a Compute Node.

BatchError

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	ErrorMessage	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

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.

ErrorMessage

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.

FileProperties

The properties of a file on a Compute Node.

Name	Type	Description
contentLength	integer	The length of the file.
contentType	string	The content type of the file.
creationTime	string	The file creation time. The creation time is not returned for files on Linux Compute Nodes.
fileMode	string	The file mode attribute in octal format. The file mode is returned only for files on Linux Compute Nodes.
lastModified	string	The time at which the file was last modified.

NodeFile

Information about a file or directory on a Compute Node.

Name	Type	Description
isDirectory	boolean	Whether the object represents a directory.
name	string	The file path.
properties	FileProperties	The file properties.
url	string	The URL of the file.

NodeFileListResult

The result of listing the files on a Compute Node, or the files associated with a Task on a Compute Node.

Name	Type	Description
odata.nextLink	string	The URL to get the next set of results.
value	NodeFile[]	The list of files.