Alerts - Get Summary

Riferimento

Servizio:: Monitor

Versione API:: 2023-07-12-preview

Ottenere un conteggio riepilogato degli avvisi raggruppati in base a vari parametri, ad esempio il raggruppamento in base a "Gravità" restituisce il numero di avvisi per ogni gravità.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
scope	path	True	string	l'ambito è resourceId per il quale viene creato l'avviso.
api-version	query	True	string	Versione dell'API da usare per questa operazione.
groupby	query	True	AlertsSummaryGroupByFields	Questo parametro consente di raggruppare il set di risultati in base ai campi di input (massimo 2 campi delimitati da virgole supportati). Ad esempio, groupby=severity o groupby=severity,alertstate.
alertRule	query		string	Filtrare in base a una regola di avviso specifica. Il valore predefinito consiste nel selezionare tutto.
alertState	query		AlertState	Filtrare in base allo stato dell'istanza dell'avviso. Il valore predefinito consiste nel selezionare tutto.
customTimeRange	query		string	Filtrare in base all'intervallo di tempo personalizzato nel formato /in cui l'ora è in (formato ISO-8601)'. I valori consentiti sono entro 30 giorni dall'ora della query. È possibile usare timeRange o customTimeRange, ma non entrambi. L'impostazione predefinita è none.
includeSmartGroupsCount	query		boolean	Includere il numero di SmartGroup come parte del riepilogo. Il valore predefinito è 'false'.
monitorCondition	query		MonitorCondition	Filtrare in base alla condizione di monitoraggio che è 'Attivata' o 'Risolta'. Il valore predefinito consiste nel selezionare tutto.
monitorService	query		MonitorService	Filtrare in base al servizio di monitoraggio che genera l'istanza di avviso. Il valore predefinito è Seleziona tutto.
severity	query		Severity	Filtrare in base alla gravità. Il valore predefinito è Seleziona tutto.
targetResource	query		string	Filtrare in base alla risorsa di destinazione( che è l'ID ARM completo) Il valore predefinito è selezionata tutte.
targetResourceGroup	query		string	Filtrare in base al nome del gruppo di risorse di destinazione. Il valore predefinito è Seleziona tutto.
targetResourceType	query		string	Filtrare in base al tipo di risorsa di destinazione. Il valore predefinito è Seleziona tutto.
timeRange	query		TimeRange	Filtrare in base all'intervallo di tempo in base ai valori elencati di seguito. Il valore predefinito è 1 giorno.

Risposte

Nome	Tipo	Descrizione
200 OK	alertsSummary	OK. Riepilogo degli avvisi restituito.
Other Status Codes	errorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Esempio

Summary

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
}

Definizioni

Nome	Descrizione
alertsSummary	Riepilogo degli avvisi in base ai filtri di input e ai parametri 'groupby'.
alertsSummaryGroup	Raggruppare il set di risultati.
AlertsSummaryGroupByFields	Questo parametro consente di raggruppare il set di risultati in base ai campi di input (massimo 2 campi delimitati da virgole supportati). Ad esempio, groupby=severity o groupby=severity,alertstate.
alertsSummaryGroupItem	Elemento del gruppo di riepilogo degli avvisi
AlertState	Stato dell'oggetto avviso, che può essere modificato dall'utente.
errorResponse	Risposta di errore dal servizio.
errorResponseBody	Dettagli della risposta all'errore.
MonitorCondition	Condizione della regola nel servizio di monitoraggio. Indica se le condizioni sottostanti hanno superato le soglie delle regole di avviso definite.
MonitorService	Monitorare il servizio in cui è impostata la regola(monitoraggio).
Severity	La gravità dell'avviso Sev0 è più alta e Sev4 è più bassa.
TimeRange	Filtrare in base all'intervallo di tempo in base ai valori elencati di seguito. Il valore predefinito è 1 giorno.

alertsSummary

Riepilogo degli avvisi in base ai filtri di input e ai parametri 'groupby'.

Nome	Tipo	Descrizione
id	string	ID risorsa di Azure
name	string	Nome risorsa di Azure
properties	alertsSummaryGroup	Raggruppare il set di risultati.
type	string	Tipo di risorsa di Azure

alertsSummaryGroup

Raggruppare il set di risultati.

Nome	Tipo	Descrizione
groupedby	string	Nome del campo aggregato
smartGroupsCount	integer	Conteggio totale dei gruppi intelligenti.
total	integer	Conteggio totale del set di risultati.
values	alertsSummaryGroupItem[]	Elenco degli elementi

AlertsSummaryGroupByFields

Questo parametro consente di raggruppare il set di risultati in base ai campi di input (massimo 2 campi delimitati da virgole supportati). Ad esempio, groupby=severity o groupby=severity,alertstate.

Nome	Tipo	Descrizione
alertRule	string
alertState	string
monitorCondition	string
monitorService	string
severity	string
signalType	string

alertsSummaryGroupItem

Elemento del gruppo di riepilogo degli avvisi

Nome	Tipo	Descrizione
count	integer	Conteggio del campo aggregato
groupedby	string	Nome del campo aggregato
name	string	Valore del campo aggregato
values	alertsSummaryGroupItem[]	Elenco degli elementi

AlertState

Stato dell'oggetto avviso, che può essere modificato dall'utente.

Nome	Tipo	Descrizione
Acknowledged	string
Closed	string
New	string

errorResponse

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
error	errorResponseBody	Dettagli della risposta all'errore.

errorResponseBody

Dettagli della risposta all'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore, destinato a essere utilizzato a livello di codice.
details	errorResponseBody[]	Elenco di dettagli aggiuntivi sull'errore.
message	string	Descrizione dell'errore, destinato alla visualizzazione nell'interfaccia utente.
target	string	Destinazione dell'errore specifico, ad esempio nome della proprietà.

MonitorCondition

Condizione della regola nel servizio di monitoraggio. Indica se le condizioni sottostanti hanno superato le soglie delle regole di avviso definite.

Nome	Tipo	Descrizione
Fired	string
Resolved	string

MonitorService

Monitorare il servizio in cui è impostata la regola(monitoraggio).

Nome	Tipo	Descrizione
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

La gravità dell'avviso Sev0 è più alta e Sev4 è più bassa.

Nome	Tipo	Descrizione
Sev0	string
Sev1	string
Sev2	string
Sev3	string
Sev4	string

TimeRange

Filtrare in base all'intervallo di tempo in base ai valori elencati di seguito. Il valore predefinito è 1 giorno.

Nome	Tipo	Descrizione
1d	string
1h	string
30d	string
7d	string

Condividi tramite