BatchJobStatistics interface

Package:

@azure/batch

Resource usage statistics for a Job.

Properties

failedTasksCount	The total number of Tasks in the Job that failed during the given time range. A Task fails if it exhausts its maximum retry count without returning exit code 0.
kernelCpuTime	The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job. The time duration is specified in ISO 8601 format.
lastUpdateTime	The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime.
readIoGiB	The total amount of data in GiB read from disk by all Tasks in the Job.
readIops	The total number of disk read operations made by all Tasks in the Job.
startTime	The start time of the time range covered by the statistics.
succeededTasksCount	The total number of Tasks successfully completed in the Job during the given time range. A Task completes successfully if it returns exit code 0.
taskRetriesCount	The total number of retries on all the Tasks in the Job during the given time range.
url	The URL of the statistics.
userCpuTime	The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job. The time duration is specified in ISO 8601 format.
waitTime	The total wait time of all Tasks in the Job. The wait time for a Task is defined as the elapsed time between the creation of the Task and the start of Task execution. (If the Task is retried due to failures, the wait time is the time to the most recent Task execution.) This value is only reported in the Account lifetime statistics; it is not included in the Job statistics. The time duration is specified in ISO 8601 format.
wallClockTime	The total wall clock time of all Tasks in the Job. The wall clock time is the elapsed time from when the Task started running on a Compute Node to when it finished (or to the last time the statistics were updated, if the Task had not finished by then). If a Task was retried, this includes the wall clock time of all the Task retries. The time duration is specified in ISO 8601 format.
writeIoGiB	The total amount of data in GiB written to disk by all Tasks in the Job.
writeIops	The total number of disk write operations made by all Tasks in the Job.

Property Details

failedTasksCount

The total number of Tasks in the Job that failed during the given time range. A Task fails if it exhausts its maximum retry count without returning exit code 0.

failedTasksCount: string

Property Value

string

kernelCpuTime

The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job. The time duration is specified in ISO 8601 format.

kernelCpuTime: string

Property Value

string

lastUpdateTime

The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime.

lastUpdateTime: Date

Property Value

Date

readIoGiB

The total amount of data in GiB read from disk by all Tasks in the Job.

readIoGiB: number

Property Value

number

readIops

The total number of disk read operations made by all Tasks in the Job.

readIops: string

Property Value

string

startTime

The start time of the time range covered by the statistics.

startTime: Date

Property Value

Date

succeededTasksCount

The total number of Tasks successfully completed in the Job during the given time range. A Task completes successfully if it returns exit code 0.

succeededTasksCount: string

Property Value

string

taskRetriesCount

The total number of retries on all the Tasks in the Job during the given time range.

taskRetriesCount: string

Property Value

string

url

The URL of the statistics.

url: string

Property Value

string

userCpuTime

The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job. The time duration is specified in ISO 8601 format.

userCpuTime: string

Property Value

string

waitTime

The total wait time of all Tasks in the Job. The wait time for a Task is defined as the elapsed time between the creation of the Task and the start of Task execution. (If the Task is retried due to failures, the wait time is the time to the most recent Task execution.) This value is only reported in the Account lifetime statistics; it is not included in the Job statistics. The time duration is specified in ISO 8601 format.

waitTime: string

Property Value

string

wallClockTime

The total wall clock time of all Tasks in the Job. The wall clock time is the elapsed time from when the Task started running on a Compute Node to when it finished (or to the last time the statistics were updated, if the Task had not finished by then). If a Task was retried, this includes the wall clock time of all the Task retries. The time duration is specified in ISO 8601 format.

wallClockTime: string

Property Value

string

writeIoGiB

The total amount of data in GiB written to disk by all Tasks in the Job.

writeIoGiB: number

Property Value

number

writeIops

The total number of disk write operations made by all Tasks in the Job.

writeIops: string

Property Value

string