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/activity-log-alerts-webhook.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,22 +22,22 @@ The webhook can optionally use token-based authorization for authentication. The
22
22
23
23
## Payload schema
24
24
25
-
The JSON payload contained in the POST operation differs based on the payload's data.context.activityLog.eventSource field.
25
+
The JSON payload contained in the POST operation differs based on the payload's `data.context.activityLog.eventSource` field.
26
26
27
27
> [!NOTE]
28
-
> Currently, the description that's part of the Activity Log event is copied to the fired `Alert Description` property.
28
+
> Currently, the description that's part of the activity log event is copied to the fired `Alert Description` property.
29
29
>
30
-
> To align the Activity Log payload with other alert types, as of April 1, 2021, the fired alert property `Description` contains the alert rule description instead.
30
+
> To align the activity log payload with other alert types, as of April 1, 2021, the fired alert property `Description` contains the alert rule description instead.
31
31
>
32
-
> In preparation for that change, we created a new property, `Activity Log Event Description`, to the Activity Log fired alert. This new property is filled with the `Description` property that's already available for use. This means that the new field `Activity Log Event Description` contains the description that's part of the Activity Log event.
32
+
> In preparation for that change, we created a new property, `Activity Log Event Description`, to the activity log fired alert. This new property is filled with the `Description` property that's already available for use. So, the new field `Activity Log Event Description` contains the description that's part of the activity log event.
33
33
>
34
-
> Review your alert rules, action rules, webhooks, logic app, or any other configurations where you might be using the `Description` property from the fired alert and replace it with the `Activity Log Event Description` property.
34
+
> Review your alert rules, action rules, webhooks, logic app, or any other configurations where you might be using the `Description` property from the fired alert. Replace the `Description` property with the `Activity Log Event Description` property.
35
35
>
36
-
> If your condition (in your action rules, webhooks, logic app, or any other configurations) is currently based on the `Description` property for Activity Log alerts, you might need to modify it to be based on the `Activity Log Event Description` property instead.
36
+
> If your condition in your action rules, webhooks, logic app, or any other configurations is currently based on the `Description` property for activity log alerts, you might need to modify it to be based on the `Activity Log Event Description` property instead.
37
37
>
38
38
> To fill the new `Description` property, you can add a description in the alert rule definition.
39
39
40
-
> 
40
+
> 
41
41
42
42
### Common
43
43
@@ -225,7 +225,7 @@ The JSON payload contained in the POST operation differs based on the payload's
225
225
}
226
226
```
227
227
228
-
For specific schema details on service health notification activity log alerts, see [Service health notifications](../../service-health/service-notifications.md). In addition, you can learn how to [configure service health webhook notifications with your existing problem management solutions](../../service-health/service-health-alert-webhook-guide.md).
228
+
For specific schema details on service health notification activity log alerts, see [Service health notifications](../../service-health/service-notifications.md). You can also learn how to [configure service health webhook notifications with your existing problem management solutions](../../service-health/service-health-alert-webhook-guide.md).
229
229
230
230
### ResourceHealth
231
231
@@ -267,10 +267,10 @@ For specific schema details on service health notification activity log alerts,
267
267
268
268
| Element name | Description |
269
269
| --- | --- |
270
-
| status |Used for metric alerts. Always set to "activated" for activity log alerts. |
270
+
| status |Used for metric alerts. Always set to `activated` for activity log alerts. |
271
271
| context |Context of the event. |
272
272
| resourceProviderName |The resource provider of the affected resource. |
273
-
| conditionType |Always "Event."|
273
+
| conditionType |Always `Event`.|
274
274
| name |Name of the alert rule. |
275
275
| id |Resource ID of the alert. |
276
276
| description |Alert description set when the alert is created. |
@@ -281,19 +281,19 @@ For specific schema details on service health notification activity log alerts,
281
281
| properties |Set of `<Key, Value>` pairs (that is, `Dictionary<String, String>`) that includes details about the event. |
282
282
| event |Element that contains metadata about the event. |
283
283
| authorization |The Azure role-based access control properties of the event. These properties usually include the action, the role, and the scope. |
284
-
| category |Category of the event. Supported values include Administrative, Alert, Security, ServiceHealth, and Recommendation. |
284
+
| category |Category of the event. Supported values include `Administrative`, `Alert`, `Security`, `ServiceHealth`, and `Recommendation`. |
285
285
| caller |Email address of the user who performed the operation, UPN claim, or SPN claim based on availability. Can be null for certain system calls. |
286
-
| correlationId |Usually a GUID in string format. Events with correlationId belong to the same larger action and usually share a correlationId. |
286
+
| correlationId |Usually a GUID in string format. Events with `correlationId` belong to the same larger action and usually share a `correlationId`. |
287
287
| eventDescription |Static text description of the event. |
288
288
| eventDataId |Unique identifier for the event. |
289
289
| eventSource |Name of the Azure service or infrastructure that generated the event. |
290
-
| httpRequest |The request usually includes the clientRequestId, clientIpAddress, and HTTP method (for example, PUT). |
291
-
| level |One of the following values: Critical, Error, Warning, and Informational. |
290
+
| httpRequest |The request usually includes the `clientRequestId`, `clientIpAddress`, and HTTP method (for example, PUT). |
291
+
| level |One of the following values: `Critical`, `Error`, `Warning`, and `Informational`. |
292
292
| operationId |Usually a GUID shared among the events corresponding to a single operation. |
293
293
| operationName |Name of the operation. |
294
294
| properties |Properties of the event. |
295
-
| status |String. Status of the operation. Common values include Started, In Progress, Succeeded, Failed, Active, and Resolved. |
296
-
| subStatus |Usually includes the HTTP status code of the corresponding REST call. It might also include other strings that describe a substatus. Common substatus values include OK (HTTP Status Code: 200), Created (HTTP Status Code: 201), Accepted (HTTP Status Code: 202), No Content (HTTP Status Code: 204), Bad Request (HTTP Status Code: 400), Not Found (HTTP Status Code: 404), Conflict (HTTP Status Code: 409), Internal Server Error (HTTP Status Code: 500), Service Unavailable (HTTP Status Code: 503), and Gateway Timeout (HTTP Status Code: 504). |
295
+
| status |String. Status of the operation. Common values include `Started`, `In Progress`, `Succeeded`, `Failed`, `Active`, and `Resolved`. |
296
+
| subStatus |Usually includes the HTTP status code of the corresponding REST call. It might also include other strings that describe a substatus. Common substatus values include `OK` (HTTP Status Code: 200), `Created` (HTTP Status Code: 201), `Accepted` (HTTP Status Code: 202), `No Content` (HTTP Status Code: 204), `Bad Request` (HTTP Status Code: 400), `Not Found` (HTTP Status Code: 404), `Conflict` (HTTP Status Code: 409), `Internal Server Error` (HTTP Status Code: 500), `Service Unavailable` (HTTP Status Code: 503), and `Gateway Timeout` (HTTP Status Code: 504). |
297
297
298
298
For specific schema details on all other activity log alerts, see [Overview of the Azure activity log](../essentials/platform-logs-overview.md).
0 commit comments