|
1 | 1 | ---
|
2 |
| -title: Migrate from the Azure Monitor alerts Get Summary API |
3 |
| -description: Find out how to migrate from the Azure Monitor alerts Get Summary API, which is being deprecated |
| 2 | +title: Migrate from the Azure Monitor alertsSummary API |
| 3 | +description: Find out how to migrate from the Azure Monitor alertsSummary API, which is being deprecated |
4 | 4 | ms.topic: how-to
|
5 | 5 | ms.date: 09/21/2023
|
6 | 6 | ms.author: abbyweisberg
|
7 | 7 | ---
|
8 | 8 |
|
9 | 9 |
|
10 |
| -# Migrate from the Get alert summary API to ARG query |
| 10 | +# Migrate from the alertsSummary API to ARG queries |
11 | 11 |
|
12 |
| -The [Get Summary API](/rest/api/monitor/alertsmanagement/alerts/get-summary) is being deprecated as of September 30,2026. Instead of the Get Summary API, you can use Azure Resource Graph queries to get the same information. |
| 12 | +The [alertsSummary API](/rest/api/monitor/alertsmanagement/alerts/get-summary) is being deprecated as of September 30,2026. Instead of the alertsSummary API, you can use Azure Resource Graph queries to get the same information. |
13 | 13 |
|
14 |
| -Azure Resource Graph queries provide flexibility to query your Azure data and can be used for Azure monitor alerts instead of the Get Summary API. |
| 14 | +Azure Resource Graph queries provide flexibility to query your Azure data and can be used for Azure monitor alerts instead of the alertsSummary API. |
15 | 15 |
|
16 |
| -Azure Resource Graph queries provide more functionality than the Get Summary API, including: |
| 16 | +Azure Resource Graph queries provide more functionality than the alertsSummary API, including: |
17 | 17 | * The ability to add new fields to the query that returns the alert summary.
|
18 | 18 | * The ability to be more flexible in the query that returns the alert summary.
|
19 | 19 |
|
20 |
| -## Implementation of the current Get Summary API: |
| 20 | +## Implementation of the current alertsSummary API: |
21 | 21 |
|
22 |
| -This is the format for the calling the Get Summary API: |
| 22 | +This is the format for the calling the alertsSummary API: |
23 | 23 |
|
24 | 24 | `GET https://management.azure.com/subscriptions/{subId}/providers/Microsoft.AlertsManagement/alertsSummary?groupby=severity,alertState&api-version=2019-03-01`
|
25 | 25 |
|
26 | 26 | Response: AlertSummary_Sev_Alertstate
|
27 | 27 |
|
28 |
| -This is an example of the output from the Get Summary API: |
| 28 | +This is an example of the output from the alertsSummary API: |
29 | 29 |
|
30 | 30 | ```json
|
31 | 31 | {
|
@@ -64,8 +64,7 @@ This is an example of the output from the Get Summary API:
|
64 | 64 |
|
65 | 65 | ## Use the Azure Resource Graph query
|
66 | 66 |
|
67 |
| -Use Azure Resource Graph queries instead of the Get Summary API call. |
68 |
| -See these Azure Resource Graph samples that retrieve alert summary information: |
| 67 | +Use these Azure Resource Graph queries instead of the alertsSummary API call to retrieve alert information, or use these queries as a basis for designing your own queries. |
69 | 68 |
|
70 | 69 | - [List Azure Monitor alerts ordered by severity](../../governance/resource-graph/samples/starter.md#list-azure-monitor-alerts-ordered-by-severity)
|
71 | 70 | - [List Azure Monitor alerts ordered by severity and alert state](../../governance/resource-graph/samples/starter.md#list-azure-monitor-alerts-ordered-by-severity-and-alert-state)
|
|
0 commit comments