Alerts - Get All

Referens

Tjänst:: Monitor

API-version:: 2023-07-12-preview

Visa en lista över alla befintliga aviseringar, där resultaten kan filtreras baserat på flera parametrar (t.ex. tidsintervall). Resultatet kan sedan sorteras utifrån de basspecifika fälten, där standardvärdet är lastModifiedDateTime.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
scope	path	True	string	omfånget här är resourceId som aviseringen skapas för.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.
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. Antingen timeRange eller customTimeRange kan användas men inte båda. Standardvärdet är inget.
includeContext	query		boolean	Inkludera kontext som har kontextuella data som är specifika för övervakningstjänsten. Standardvärdet är falskt"
includeEgressConfig	query		boolean	Inkludera utgående konfiguration som skulle användas för att visa innehållet i portalen. 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.
pageCount	query		integer (int64)	Avgör antalet aviseringar som returneras per sida som svar. Tillåtet värde är mellan 1 och 250. När filtret "includeContent" har valts är det högsta tillåtna värdet 25. Standardvärdet är 25.
select	query		string	Med det här filtret kan du välja de fält (kommaavgränsade) som skulle vara en del av det viktiga avsnittet. Detta skulle göra det möjligt att bara projicera de obligatoriska fälten i stället för att hämta hela innehållet. Standardvärdet är att hämta alla fält i avsnittet essentials.
severity	query		Severity	Filtrera efter allvarlighetsgrad. Standardvärdet är markera alla.
smartGroupId	query		string	Filtrera aviseringslistan efter smart grupp-ID. Standardvärdet är inget.
sortBy	query		AlertsSortByFields	Sortera frågeresultaten efter indatafält. Standardvärdet är "lastModifiedDateTime".
sortOrder	query		SortOrder	Sortera frågeresultatordningen i antingen stigande eller fallande. Standardvärdet är "desc" för tidsfält och "asc" för andra.
targetResource	query		string	Filtrera efter målresurs( som är fullständigt ARM-ID) Standardvärdet är att markera alla.
targetResourceGroup	query		string	Filtrera efter namn på målresursgrupp. 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	alertsList	OKEJ. Aviseringsobjekten har listats.
Other Status Codes	errorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Exempel

ListAlerts

Exempelbegäran

HTTP

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

Exempelsvar

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

Definitioner

Name	Description
actionStatus	Åtgärdsstatus
alert	En avisering som skapats i aviseringshanteringstjänsten.
alertProperties	Aviseringsegenskapsväska
alertsList	Visa en lista över aviseringarna.
AlertsSortByFields	Sortera frågeresultaten efter indatafält. Standardvärdet är "lastModifiedDateTime".
AlertState	Aviseringsobjekttillstånd, som kan ändras av användaren.
errorResponse	Ett felsvar från tjänsten.
errorResponseBody	Information om felsvar.
essentials	Det här objektet innehåller konsekventa fält i olika övervakningstjänster.
MonitorCondition	Villkor för regeln i övervakningstjänsten. Den representerar om de underliggande villkoren har passerat tröskelvärdena för den definierade aviseringsregeln.
MonitorService	Övervaka tjänsten där regeln(övervakaren) har angetts.
Severity	Allvarlighetsgraden för avisering Sev0 är högst och Sev4 är lägst.
SignalType	Typen av signal som aviseringen baseras på, vilket kan vara mått, loggar eller aktivitetsloggar.
SortOrder	Sortera frågeresultatordningen i antingen stigande eller fallande. Standardvärdet är "desc" för tidsfält och "asc" för andra.
TimeRange	Filtrera efter tidsintervall enligt de värden som anges nedan. Standardvärdet är 1 dag.

actionStatus

Objekt

Åtgärdsstatus

Name	Typ	Description
isSuppressed	boolean	Värde som anger om aviseringen ignoreras.

alert

Objekt

En avisering som skapats i aviseringshanteringstjänsten.

Name	Typ	Description
id	string	Azure-resurs-ID
name	string	Azure-resursnamn
properties	alertProperties	Aviseringsegenskapsväska
type	string	Azure-resurstyp

alertProperties

Objekt

Aviseringsegenskapsväska

Name	Typ	Description
context	object	Information som är specifik för övervakningstjänsten som ger mer kontextuell information om aviseringen.
egressConfig	object	Konfiguration som skulle användas för att visa data i portalen.
essentials	essentials	Det här objektet innehåller konsekventa fält i olika övervakningstjänster.

alertsList

Objekt

Visa en lista över aviseringarna.

Name	Typ	Description
nextLink	string	URL för att hämta nästa uppsättning aviseringar.
value	alert[]	Lista över aviseringar

AlertsSortByFields

Uppräkning

Sortera frågeresultaten efter indatafält. Standardvärdet är "lastModifiedDateTime".

Värde	Description
alertState
lastModifiedDateTime
monitorCondition
name
severity
startDateTime
targetResource
targetResourceGroup
targetResourceName
targetResourceType

AlertState

Uppräkning

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

Värde	Description
Acknowledged
Closed
New

errorResponse

Objekt

Ett felsvar från tjänsten.

Name	Typ	Description
error	errorResponseBody	Information om felsvar.

errorResponseBody

Objekt

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.

essentials

Objekt

Det här objektet innehåller konsekventa fält i olika övervakningstjänster.

Name	Typ	Description
actionStatus	actionStatus	Åtgärdsstatus
alertRule	string	Rule(monitor) som utlöste aviseringsinstansen. Beroende på övervakningstjänsten skulle detta vara ARM-ID eller namnet på regeln.
alertState	AlertState	Aviseringsobjekttillstånd, som kan ändras av användaren.
description	string	Aviseringsbeskrivning.
lastModifiedDateTime	string (date-time)	Senaste ändringstid (ISO-8601-format) för aviseringsinstansen.
lastModifiedUserName	string	Användare som senast ändrade aviseringen, i händelse av att övervaka tjänstuppdateringar användaren skulle vara "system", annars namnet på användaren.
monitorCondition	MonitorCondition	Villkor för regeln i övervakningstjänsten. Den representerar om de underliggande villkoren har passerat tröskelvärdena för den definierade aviseringsregeln.
monitorConditionResolvedDateTime	string (date-time)	Löst tid (ISO-8601-format) för aviseringsinstansen. Detta uppdateras när övervakningstjänsten löser aviseringsinstansen eftersom regelvillkoret inte längre uppfylls.
monitorService	MonitorService	Övervaka tjänsten där regeln(övervakaren) har angetts.
severity	Severity	Allvarlighetsgraden för avisering Sev0 är högst och Sev4 är lägst.
signalType	SignalType	Typen av signal som aviseringen baseras på, vilket kan vara mått, loggar eller aktivitetsloggar.
smartGroupId	string	Unikt ID för den smarta gruppen
smartGroupingReason	string	Utförlig orsak som beskriver orsaken till att den här aviseringsinstansen läggs till i en smart grupp
sourceCreatedId	string	Unikt ID som skapats av övervakningstjänsten för varje aviseringsinstans. Detta kan användas för att spåra problemet i övervakningstjänsten, i händelse av Nagios, Zabbix, SCOM osv.
startDateTime	string (date-time)	Skapandetid (ISO-8601-format) för aviseringsinstansen.
targetResource	string	Arm-målresurs, där aviseringen skapades.
targetResourceGroup	string	Resursgrupp med arm-målresurs, där aviseringen skapades.
targetResourceName	string	Namnet på målets ARM-resursnamn, där aviseringen skapades.
targetResourceType	string	Resurstyp för arm-målresursen, där aviseringen skapades.

MonitorCondition

Uppräkning

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

Värde	Description
Fired
Resolved

MonitorService

Uppräkning

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

Värde	Description
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

Uppräkning

Allvarlighetsgraden för avisering Sev0 är högst och Sev4 är lägst.

Värde	Description
Sev0
Sev1
Sev2
Sev3
Sev4

SignalType

Uppräkning

Typen av signal som aviseringen baseras på, vilket kan vara mått, loggar eller aktivitetsloggar.

Värde	Description
Log
Metric
Unknown

SortOrder

Uppräkning

Sortera frågeresultatordningen i antingen stigande eller fallande. Standardvärdet är "desc" för tidsfält och "asc" för andra.

Värde	Description
asc
desc

TimeRange

Uppräkning

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

Värde	Description
1d
1h
30d
7d

Dela via

Alerts - Get All

URI-parametrar

Svar

Exempel

ListAlerts

Exempelbegäran

Exempelsvar

Definitioner

actionStatus

alert

alertProperties

alertsList

AlertsSortByFields

AlertState

errorResponse

errorResponseBody

essentials

MonitorCondition

MonitorService

Severity

SignalType

SortOrder

TimeRange

Ytterligare resurser