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/azure-monitor/alerts/alerts-common-schema.md
+9-6Lines changed: 9 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,13 +24,14 @@ The new schema enables a richer alert consumption experience across both the Azu
24
24
> [!NOTE]
25
25
> Alerts generated by [VM insights](../vm/vminsights-overview.md) do not support the common schema.
26
26
27
+
## Structure of the common schema
28
+
27
29
The common schema includes information about the affected resource and the cause of the alert in these sections:
28
30
-**Essentials**: Standardized fields, used by all alert types that describe the resource affected by the alert and common alert metadata, such as severity or description.
29
31
30
32
If you want to route alert instances to specific teams based on criteria such as a resource group, you can use the fields in the **Essentials** section to provide routing logic for all alert types. The teams that receive the alert notification can then use the context fields for their investigation.
31
33
-**Alert context**: Fields that vary depending on the type of the alert. The alert context fields describe the cause of the alert. For example, a metric alert would have fields like the metric name and metric value in the alert context. An activity log alert would have information about the event that generated the alert.
32
34
33
-
34
35
## Sample alert payload
35
36
36
37
```json
@@ -84,7 +85,7 @@ The common schema includes information about the affected resource and the cause
84
85
}
85
86
```
86
87
87
-
## Essentials
88
+
## Essentials fields
88
89
89
90
| Field | Description|
90
91
|:---|:---|
@@ -104,7 +105,7 @@ The common schema includes information about the affected resource and the cause
104
105
|alertContextVersion | The version number for the `alertContext` section. |
105
106
106
107
107
-
## Alert context for metric alerts
108
+
## Alert context fields for metric alerts
108
109
109
110
### Sample metric alert with a static threshold and the monitoringService = `Platform`
110
111
@@ -198,7 +199,7 @@ The common schema includes information about the affected resource and the cause
198
199
}
199
200
```
200
201
201
-
## Alert context for Log alerts
202
+
## Alert context fields for Log alerts
202
203
203
204
> [!NOTE]
204
205
> When you enable the common schema, the fields in the payload are reset to the common schema fields. Therefore, log alerts have these limitations regarding the common schema:
@@ -397,7 +398,7 @@ The common schema includes information about the affected resource and the cause
397
398
}
398
399
```
399
400
400
-
## Alert context for activity log alerts
401
+
## Alert context fields for activity log alerts
401
402
402
403
### Sample activity log alert when the monitoringService = Activity Log - Administrative
403
404
@@ -589,7 +590,9 @@ The common schema includes information about the affected resource and the cause
0 commit comments