Partager via

File - Get Properties From Task

  • Reference
Service:
Batch Service
API Version:
2024-07-01.20.0

Gets the properties of the specified Task file.

HEAD {batchUrl}/jobs/{jobId}/tasks/{taskId}/files/{filePath}?api-version=2024-07-01.20.0
With optional parameters: 
HEAD {batchUrl}/jobs/{jobId}/tasks/{taskId}/files/{filePath}?timeout={timeout}&api-version=2024-07-01.20.0

URI Parameters

Name In Required Type Description
batchUrl
 path True

string

The base URL for all Azure Batch service requests.
filePath
 path True

string

The path to the Task file that you want to get the properties 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 get the properties of.
api-version
 query True

string

Client API Version.
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

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

string

date-time-rfc1123

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

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.

Responses

Name Type Description
200 OK

A response containing the file properties.

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • ocp-creation-time: string
  • ocp-batch-file-isdirectory: boolean
  • ocp-batch-file-url: string
  • ocp-batch-file-mode: string
  • Content-Type: string
  • Content-Length: integer
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 get properties from task

Sample request

HEAD account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/wd\testFile.txt?api-version=2024-07-01.20.0

Sample response

Status code:
200

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.

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.