Alerts - Get Summary

Referens

Service:: Monitor

API Version:: 2023-07-12-preview

Få ett sammanfattat antal aviseringar grupperade efter olika parametrar (t.ex. gruppering efter allvarlighetsgrad returnerar antalet aviseringar för varje allvarlighetsgrad).

GET https://management.azure.com/{scope}/providers/Microsoft.AlertsManagement/alertsSummary?groupby={groupby}&api-version=2023-07-12-preview

With optional parameters:

GET https://management.azure.com/{scope}/providers/Microsoft.AlertsManagement/alertsSummary?groupby={groupby}&includeSmartGroupsCount={includeSmartGroupsCount}&targetResource={targetResource}&targetResourceType={targetResourceType}&targetResourceGroup={targetResourceGroup}&monitorService={monitorService}&monitorCondition={monitorCondition}&severity={severity}&alertState={alertState}&alertRule={alertRule}&timeRange={timeRange}&customTimeRange={customTimeRange}&api-version=2023-07-12-preview

URI-parametrar

Name	I	Obligatorisk	Typ	Description
scope	path	True	string	scope här är resourceId som aviseringen skapas för.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.
groupby	query	True	AlertsSummaryGroupByFields	Med den här parametern kan resultatuppsättningen grupperas efter indatafält (högst 2 kommaavgränsade fält stöds). Till exempel groupby=severity eller groupby=severity,alertstate.
alertRule	query		string	Filtrera efter specifik aviseringsregel. Standardvärdet är att markera alla.
alertState	query		AlertState	Filtrera efter status för aviseringsinstansen. Standardvärdet är att markera alla.
customTimeRange	query		string	Filtrera efter anpassat tidsintervall i formatet/där tiden är i (ISO-8601-format)'. Tillåtna värden är inom 30 dagar från frågetiden. Du kan använda timeRange eller customTimeRange, men inte båda. Standardvärdet är ingen.
includeSmartGroupsCount	query		boolean	Inkludera antalet SmartGroups som en del av sammanfattningen. Standardvärdet är "false".
monitorCondition	query		MonitorCondition	Filtrera efter övervakningsvillkor som antingen är "Utlöst" eller "Löst". Standardvärdet är att markera alla.
monitorService	query		MonitorService	Filtrera efter övervakningstjänst som genererar aviseringsinstansen. Standardvärdet är markera alla.
severity	query		Severity	Filtrera efter allvarlighetsgrad. Standardvärdet är markera alla.
targetResource	query		string	Filtrera efter målresurs( som är fullständigt ARM-ID) Standardvärdet är att markera alla.
targetResourceGroup	query		string	Filtrera efter namnet på målresursgruppen. Standardvärdet är markera alla.
targetResourceType	query		string	Filtrera efter målresurstyp. Standardvärdet är markera alla.
timeRange	query		TimeRange	Filtrera efter tidsintervall enligt de värden som anges nedan. Standardvärdet är 1 dag.

Svar

Name	Typ	Description
200 OK	alertsSummary	OK. Aviseringssammanfattning returneras.
Other Status Codes	errorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Exempel

Summary

Sample Request

HTTP

GET https://management.azure.com/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alertsSummary?groupby=severity,alertState&api-version=2023-07-12-preview

Sample Response

Status code:: 200

{
  "properties": {
    "groupedby": "severity",
    "smartGroupsCount": 100,
    "total": 14189,
    "values": [
      {
        "name": "Sev0",
        "count": 6517,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 6517
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      },
      {
        "name": "Sev1",
        "count": 3175,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 3175
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      },
      {
        "name": "Sev2",
        "count": 1120,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 1120
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      },
      {
        "name": "Sev3",
        "count": 1902,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 1902
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      },
      {
        "name": "Sev4",
        "count": 1475,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 1475
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      }
    ]
  },
  "id": "/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alertsSummary/current",
  "type": "Microsoft.AlertsManagement/alertsSummary",
  "name": "current"
}

Definitioner

Name	Description
alertsSummary	Sammanfattning av aviseringar baserat på indatafilter och "groupby"-parametrar.
alertsSummaryGroup	Gruppera resultatuppsättningen.
AlertsSummaryGroupByFields	Med den här parametern kan resultatuppsättningen grupperas efter indatafält (högst 2 kommaavgränsade fält stöds). Till exempel groupby=severity eller groupby=severity,alertstate.
alertsSummaryGroupItem	Gruppobjekt för aviseringssammanfattning
AlertState	Aviseringsobjekttillstånd, som kan ändras av användaren.
errorResponse	Ett felsvar från tjänsten.
errorResponseBody	Information om felsvar.
MonitorCondition	Villkor för regeln i övervakningstjänsten. Den representerar om de underliggande villkoren har passerat de definierade tröskelvärdena för aviseringsregeln.
MonitorService	Övervaka den tjänst där regeln (övervakaren) har angetts.
Severity	Allvarlighetsgraden för aviseringSev0 är högst och Sev4 är lägst.
TimeRange	Filtrera efter tidsintervall enligt de värden som anges nedan. Standardvärdet är 1 dag.

alertsSummary

Sammanfattning av aviseringar baserat på indatafilter och "groupby"-parametrar.

Name	Typ	Description
id	string	Resurs-ID för Azure
name	string	Azure-resursnamn
properties	alertsSummaryGroup	Gruppera resultatuppsättningen.
type	string	Azure-resurstyp

alertsSummaryGroup

Gruppera resultatuppsättningen.

Name	Typ	Description
groupedby	string	Namnet på det aggregerade fältet
smartGroupsCount	integer	Totalt antal smarta grupper.
total	integer	Totalt antal resultatuppsättningar.
values	alertsSummaryGroupItem[]	Lista över objekten

AlertsSummaryGroupByFields

Med den här parametern kan resultatuppsättningen grupperas efter indatafält (högst 2 kommaavgränsade fält stöds). Till exempel groupby=severity eller groupby=severity,alertstate.

Name	Typ	Description
alertRule	string
alertState	string
monitorCondition	string
monitorService	string
severity	string
signalType	string

alertsSummaryGroupItem

Gruppobjekt för aviseringssammanfattning

Name	Typ	Description
count	integer	Antal aggregerade fält
groupedby	string	Namnet på det aggregerade fältet
name	string	Värdet för det aggregerade fältet
values	alertsSummaryGroupItem[]	Lista över objekten

AlertState

Aviseringsobjekttillstånd, som kan ändras av användaren.

Name	Typ	Description
Acknowledged	string
Closed	string
New	string

errorResponse

Ett felsvar från tjänsten.

Name	Typ	Description
error	errorResponseBody	Information om felsvar.

errorResponseBody

Information om felsvar.

Name	Typ	Description
code	string	Felkod, avsedd att användas programmatiskt.
details	errorResponseBody[]	En lista med ytterligare information om felet.
message	string	Beskrivning av felet, som är avsett att visas i användargränssnittet.
target	string	Målet för det specifika felet, till exempel namnet på egenskapen.

MonitorCondition

Villkor för regeln i övervakningstjänsten. Den representerar om de underliggande villkoren har passerat de definierade tröskelvärdena för aviseringsregeln.

Name	Typ	Description
Fired	string
Resolved	string

MonitorService

Övervaka den tjänst där regeln (övervakaren) har angetts.

Name	Typ	Description
ActivityLog Administrative	string
ActivityLog Autoscale	string
ActivityLog Policy	string
ActivityLog Recommendation	string
ActivityLog Security	string
Application Insights	string
Log Analytics	string
Nagios	string
Platform	string
Resource Health	string
SCOM	string
ServiceHealth	string
SmartDetector	string
VM Insights	string
Zabbix	string

Severity

Allvarlighetsgraden för aviseringSev0 är högst och Sev4 är lägst.

Name	Typ	Description
Sev0	string
Sev1	string
Sev2	string
Sev3	string
Sev4	string

TimeRange

Filtrera efter tidsintervall enligt de värden som anges nedan. Standardvärdet är 1 dag.

Name	Typ	Description
1d	string
1h	string
30d	string
7d	string