Skip to content

Commit 7df38e6

Browse files
committed
Additional updates to Azure Batch task event documentation
1 parent 1746985 commit 7df38e6

2 files changed

Lines changed: 40 additions & 4 deletions

File tree

articles/batch/batch-task-complete-event.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,14 @@ ms.date: 01/28/2026
3535
"endTime": "2016-09-08T16:34:00.666Z",
3636
"exitCode": 0,
3737
"retryCount": 0,
38-
"requeueCount": 0
38+
"requeueCount": 0,
39+
"result": "Success",
40+
"schedulingError": {
41+
"category": "",
42+
"code": "",
43+
"message": "",
44+
"details": []
45+
}
3946
}
4047
}
4148
```
@@ -76,7 +83,18 @@ ms.date: 01/28/2026
7683
|Element name|Type|Notes|
7784
|------------------|----------|-----------|
7885
|`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.|
79-
|`endTime`|DateTime|The time when the task completed.|
86+
|`endTime`|DateTime|The time when the task completed. If the task failed before it started running, then exitCode is null.|
8087
|`exitCode`|Int32|The exit code of the task.|
8188
|`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.|
8289
|`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".|
91+
|[`schedulingError`](#schedulingError)|Complex Type|Contain detailed information about error.|
92+
93+
### <a name="schedulingError"></a> schedulingError
94+
95+
|Element name|Type|Notes|
96+
|------------------|----------|-----------|
97+
|`category`|String|The error category, e.g. "UserError".|
98+
|`code`|String|The error code, e.g. "FailureExitCode".|
99+
|`message`|String|The error message.|
100+
|`details`|Array|The error details.|

articles/batch/batch-task-fail-event.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,14 @@ ms.date: 01/28/2026
3535
"endTime": "2016-09-08T16:34:00.666Z",
3636
"exitCode": 1,
3737
"retryCount": 2,
38-
"requeueCount": 0
38+
"requeueCount": 0,
39+
"result": "Failure",
40+
"schedulingError": {
41+
"category": "UserError",
42+
"code": "FailureExitCode",
43+
"message": "The task exited with an exit code representing a failure",
44+
"details": []
45+
}
3946
}
4047
}
4148
```
@@ -78,6 +85,17 @@ ms.date: 01/28/2026
7885
|------------------|----------|-----------|
7986
|`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.|
8087
|`endTime`|DateTime|The time when the task completed.|
81-
|`exitCode`|Int32|The exit code of the task.|
88+
|`exitCode`|Int32|The exit code of the task. If the task failed before it started running, then exitCode is null.|
8289
|`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.|
8390
|`requeueCount`|Int32|The number of times the task is requeued by the Batch service as a result of user request.<br /><br /> When users remove nodes from a pool (by resizing or shrinking it) or disable a job, they can choose to requeue the running tasks on those nodes for execution. This count tracks how many times the task is requeued for these reasons.|
91+
|`result`|String|The task result string, it could be "Success" or "Failure".|
92+
|[`schedulingError`](#schedulingError)|Complex Type|Contain detailed information about error.|
93+
94+
### <a name="schedulingError"></a> schedulingError
95+
96+
|Element name|Type|Notes|
97+
|------------------|----------|-----------|
98+
|`category`|String|The error category, e.g. "UserError".|
99+
|`code`|String|The error code, e.g. "FailureExitCode".|
100+
|`message`|String|The error message.|
101+
|`details`|Array|The error details.|

0 commit comments

Comments
 (0)