Alerts - Get All

Riferimento

Service:: Monitor

API Version:: 2023-07-12-preview

Elencare tutti gli avvisi esistenti, in cui i risultati possono essere filtrati in base a più parametri (ad esempio, intervallo di tempo). I risultati possono quindi essere ordinati in base a campi specifici, con l'impostazione predefinita lastModifiedDateTime.

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

With optional parameters:

GET https://management.azure.com/{scope}/providers/Microsoft.AlertsManagement/alerts?targetResource={targetResource}&targetResourceType={targetResourceType}&targetResourceGroup={targetResourceGroup}&monitorService={monitorService}&monitorCondition={monitorCondition}&severity={severity}&alertState={alertState}&alertRule={alertRule}&smartGroupId={smartGroupId}&includeContext={includeContext}&includeEgressConfig={includeEgressConfig}&pageCount={pageCount}&sortBy={sortBy}&sortOrder={sortOrder}&select={select}&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.
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.
includeContext	query		boolean	Includere il contesto con dati contestuali specifici per il servizio di monitoraggio. Il valore predefinito è false'
includeEgressConfig	query		boolean	Includere la configurazione in uscita che verrà usata per visualizzare il contenuto nel portale. 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.
pageCount	query		integer int64	Determina il numero di avvisi restituiti per pagina in risposta. Il valore consentito è compreso tra 1 e 250. Quando si seleziona il filtro "includeContent", il valore massimo consentito è 25. Il valore predefinito è 25.
select	query		string	Questo filtro consente di selezionare i campi (delimitati da virgole) che farebbero parte della sezione essenziale. Ciò consentirà di proiettare solo i campi obbligatori invece di ottenere l'intero contenuto. L'impostazione predefinita consiste nel recuperare tutti i campi nella sezione Informazioni di base.
severity	query		Severity	Filtrare in base alla gravità. Il valore predefinito è Seleziona tutto.
smartGroupId	query		string	Filtrare l'elenco degli avvisi in base all'ID gruppo intelligente. Il valore predefinito è nessuno.
sortBy	query		AlertsSortByFields	Ordinare i risultati della query in base al campo di input. Il valore predefinito è 'lastModifiedDateTime'.
sortOrder	query		SortOrder	Ordinare l'ordine dei risultati della query in ordine crescente o decrescente. Il valore predefinito è 'desc' per i campi di ora e 'asc' per altri.
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	alertsList	OK. Sono stati elencati correttamente gli oggetti avviso.
Other Status Codes	errorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Esempio

ListAlerts

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "nextLink": "https://management.azure.com:443/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alerts?api-version=2018-05-05-preview&timeRange=1d&ctoken=%2bRID%3aPlwOAPHEGwB9UwEAAAAgCw%3d%3d%23RT%3a2%23TRC%3a500%23RTD%3aqtQyMDE4LTA2LTEyVDE1OjEyOjE1",
  "value": [
    {
      "properties": {
        "essentials": {
          "severity": "Sev3",
          "signalType": "Log",
          "alertState": "Acknowledged",
          "monitorCondition": "Fired",
          "monitorService": "Application Insights",
          "targetResource": "/subscriptions/3b540246-808d-4331-99aa-917b808a9166/resourcegroups/servicedeskresourcegroup/providers/microsoft.insights/components/servicedeskappinsight",
          "targetResourceName": "servicedeskappinsight",
          "targetResourceGroup": "servicedeskresourcegroup",
          "targetResourceType": "components",
          "sourceCreatedId": "6cd6b2ce-8c54-468f-aff0-9d12aebb7e49",
          "smartGroupId": "23d6b2ce-8c54-468f-aff0-sd32aebb7e56",
          "smartGroupingReason": "Occurred frequently with other alerts",
          "alertRule": "https://servisdffsdf.portal.mms.microsoft.com/#Workspace/overview/settings/details/Edit Alert Rule/details/index?savedSearchId=&scheduleId=",
          "startDateTime": "2018-09-13T15:51:02Z",
          "lastModifiedDateTime": "2018-09-13T15:51:02Z",
          "lastModifiedUserName": "System",
          "monitorConditionResolvedDateTime": "2018-09-13T15:51:02Z",
          "actionStatus": {
            "isSuppressed": false
          },
          "description": "description of the alert"
        },
        "egressConfig": {},
        "context": {}
      },
      "id": "/subscriptions/9e261de7-c804-4b9d-9ebf-6f50fe350a9a/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100",
      "type": "Microsoft.AlertsManagement/alerts",
      "name": "cpu alert"
    },
    {
      "properties": {
        "essentials": {
          "severity": "Sev3",
          "signalType": "Log",
          "alertState": "New",
          "monitorCondition": "Fired",
          "monitorService": "Application Insights",
          "targetResource": "/subscriptions/3b540246-808d-4331-99aa-917b808a9166/resourcegroups/cind/providers/microsoft.operationalinsights/workspaces/servicedeskwcus",
          "targetResourceName": "servicedeskwcus",
          "targetResourceGroup": "servicedeskresourcegroup",
          "targetResourceType": "components",
          "sourceCreatedId": "6cd6b2ce-8c54-468f-aff0-9d12aebb7e49",
          "smartGroupId": "d1c49c89-ea95-4697-a299-c0f5ebac62f1",
          "smartGroupingReason": "Alerts that frequently occur together have been grouped.",
          "alertRule": "https://servicsdfsdf.portal.mms.microsoft.com/#Workspace/overview/settings/details/Edit Alert Rule/details/index?savedSearchId=&scheduleId=",
          "startDateTime": "2018-09-13T15:51:02Z",
          "lastModifiedDateTime": "2018-09-13T15:51:02Z",
          "lastModifiedUserName": "System",
          "monitorConditionResolvedDateTime": "2018-09-13T15:51:02Z",
          "actionStatus": {
            "isSuppressed": false
          },
          "description": "description of the alert"
        },
        "egressConfig": {},
        "context": {}
      },
      "id": "/subscriptions/9e261de7-c804-4b9d-9ebf-6f50fe350a9a/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100",
      "type": "Microsoft.AlertsManagement/alerts",
      "name": "cpu alert"
    }
  ]
}

Definizioni

Nome	Descrizione
actionStatus	Stato azione
alert	Avviso creato nel servizio di gestione degli avvisi.
alertProperties	Contenitore delle proprietà avviso
alertsList	Elencare gli avvisi.
AlertsSortByFields	Ordinare i risultati della query in base al campo di input. Il valore predefinito è 'lastModifiedDateTime'.
AlertState	Stato dell'oggetto avviso, che può essere modificato dall'utente.
errorResponse	Risposta di errore dal servizio.
errorResponseBody	Dettagli della risposta all'errore.
essentials	Questo oggetto contiene campi coerenti in diversi servizi di monitoraggio.
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.
SignalType	Il tipo di segnale su cui si basa l'avviso, che può essere metriche, log o log attività.
SortOrder	Ordinare l'ordine dei risultati della query in ordine crescente o decrescente. Il valore predefinito è 'desc' per i campi di ora e 'asc' per altri.
TimeRange	Filtrare in base all'intervallo di tempo in base ai valori elencati di seguito. Il valore predefinito è 1 giorno.

actionStatus

Stato azione

Nome	Tipo	Descrizione
isSuppressed	boolean	Valore che indica se l'avviso viene eliminato.

alert

Avviso creato nel servizio di gestione degli avvisi.

Nome	Tipo	Descrizione
id	string	ID risorsa di Azure
name	string	Nome risorsa di Azure
properties	alertProperties	Contenitore delle proprietà avviso
type	string	Tipo di risorsa di Azure

alertProperties

Contenitore delle proprietà avviso

Nome	Tipo	Descrizione
context	object	Informazioni specifiche del servizio di monitoraggio che offrono dettagli più contestuali sull'avviso.
egressConfig	object	Configurazione che verrà usata per visualizzare i dati nel portale.
essentials	essentials	Questo oggetto contiene campi coerenti in diversi servizi di monitoraggio.

alertsList

Elencare gli avvisi.

Nome	Tipo	Descrizione
nextLink	string	URL per recuperare il set successivo di avvisi.
value	alert[]	Elenco di avvisi

AlertsSortByFields

Ordinare i risultati della query in base al campo di input. Il valore predefinito è 'lastModifiedDateTime'.

Nome	Tipo	Descrizione
alertState	string
lastModifiedDateTime	string
monitorCondition	string
name	string
severity	string
startDateTime	string
targetResource	string
targetResourceGroup	string
targetResourceName	string
targetResourceType	string

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à.

essentials

Questo oggetto contiene campi coerenti in diversi servizi di monitoraggio.

Nome	Tipo	Descrizione
actionStatus	actionStatus	Stato azione
alertRule	string	Rule(monitor) che ha attivato l'istanza di avviso. A seconda del servizio di monitoraggio, si tratta dell'ID arm o del nome della regola.
alertState	AlertState	Stato dell'oggetto avviso, che può essere modificato dall'utente.
description	string	Descrizione dell'avviso.
lastModifiedDateTime	string	Ora ultima modifica (formato ISO-8601) dell'istanza di avviso.
lastModifiedUserName	string	L'utente che ha modificato l'avviso per l'ultima volta, in caso di monitoraggio degli aggiornamenti del servizio, l'utente sarà "system", altrimenti il nome dell'utente.
monitorCondition	MonitorCondition	Condizione della regola nel servizio di monitoraggio. Indica se le condizioni sottostanti hanno superato le soglie delle regole di avviso definite.
monitorConditionResolvedDateTime	string	Tempo risolto (formato ISO-8601) dell'istanza di avviso. Verrà aggiornato quando il servizio di monitoraggio risolve l'istanza di avviso perché la condizione della regola non viene più soddisfatta.
monitorService	MonitorService	Monitorare il servizio in cui è impostata la regola(monitoraggio).
severity	Severity	La gravità dell'avviso Sev0 è più alta e Sev4 è più bassa.
signalType	SignalType	Il tipo di segnale su cui si basa l'avviso, che può essere metriche, log o log attività.
smartGroupId	string	ID univoco del gruppo intelligente
smartGroupingReason	string	Motivo dettagliato che descrive il motivo per cui questa istanza di avviso viene aggiunta a un gruppo intelligente
sourceCreatedId	string	ID univoco creato dal servizio di monitoraggio per ogni istanza di avviso. Questo può essere usato per tenere traccia del problema nel servizio di monitoraggio, in caso di Nagios, Zabbix, SCOM e così via.
startDateTime	string	Ora di creazione (formato ISO-8601) dell'istanza di avviso.
targetResource	string	Risorsa ARM di destinazione in cui è stato creato l'avviso.
targetResourceGroup	string	Gruppo di risorse della risorsa ARM di destinazione in cui è stato creato l'avviso.
targetResourceName	string	Nome della risorsa ARM di destinazione, in cui è stato creato l'avviso.
targetResourceType	string	Tipo di risorsa della risorsa ARM di destinazione, in cui è stato creato l'avviso.

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

SignalType

Il tipo di segnale su cui si basa l'avviso, che può essere metriche, log o log attività.

Nome	Tipo	Descrizione
Log	string
Metric	string
Unknown	string

SortOrder

Ordinare l'ordine dei risultati della query in ordine crescente o decrescente. Il valore predefinito è 'desc' per i campi di ora e 'asc' per altri.

Nome	Tipo	Descrizione
asc	string
desc	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