download_task_files
Creates, updates, deletes, gets or lists a download_task_files resource.
Overview
| Name | download_task_files |
| Type | Resource |
| Id | azure.batch_dataplane.download_task_files |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
download_task_file | exec | job_id, task_id, file_path, endpoint | timeOut, ocp-date, If-Modified-Since, If-Unmodified-Since, ocp-range | Returns the content of the specified Task file. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
endpoint | string | The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: ) |
file_path | string | The path to the Task file that you want to get the content of. Required. |
job_id | string | The ID of the Job that contains the Task. Required. |
task_id | string | The ID of the Task whose file you want to retrieve. Required. |
If-Modified-Since | string | 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. Default value is None. |
If-Unmodified-Since | string | 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. Default value is None. |
ocp-date | string | 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. Default value is None. |
ocp-range | string | The byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange. Default value is None. |
timeOut | integer | 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.". Default value is None. |
Lifecycle Methods
- download_task_file
Returns the content of the specified Task file.
EXEC azure.batch_dataplane.download_task_files.download_task_file
@job_id='{{ job_id }}' --required,
@task_id='{{ task_id }}' --required,
@file_path='{{ file_path }}' --required,
@endpoint='{{ endpoint }}' --required,
@timeOut='{{ timeOut }}',
@ocp-date='{{ ocp-date }}',
@If-Modified-Since='{{ If-Modified-Since }}',
@If-Unmodified-Since='{{ If-Unmodified-Since }}',
@ocp-range='{{ ocp-range }}'
;