Alerts - Get By Id

Usługa:

Monitor

Wersja interfejsu API:

2023-07-12-preview

Pobierz określony alert.
Pobieranie informacji związanych z określonym alertem

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
alertId	path	True	string	Unikatowy identyfikator wystąpienia alertu.
scope	path	True	string	zakres w tym miejscu to resourceId, dla którego jest tworzony alert.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	alert	OK. Zwraca alert o określonym identyfikatorze.
Other Status Codes	errorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Przykłady

GetById

Przykładowe żądanie

HTTP

GET https://management.azure.com/subscriptions/9e261de7-c804-4b9d-9ebf-6f50fe350a9a/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100?api-version=2023-07-12-preview

Przykładowa odpowiedź

Kod stanu:

200

{
  "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://sersdfsdfinsight.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 na właściwość alertu
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ść 4 jest najniższa.
SignalType	Typ sygnału, na którym jest oparty alert, na którym mogą być metryki, dzienniki lub dzienniki aktywności.

actionStatus

Stan akcji

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

alert

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 na właściwość alertu
type	string	Typ zasobu platformy Azure

alertProperties

Torba na właściwość alertu

Nazwa	Typ	Opis
context	object	Informacje specyficzne dla usługi monitorowania, która zapewnia 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.

AlertState

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

Nazwa	Typ	Opis
Acknowledged	string
Closed	string
New	string

errorResponse

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

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

errorResponseBody

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

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 wyzwalał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	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 będzie "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	Rozwiązany czas (format ISO-8601) wystąpienia alertu. Zostanie to zaktualizowane, gdy usługa monitora rozwiąże 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ść 4 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ę monitorowania 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	Czas tworzenia (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

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

Nazwa	Typ	Opis
Fired	string
Resolved	string

MonitorService

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

Nazwa	Typ	Opis
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

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

Nazwa	Typ	Opis
Sev0	string
Sev1	string
Sev2	string
Sev3	string
Sev4	string

SignalType

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

Nazwa	Typ	Opis
Log	string
Metric	string
Unknown	string