Task fail event

This event is emitted when a task completes with a failure. Currently all nonzero exit codes are considered failures. This event is emitted in addition to a task complete event and can be used to detect when a task fails.

The following example shows the body of a task fail event.

{
    "jobId": "myJob",
    "id": "myTask",
    "taskType": "User",
    "systemTaskVersion": 0,
    "requiredSlots": 1,
    "nodeInfo": {
        "poolId": "pool-001",
        "nodeId": "tvm-257509324_1-20160908t162728z"
    },
    "multiInstanceSettings": {
        "numberOfInstances": 1
    },
    "constraints": {
        "maxTaskRetryCount": 2
    },
    "executionInfo": {
        "startTime": "2016-09-08T16:32:23.799Z",
        "endTime": "2016-09-08T16:34:00.666Z",
        "exitCode": 1,
        "retryCount": 2,
        "requeueCount": 0,
        "result": "Failure",
        "schedulingError": {
            "category": "UserError",
            "code": "FailureExitCode",
            "message": "The task exited with an exit code representing a failure",
            "details": []
        }
    }
}

Element name	Type	Notes
jobId	String	The ID of the job containing the task.
id	String	The ID of the task.
taskType	String	The type of the task. It's either 'JobManager' indicating it's a job manager task or 'User' indicating it's not a job manager task. This event isn't emitted for job preparation tasks, job release tasks, or start tasks.
systemTaskVersion	Int32	It's the internal retry counter on a task. Internally the Batch service can retry a task to account for transient issues. These issues can include internal scheduling errors or attempts to recover from compute nodes in a bad state.
requiredSlots	Int32	The required slots to run the task.
nodeInfo	Complex Type	Contains information about the compute node on which the task ran.
multiInstanceSettings	Complex Type	Specifies that the task is a Multi-Instance Task requiring multiple compute nodes. See multiInstanceSettings for details.
constraints	Complex Type	The execution constraints that apply to this task.
executionInfo	Complex Type	Contains information about the execution of the task.

nodeInfo

Element name	Type	Notes
poolId	String	The ID of the pool on which the task ran.
nodeId	String	The ID of the node on which the task ran.

multiInstanceSettings

Element name	Type	Notes
numberOfInstances	Int32	The number of compute nodes required by the task.

constraints

Element name	Type	Notes
maxTaskRetryCount	Int32	The maximum number of times the task might be retried. The Batch service retries a task if its exit code is nonzero. This value specifically controls the number of retries. The Batch service tries the task once, and might then retry up to this limit. For example, if the maximum retry count is 3, Batch tries a task up to four times (one initial try and three retries). If the maximum retry count is 0, the Batch service doesn't retry tasks. If the maximum retry count is -1, the Batch service retries tasks without limit. The default value is 0 (no retries).

executionInfo

Element name	Type	Notes
startTime	DateTime	The time when the task started running. 'Running' corresponds to the running state, so if the task specifies resource files or application packages, then the start time reflects the time at which the task started downloading or deploying them. If the task is restarted or retried, it's the most recent time at which the task started running.
endTime	DateTime	The time when the task completed.
exitCode	Int32	The exit code of the task. If the task failed before it started running, then exitCode is null.
retryCount	Int32	The number of times the Batch service retried the task. The task is retried if it exits with a nonzero exit code, up to the specified MaxTaskRetryCount.
requeueCount	Int32	The number of times the Batch service requeued the task as a result of user request. When nodes are removed from a pool (through resizing or shrinking) or a job is disabled, you can choose to requeue the running tasks on those nodes. This count tracks how many times a task was requeued for these reasons.
result	String	The task result string, it could be "Success" or "Failure".
schedulingError	Complex Type	Contains detailed information about the error.

schedulingError

Element name	Type	Notes
category	String	The error category, for example "UserError".
code	String	The error code, for example "FailureExitCode".
message	String	The error message.
details	Array	The error details.