Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The following table lists the metrics available for the Microsoft.Batch/batchaccounts resource type.
Table headings
- Metric - The metric display name as it appears in the Azure portal.
- Name in Rest API - Metric name as referred to in the REST API.
- Advanced platform metrics - A premium, paid tier of platform metrics in Azure Monitor that provide more granular observability for Azure resources.
- Unit - Unit of measure.
- Aggregation - The default aggregation type. Valid values: Average, Minimum, Maximum, Total, Count.
- Dimensions - Dimensions available for the metric.
- Time Grains - Intervals at which the metric is sampled. For example,
PT1Mindicates that the metric is sampled every minute,PT30Mevery 30 minutes,PT1Hevery hour, and so on. - DS Export -S Whether the metric is exportable to Azure Monitor Logs via Diagnostic Settings.
For information on exporting metrics, see - Metrics export using data collection rules and Create diagnostic settings in Azure Monitor.
For information on metric retention, see Azure Monitor Metrics overview.
For a list of supported logs, see Supported log categories - Microsoft.Batch/batchaccounts
Category: API
| Metric | Name in REST API | Advanced platform metrics | Unit | Aggregation | Dimensions | Time Grains | DS Export |
|---|---|---|---|---|---|---|---|
| API Request Count Number of API requests made to the service |
ApiCount |
No | Count | Total (Sum) | operation, result |
PT1M | Yes |
| API Request Duration Duration the server spends handling an API request in milliseconds - measured from the time a request is received to the time a response is sent |
ApiDuration |
No | MilliSeconds | Average | operation, result |
PT1M | Yes |
Category: Resource Allocation
| Metric | Name in REST API | Advanced platform metrics | Unit | Aggregation | Dimensions | Time Grains | DS Export |
|---|---|---|---|---|---|---|---|
| Dedicated Core Count Total number of dedicated cores in the batch account |
CoreCount |
No | Count | Total (Sum) | <none> | PT1M | No |
| Creating Node Count Number of nodes being created |
CreatingNodeCount |
No | Count | Total (Sum) | <none> | PT1M | No |
| Idle Node Count Number of idle nodes |
IdleNodeCount |
No | Count | Total (Sum) | <none> | PT1M | No |
| Leaving Pool Node Count Number of nodes leaving the Pool |
LeavingPoolNodeCount |
No | Count | Total (Sum) | <none> | PT1M | No |
| LowPriority Core Count Total number of low-priority cores in the batch account |
LowPriorityCoreCount |
No | Count | Total (Sum) | <none> | PT1M | No |
| Offline Node Count Number of offline nodes |
OfflineNodeCount |
No | Count | Total (Sum) | <none> | PT1M | No |
| Pool Create Events Total number of pools that have been created |
PoolCreateEvent |
No | Count | Total (Sum) | poolId |
PT1M | Yes |
| Pool Delete Complete Events Total number of pool deletes that have completed |
PoolDeleteCompleteEvent |
No | Count | Total (Sum) | poolId |
PT1M | Yes |
| Pool Delete Start Events Total number of pool deletes that have started |
PoolDeleteStartEvent |
No | Count | Total (Sum) | poolId |
PT1M | Yes |
| Pool Resize Complete Events Total number of pool resizes that have completed |
PoolResizeCompleteEvent |
No | Count | Total (Sum) | poolId |
PT1M | Yes |
| Pool Resize Start Events Total number of pool resizes that have started |
PoolResizeStartEvent |
No | Count | Total (Sum) | poolId |
PT1M | Yes |
| Preempted Node Count Number of preempted nodes |
PreemptedNodeCount |
No | Count | Total (Sum) | <none> | PT1M | No |
| Rebooting Node Count Number of rebooting nodes |
RebootingNodeCount |
No | Count | Total (Sum) | <none> | PT1M | No |
| Reimaging Node Count Number of reimaging nodes |
ReimagingNodeCount |
No | Count | Total (Sum) | <none> | PT1M | No |
| Running Node Count Number of running nodes |
RunningNodeCount |
No | Count | Total (Sum) | <none> | PT1M | No |
| Starting Node Count Number of nodes starting |
StartingNodeCount |
No | Count | Total (Sum) | <none> | PT1M | No |
| Start Task Failed Node Count Number of nodes where the Start Task has failed |
StartTaskFailedNodeCount |
No | Count | Total (Sum) | <none> | PT1M | No |
| Low-Priority Node Count Total number of low-priority nodes in the batch account |
TotalLowPriorityNodeCount |
No | Count | Total (Sum) | <none> | PT1M | No |
| Dedicated Node Count Total number of dedicated nodes in the batch account |
TotalNodeCount |
No | Count | Total (Sum) | <none> | PT1M | No |
| Unknown State Node Count Number of unknown state nodes |
UnknownStateNodeCount |
No | Count | Total (Sum) | <none> | PT1M | No |
| Unusable Node Count Number of unusable nodes |
UnusableNodeCount |
No | Count | Total (Sum) | <none> | PT1M | No |
| Waiting For Start Task Node Count Number of nodes waiting for the Start Task to complete |
WaitingForStartTaskNodeCount |
No | Count | Total (Sum) | <none> | PT1M | No |
Category: Scheduling
| Metric | Name in REST API | Advanced platform metrics | Unit | Aggregation | Dimensions | Time Grains | DS Export |
|---|---|---|---|---|---|---|---|
| Job Delete Complete Events Total number of jobs that have been successfully deleted. |
JobDeleteCompleteEvent |
No | Count | Total (Sum) | jobId |
PT1M | Yes |
| Job Delete Start Events Total number of jobs that have been requested to be deleted. |
JobDeleteStartEvent |
No | Count | Total (Sum) | jobId |
PT1M | Yes |
| Job Disable Complete Events Total number of jobs that have been successfully disabled. |
JobDisableCompleteEvent |
No | Count | Total (Sum) | jobId |
PT1M | Yes |
| Job Disable Start Events Total number of jobs that have been requested to be disabled. |
JobDisableStartEvent |
No | Count | Total (Sum) | jobId |
PT1M | Yes |
| Job Start Events Total number of jobs that have been successfully started. |
JobStartEvent |
No | Count | Total (Sum) | jobId |
PT1M | Yes |
| Job Terminate Complete Events Total number of jobs that have been successfully terminated. |
JobTerminateCompleteEvent |
No | Count | Total (Sum) | jobId |
PT1M | Yes |
| Job Terminate Start Events Total number of jobs that have been requested to be terminated. |
JobTerminateStartEvent |
No | Count | Total (Sum) | jobId |
PT1M | Yes |
| Task Complete Events Total number of tasks that have completed |
TaskCompleteEvent |
No | Count | Total (Sum) | poolId, jobId |
PT1M | Yes |
| Task Fail Events Total number of tasks that have completed in a failed state |
TaskFailEvent |
No | Count | Total (Sum) | poolId, jobId |
PT1M | Yes |
| Task Requeue Events Total number of tasks that got requeued |
TaskRequeueEvent |
No | Count | Total (Sum) | poolId, jobId |
PT1M | Yes |
| Task Schedule Fail Events Total number of tasks failed to schedule |
TaskScheduleFailEvent |
No | Count | Total (Sum) | poolId, jobId |
PT1M | Yes |
| Task Start Events Total number of tasks that have started |
TaskStartEvent |
No | Count | Total (Sum) | poolId, jobId |
PT1M | Yes |