You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/batch/batch-task-complete-event.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,7 +51,7 @@ ms.date: 01/29/2026
51
51
|------------------|----------|-----------|
52
52
|`jobId`|String|The ID of the job containing the task.|
53
53
|`id`|String|The ID of the task.|
54
-
|`taskType`|String|The type of the task. This can either be 'JobManager' indicating it's a job manager task or 'User' indicating it isn't a job manager task. Note that this event isn't emitted for job preparation tasks, job release tasks, or start tasks.|
54
+
|`taskType`|String|The type of the task. The task type can either be 'JobManager' indicating it's a job manager task or 'User' indicating it isn't a job manager task. This event isn't emitted for job preparation tasks, job release tasks, or start tasks.|
55
55
|`systemTaskVersion`|Int32|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.|
56
56
|`requiredSlots`|Int32|The required slots to run the task.|
57
57
|[`nodeInfo`](#nodeInfo)|Complex Type|Contains information about the compute node on which the task ran.|
@@ -76,25 +76,25 @@ ms.date: 01/29/2026
76
76
77
77
|Element name|Type|Notes|
78
78
|------------------|----------|-----------|
79
-
|`maxTaskRetryCount`|Int32|The maximum number of times the task may be retried. The Batch service retries a task if its exit code is nonzero.<br /><br /> This value specifically controls the number of retries. The Batch service tries the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries a task up to 4 times (one initial try and 3 retries).<br /><br /> If the maximum retry count is 0, the Batch service doesn't retry tasks.<br /><br /> If the maximum retry count is -1, the Batch service retries tasks without limit.<br /><br /> The default value is 0 (no retries).|
79
+
|`maxTaskRetryCount`|Int32|The maximum number of times the task might be retried. The Batch service retries a task if its exit code is nonzero.<br /><br /> 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).<br /><br /> If the maximum retry count is 0, the Batch service doesn't retry tasks.<br /><br /> If the maximum retry count is -1, the Batch service retries tasks without limit.<br /><br /> The default value is 0 (no retries).|
80
80
81
81
### <aname="executionInfo"></a> executionInfo
82
82
83
83
|Element name|Type|Notes|
84
84
|------------------|----------|-----------|
85
-
|`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 when the task started downloading or deploying these. If the task restarted or retried, this is the most recent time at which the task started running.|
85
+
|`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 when the task started downloading or deploying these resource files or application packages. If the task restarted or retried, this is the most recent time at which the task started running.|
86
86
|`endTime`|DateTime|The time when the task completed.|
87
-
|`exitCode`|Int32|The exit code of the task. If the task failed before it started running, then exitCode is null.|
88
-
|`retryCount`|Int32|The number of times the task is retried by the Batch service. The task is retried if it exits with a nonzero exit code, up to the specified MaxTaskRetryCount.|
89
-
|`requeueCount`|Int32|The number of times the task is requeued by the Batch service as the result of a user request.<br /><br /> When you remove nodes from a pool (by resizing or shrinking it) or disable a job, you can choose to requeue the running tasks on those nodes for execution. This count tracks how many times the task requeued for these reasons.|
90
-
|`result`|String|The task result string, it could be "Success" or "Failure".|
87
+
|`exitCode`|Int32|The exit code of the task. If the task failed before it started running, then exitCode is null.|
88
+
|`retryCount`|Int32|The number of times the Batch service retired the task. The task is retried if it exits with a nonzero exit code, up to the specified MaxTaskRetryCount.|
89
+
|`requeueCount`|Int32|The number of times the Batch service requeued the task as the result of a user request.<br /><br /> When you remove nodes from a pool (by resizing or shrinking it) or disable a job, you can choose to requeue the running tasks on those nodes for execution. It count tracks how many times the task requeued.|
90
+
|`result`|String|The task result string, it could be "Success" or "Failure"|
91
91
|[`schedulingError`](#schedulingError)|Complex Type|Contain detailed information about error.|
92
92
93
93
### <aname="schedulingError"></a> schedulingError
94
94
95
95
|Element name|Type|Notes|
96
96
|------------------|----------|-----------|
97
-
|`category`|String|The error category, e.g. "UserError".|
98
-
|`code`|String|The error code, e.g. "FailureExitCode".|
97
+
|`category`|String|The error category, for example "UserError".|
98
+
|`code`|String|The error code, for example "FailureExitCode".|
0 commit comments