terminate_tasks
Creates, updates, deletes, gets or lists a terminate_tasks resource.
Overview
| Name | terminate_tasks |
| Type | Resource |
| Id | azure.batch_dataplane.terminate_tasks |
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 |
|---|---|---|---|---|
terminate_task | exec | job_id, task_id, endpoint | timeOut, ocp-date, If-Modified-Since, If-Unmodified-Since | Terminates the specified Task. When the Task has been terminated, it moves to the completed state. For multi-instance Tasks, the terminate Task operation applies synchronously to the primary task; subtasks are then terminated asynchronously in the background. |
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: ) |
job_id | string | The ID of the Job containing the Task. Required. |
task_id | string | The ID of the Task to terminate. 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. |
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
- terminate_task
Terminates the specified Task. When the Task has been terminated, it moves to the completed state. For multi-instance Tasks, the terminate Task operation applies synchronously to the primary task; subtasks are then terminated asynchronously in the background.
EXEC azure.batch_dataplane.terminate_tasks.terminate_task
@job_id='{{ job_id }}' --required,
@task_id='{{ task_id }}' --required,
@endpoint='{{ endpoint }}' --required,
@timeOut='{{ timeOut }}',
@ocp-date='{{ ocp-date }}',
@If-Modified-Since='{{ If-Modified-Since }}',
@If-Unmodified-Since='{{ If-Unmodified-Since }}'
;