Alerts - Get All

Odwołanie

Usługa:: Monitor

Wersja interfejsu API:: 2023-07-12-preview

Wyświetl listę wszystkich istniejących alertów, w których wyniki można filtrować na podstawie wielu parametrów (np. zakresu czasu). Wyniki można następnie sortować na podstawie określonych pól, a wartość domyślna to lastModifiedDateTime.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
scope	path	True	string	zakres w tym miejscu to resourceId, dla którego jest tworzony alert.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.
alertRule	query		string	Filtruj według określonej reguły alertu. Wartość domyślna to wybranie wszystkich.
alertState	query		AlertState	Filtruj według stanu wystąpienia alertu. Wartość domyślna to wybranie wszystkich.
customTimeRange	query		string	Filtruj według niestandardowego zakresu czasu w formacie /gdzie czas jest w formacie ISO-8601)". Dopuszczalne wartości są w ciągu 30 dni od czasu zapytania. Można użyć elementu timeRange lub customTimeRange, ale nie obu. Wartość domyślna to brak.
includeContext	query		boolean	Dołącz kontekst zawierający dane kontekstowe specyficzne dla usługi monitora. Wartość domyślna to false"
includeEgressConfig	query		boolean	Uwzględnij konfigurację ruchu wychodzącego, która będzie używana do wyświetlania zawartości w portalu. Wartość domyślna to "false".
monitorCondition	query		MonitorCondition	Filtruj według warunku monitora, który jest "wyzwolony" lub "Rozwiązany". Wartość domyślna to wybranie wszystkich.
monitorService	query		MonitorService	Filtruj według usługi monitora, która generuje wystąpienie alertu. Wartość domyślna to wszystkie.
pageCount	query		integer (int64)	Określa liczbę alertów zwracanych na stronę w odpowiedzi. Dopuszczalna wartość wynosi od 1 do 250. Po wybraniu filtru "includeContent" maksymalna dozwolona wartość to 25. Wartość domyślna to 25.
select	query		string	Ten filtr umożliwia wybór pól (rozdzielonych przecinkami), które byłyby częścią sekcji podstawowej. Umożliwiłoby to projekcję tylko wymaganych pól, a nie pobieranie całej zawartości. Wartością domyślną jest pobranie wszystkich pól w sekcji essentials.
severity	query		Severity	Filtruj według ważności. Wartość domyślna to wszystkie.
smartGroupId	query		string	Filtruj listę alertów według identyfikatora grupy inteligentnej. Wartość domyślna to brak.
sortBy	query		AlertsSortByFields	Posortuj wyniki zapytania według pola wejściowego. Wartość domyślna to "lastModifiedDateTime".
sortOrder	query		SortOrder	Posortuj kolejność wyników zapytania w kolejności rosnącej lub malejącej. Wartość domyślna to "desc" dla pól czasu i "asc" dla innych.
targetResource	query		string	Filtruj według zasobu docelowego(, który jest pełnym identyfikatorem arm) Wartość domyślna jest wybierana wszystkie.
targetResourceGroup	query		string	Filtruj według docelowej nazwy grupy zasobów. Wartość domyślna to wszystkie.
targetResourceType	query		string	Filtruj według docelowego typu zasobu. Wartość domyślna to wszystkie.
timeRange	query		TimeRange	Filtruj według zakresu czasu według poniższych wartości. Wartość domyślna to 1 dzień.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	alertsList	OK. Pomyślnie wymieniono obiekty alertów.
Other Status Codes	errorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Przykłady

ListAlerts

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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"
    }
  ]
}

Definicje

Nazwa	Opis
actionStatus	Stan akcji
alert	Alert utworzony w usłudze zarządzania alertami.
alertProperties	Torba właściwości alertu
alertsList	Wyświetl listę alertów.
AlertsSortByFields	Posortuj wyniki zapytania według pola wejściowego. Wartość domyślna to "lastModifiedDateTime".
AlertState	Stan obiektu alertu, który może zostać zmodyfikowany przez użytkownika.
errorResponse	Odpowiedź na błąd z usługi.
errorResponseBody	Szczegóły odpowiedzi na błąd.
essentials	Ten obiekt zawiera spójne pola w różnych usługach monitorowania.
MonitorCondition	Warunek reguły w usłudze monitora. Określa, czy podstawowe warunki przekroczyły zdefiniowane progi reguły alertu.
MonitorService	Monitorowanie usługi, na której ustawiono regułę (monitor).
Severity	Ważność alertu Sev0 jest najwyższa, a ważność Sev4 jest najniższa.
SignalType	Typ sygnału, na którym jest oparty alert, na którym mogą być metryki, dzienniki lub dzienniki aktywności.
SortOrder	Posortuj kolejność wyników zapytania w kolejności rosnącej lub malejącej. Wartość domyślna to "desc" dla pól czasu i "asc" dla innych.
TimeRange	Filtruj według zakresu czasu według poniższych wartości. Wartość domyślna to 1 dzień.

actionStatus

Objekt

Stan akcji

Nazwa	Typ	Opis
isSuppressed	boolean	Wartość wskazująca, czy alert jest pomijany.

alert

Objekt

Alert utworzony w usłudze zarządzania alertami.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu platformy Azure
name	string	Nazwa zasobu platformy Azure
properties	alertProperties	Torba właściwości alertu
type	string	Typ zasobu platformy Azure

alertProperties

Objekt

Torba właściwości alertu

Nazwa	Typ	Opis
context	object	Informacje specyficzne dla usługi monitora, która udostępnia bardziej kontekstowe szczegóły dotyczące alertu.
egressConfig	object	Konfiguracja, która będzie używana do wyświetlania danych w portalu.
essentials	essentials	Ten obiekt zawiera spójne pola w różnych usługach monitorowania.

alertsList

Objekt

Wyświetl listę alertów.

Nazwa	Typ	Opis
nextLink	string	Adres URL umożliwiający pobranie następnego zestawu alertów.
value	alert[]	Lista alertów

AlertsSortByFields

Wyliczanie

Posortuj wyniki zapytania według pola wejściowego. Wartość domyślna to "lastModifiedDateTime".

Wartość	Opis
alertState
lastModifiedDateTime
monitorCondition
name
severity
startDateTime
targetResource
targetResourceGroup
targetResourceName
targetResourceType

AlertState

Wyliczanie

Stan obiektu alertu, który może zostać zmodyfikowany przez użytkownika.

Wartość	Opis
Acknowledged
Closed
New

errorResponse

Objekt

Odpowiedź na błąd z usługi.

Nazwa	Typ	Opis
error	errorResponseBody	Szczegóły odpowiedzi na błąd.

errorResponseBody

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa	Typ	Opis
code	string	Kod błędu, który ma być używany programowo.
details	errorResponseBody[]	Lista dodatkowych szczegółów dotyczących błędu.
message	string	Opis błędu, który jest przeznaczony do wyświetlania w interfejsie użytkownika.
target	string	Element docelowy określonego błędu, na przykład nazwa właściwości.

essentials

Objekt

Ten obiekt zawiera spójne pola w różnych usługach monitorowania.

Nazwa	Typ	Opis
actionStatus	actionStatus	Stan akcji
alertRule	string	Reguła(monitor), która wyzwolła wystąpienie alertu. W zależności od usługi monitora będzie to identyfikator arm lub nazwa reguły.
alertState	AlertState	Stan obiektu alertu, który może zostać zmodyfikowany przez użytkownika.
description	string	Opis alertu.
lastModifiedDateTime	string (date-time)	Czas ostatniej modyfikacji (format ISO-8601) wystąpienia alertu.
lastModifiedUserName	string	Użytkownik, który ostatnio zmodyfikował alert, w przypadku monitorowania aktualizacji usługi użytkownik to "system", w przeciwnym razie nazwa użytkownika.
monitorCondition	MonitorCondition	Warunek reguły w usłudze monitora. Określa, czy podstawowe warunki przekroczyły zdefiniowane progi reguły alertu.
monitorConditionResolvedDateTime	string (date-time)	Rozwiązany czas (format ISO-8601) wystąpienia alertu. Zostanie ona zaktualizowana, gdy usługa monitora rozpozna wystąpienie alertu, ponieważ warunek reguły nie jest już spełniony.
monitorService	MonitorService	Monitorowanie usługi, na której ustawiono regułę (monitor).
severity	Severity	Ważność alertu Sev0 jest najwyższa, a ważność Sev4 jest najniższa.
signalType	SignalType	Typ sygnału, na którym jest oparty alert, na którym mogą być metryki, dzienniki lub dzienniki aktywności.
smartGroupId	string	Unikatowy identyfikator grupy inteligentnej
smartGroupingReason	string	Pełny powód opisujący przyczynę dodania tego wystąpienia alertu do grupy inteligentnej
sourceCreatedId	string	Unikatowy identyfikator utworzony przez usługę monitora dla każdego wystąpienia alertu. Może to służyć do śledzenia problemu w usłudze monitora, w przypadku Nagios, Zabbix, SCOM itp.
startDateTime	string (date-time)	Czas utworzenia (format ISO-8601) wystąpienia alertu.
targetResource	string	Docelowy zasób usługi ARM, na którym został utworzony alert.
targetResourceGroup	string	Grupa zasobów docelowego zasobu usługi ARM, na którym został utworzony alert.
targetResourceName	string	Nazwa docelowej nazwy zasobu usługi ARM, na której został utworzony alert.
targetResourceType	string	Typ zasobu docelowego usługi ARM, na którym został utworzony alert.

MonitorCondition

Wyliczanie

Warunek reguły w usłudze monitora. Określa, czy podstawowe warunki przekroczyły zdefiniowane progi reguły alertu.

Wartość	Opis
Fired
Resolved

MonitorService

Wyliczanie

Monitorowanie usługi, na której ustawiono regułę (monitor).

Wartość	Opis
ActivityLog Administrative
ActivityLog Autoscale
ActivityLog Policy
ActivityLog Recommendation
ActivityLog Security
Application Insights
Log Analytics
Nagios
Platform
Resource Health
SCOM
ServiceHealth
SmartDetector
VM Insights
Zabbix

Severity

Wyliczanie

Ważność alertu Sev0 jest najwyższa, a ważność Sev4 jest najniższa.

Wartość	Opis
Sev0
Sev1
Sev2
Sev3
Sev4

SignalType

Wyliczanie

Typ sygnału, na którym jest oparty alert, na którym mogą być metryki, dzienniki lub dzienniki aktywności.

Wartość	Opis
Log
Metric
Unknown

SortOrder

Wyliczanie

Posortuj kolejność wyników zapytania w kolejności rosnącej lub malejącej. Wartość domyślna to "desc" dla pól czasu i "asc" dla innych.

Wartość	Opis
asc
desc

TimeRange

Wyliczanie

Filtruj według zakresu czasu według poniższych wartości. Wartość domyślna to 1 dzień.

Wartość	Opis
1d
1h
30d
7d

Udostępnij za pośrednictwem

Alerts - Get All

Parametry identyfikatora URI

Odpowiedzi

Przykłady

ListAlerts

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

actionStatus

alert

alertProperties

alertsList

AlertsSortByFields

AlertState

errorResponse

errorResponseBody

essentials

MonitorCondition

MonitorService

Severity

SignalType

SortOrder

TimeRange

Dodatkowe zasoby