Alerts - Get All

Referentie

Service:: Monitor

API-versie:: 2023-07-12-preview

Alle bestaande waarschuwingen weergeven, waarbij de resultaten kunnen worden gefilterd op basis van meerdere parameters (bijvoorbeeld tijdsbereik). De resultaten kunnen vervolgens worden gesorteerd op basis van specifieke velden, waarbij de standaardwaarde lastModifiedDateTime is.

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

Met optionele 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

URI-parameters

Name	In	Vereist	Type	Description
scope	path	True	string	scope hier is resourceId waarvoor de waarschuwing wordt gemaakt.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.
alertRule	query		string	Filteren op specifieke waarschuwingsregel. De standaardwaarde is om alles te selecteren.
alertState	query		AlertState	Filter op status van het waarschuwingsexemplaar. De standaardwaarde is om alles te selecteren.
customTimeRange	query		string	Filter op aangepast tijdsbereik in de notatie /waar de tijd zich bevindt in (ISO-8601-indeling)'. Toegestane waarden zijn binnen 30 dagen na de querytijd. TimeRange of customTimeRange kan worden gebruikt, maar niet beide. Standaardinstelling is geen.
includeContext	query		boolean	Context opnemen die contextuele gegevens bevat die specifiek zijn voor de bewakingsservice. De standaardwaarde is onwaar'
includeEgressConfig	query		boolean	Neem de uitgaande configuratie op die wordt gebruikt voor het weergeven van de inhoud in de portal. De standaardwaarde is 'false'.
monitorCondition	query		MonitorCondition	Filter op monitorvoorwaarde die 'Geactiveerd' of 'Opgelost' is. De standaardwaarde is om alles te selecteren.
monitorService	query		MonitorService	Filter op bewakingsservice die het waarschuwingsexemplaar genereert. De standaardwaarde is Alles selecteren.
pageCount	query		integer int64	Hiermee bepaalt u het aantal waarschuwingen dat per pagina in antwoord wordt geretourneerd. De toegestane waarde ligt tussen 1 en 250. Wanneer het filter includeContent is geselecteerd, is de maximaal toegestane waarde 25. De standaardwaarde is 25.
select	query		string	Met dit filter kunt u de velden (door komma's gescheiden) selecteren die deel uitmaken van de essentiële sectie. Hierdoor kunnen alleen de vereiste velden worden geprojected in plaats van de volledige inhoud op te halen. Standaard worden alle velden in de sectie Essentials opgehaald.
severity	query		Severity	Filteren op ernst. De standaardwaarde is Alles selecteren.
smartGroupId	query		string	Filter de lijst met waarschuwingen op de id van de slimme groep. De standaardwaarde is geen.
sortBy	query		AlertsSortByFields	Sorteer de queryresultaten op invoerveld, de standaardwaarde is 'lastModifiedDateTime'.
sortOrder	query		SortOrder	Sorteer de volgorde van de queryresultaten in oplopende of aflopende volgorde. De standaardwaarde is 'desc' voor tijdvelden en 'asc' voor andere velden.
targetResource	query		string	Filteren op doelresource (dit is volledige ARM-id) De standaardwaarde is alles selecteren.
targetResourceGroup	query		string	Filter op de naam van de doelresourcegroep. De standaardwaarde is Alles selecteren.
targetResourceType	query		string	Filteren op doelresourcetype. De standaardwaarde is Alles selecteren.
timeRange	query		TimeRange	Filter op tijdsbereik op onderstaande waarden. De standaardwaarde is 1 dag.

Antwoorden

Name	Type	Description
200 OK	alertsList	OK. Waarschuwingsobjecten zijn weergegeven.
Other Status Codes	errorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Voorbeelden

ListAlerts

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

Definities

Name	Description
actionStatus	Actiestatus
alert	Een waarschuwing die is gemaakt in de service voor waarschuwingsbeheer.
alertProperties	Eigenschappenverzameling waarschuwing
alertsList	Vermeld de waarschuwingen.
AlertsSortByFields	Sorteer de queryresultaten op invoerveld, de standaardwaarde is 'lastModifiedDateTime'.
AlertState	Status van waarschuwingsobject, die door de gebruiker kan worden gewijzigd.
errorResponse	Een foutreactie van de service.
errorResponseBody	Details van de foutreactie.
essentials	Dit object bevat consistente velden in verschillende bewakingsservices.
MonitorCondition	Voorwaarde van de regel bij de bewakingsservice. Hiermee wordt aangegeven of de onderliggende voorwaarden de gedefinieerde drempelwaarden voor de waarschuwingsregel hebben overschreden.
MonitorService	Bewaak de service waarop de regel (monitor) is ingesteld.
Severity	De ernst van de waarschuwing Sev0 is het hoogst en Sev4 is het laagst.
SignalType	Het type signaal waarop de waarschuwing is gebaseerd. Dit kunnen metrische gegevens, logboeken of activiteitenlogboeken zijn.
SortOrder	Sorteer de volgorde van de queryresultaten in oplopende of aflopende volgorde. De standaardwaarde is 'desc' voor tijdvelden en 'asc' voor andere velden.
TimeRange	Filter op tijdsbereik op onderstaande waarden. De standaardwaarde is 1 dag.

actionStatus

Actiestatus

Name	Type	Description
isSuppressed	boolean	Waarde die aangeeft of de waarschuwing wordt onderdrukt.

alert

Een waarschuwing die is gemaakt in de service voor waarschuwingsbeheer.

Name	Type	Description
id	string	Azure-resource-id
name	string	Azure-resourcenaam
properties	alertProperties	Eigenschappenverzameling waarschuwing
type	string	Azure-resourcetype

alertProperties

Eigenschappenverzameling waarschuwing

Name	Type	Description
context	object	Informatie die specifiek is voor de bewakingsservice die meer contextuele details over de waarschuwing geeft.
egressConfig	object	Configuratie die wordt gebruikt voor het weergeven van de gegevens in de portal.
essentials	essentials	Dit object bevat consistente velden in verschillende bewakingsservices.

alertsList

Vermeld de waarschuwingen.

Name	Type	Description
nextLink	string	URL voor het ophalen van de volgende set waarschuwingen.
value	alert[]	Lijst met waarschuwingen

AlertsSortByFields

Sorteer de queryresultaten op invoerveld, de standaardwaarde is 'lastModifiedDateTime'.

Name	Type	Description
alertState	string
lastModifiedDateTime	string
monitorCondition	string
name	string
severity	string
startDateTime	string
targetResource	string
targetResourceGroup	string
targetResourceName	string
targetResourceType	string

AlertState

Status van waarschuwingsobject, die door de gebruiker kan worden gewijzigd.

Name	Type	Description
Acknowledged	string
Closed	string
New	string

errorResponse

Een foutreactie van de service.

Name	Type	Description
error	errorResponseBody	Details van de foutreactie.

errorResponseBody

Details van de foutreactie.

Name	Type	Description
code	string	Foutcode, bedoeld om programmatisch te worden gebruikt.
details	errorResponseBody[]	Een lijst met aanvullende informatie over de fout.
message	string	Beschrijving van de fout, bedoeld voor weergave in de gebruikersinterface.
target	string	Doel van de specifieke fout, bijvoorbeeld de naam van de eigenschap.

essentials

Dit object bevat consistente velden in verschillende bewakingsservices.

Name	Type	Description
actionStatus	actionStatus	Actiestatus
alertRule	string	Regel (monitor) die waarschuwingsexemplaar heeft geactiveerd. Afhankelijk van de monitorservice is dit arm-id of de naam van de regel.
alertState	AlertState	Status van waarschuwingsobject, die door de gebruiker kan worden gewijzigd.
description	string	Beschrijving van waarschuwing.
lastModifiedDateTime	string	Laatste wijzigingstijd (ISO-8601-indeling) van waarschuwingsexemplaar.
lastModifiedUserName	string	Gebruiker die de waarschuwing het laatst heeft gewijzigd, in het geval van het controleren van service-updates zou de gebruiker 'systeem' zijn, anders de naam van de gebruiker.
monitorCondition	MonitorCondition	Voorwaarde van de regel bij de bewakingsservice. Hiermee wordt aangegeven of de onderliggende voorwaarden de gedefinieerde drempelwaarden voor de waarschuwingsregel hebben overschreden.
monitorConditionResolvedDateTime	string	Opgeloste tijd (ISO-8601-indeling) van waarschuwingsexemplaar. Dit wordt bijgewerkt wanneer de bewakingsservice het waarschuwingsexemplaar oplost omdat niet meer aan de regelvoorwaarde wordt voldaan.
monitorService	MonitorService	Bewaak de service waarop de regel (monitor) is ingesteld.
severity	Severity	De ernst van de waarschuwing Sev0 is het hoogst en Sev4 is het laagst.
signalType	SignalType	Het type signaal waarop de waarschuwing is gebaseerd. Dit kunnen metrische gegevens, logboeken of activiteitenlogboeken zijn.
smartGroupId	string	Unieke id van de slimme groep
smartGroupingReason	string	Uitgebreide reden die de reden beschrijft waarom dit waarschuwingsexemplaar wordt toegevoegd aan een slimme groep
sourceCreatedId	string	Unieke id die is gemaakt door de bewakingsservice voor elk waarschuwingsexemplaar. Dit kan worden gebruikt om het probleem bij de bewakingsservice bij te houden, in het geval van Nagios, Zabbix, SCOM, enzovoort.
startDateTime	string	Aanmaaktijd (ISO-8601-indeling) van waarschuwingsexemplaar.
targetResource	string	Arm-doelresource, waarvoor de waarschuwing is gemaakt.
targetResourceGroup	string	Resourcegroep van arm-doelresource, waarvoor de waarschuwing is gemaakt.
targetResourceName	string	Naam van de arm-doelresourcenaam, waarvoor de waarschuwing is gemaakt.
targetResourceType	string	Resourcetype van de ARM-doelresource, waarvoor een waarschuwing is gemaakt.

MonitorCondition

Voorwaarde van de regel bij de bewakingsservice. Hiermee wordt aangegeven of de onderliggende voorwaarden de gedefinieerde drempelwaarden voor de waarschuwingsregel hebben overschreden.

Name	Type	Description
Fired	string
Resolved	string

MonitorService

Bewaak de service waarop de regel (monitor) is ingesteld.

Name	Type	Description
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

De ernst van de waarschuwing Sev0 is het hoogst en Sev4 is het laagst.

Name	Type	Description
Sev0	string
Sev1	string
Sev2	string
Sev3	string
Sev4	string

SignalType

Het type signaal waarop de waarschuwing is gebaseerd. Dit kunnen metrische gegevens, logboeken of activiteitenlogboeken zijn.

Name	Type	Description
Log	string
Metric	string
Unknown	string

SortOrder

Sorteer de volgorde van de queryresultaten in oplopende of aflopende volgorde. De standaardwaarde is 'desc' voor tijdvelden en 'asc' voor andere velden.

Name	Type	Description
asc	string
desc	string

TimeRange

Filter op tijdsbereik op onderstaande waarden. De standaardwaarde is 1 dag.

Name	Type	Description
1d	string
1h	string
30d	string
7d	string

Delen via