Share via


Alerts - Get By Id

Hämta en specifik avisering.
Hämta information om en specifik avisering

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

URI-parametrar

Name I Obligatorisk Typ Description
alertId
path True

string

Unikt ID för en aviseringsinstans.

scope
path True

string

omfånget här är resourceId som aviseringen skapas för.

api-version
query True

string

Den API-version som ska användas för den här åtgärden.

Svar

Name Typ Description
200 OK

alert

OK. Returnerar aviseringen med angivet ID.

Other Status Codes

errorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Exempel

GetById

Sample Request

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

Sample Response

{
  "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"
}

Definitioner

Name Description
actionStatus

Åtgärdsstatus

alert

En avisering som skapats i aviseringshanteringstjänsten.

alertProperties

Aviseringsegenskapsväska

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 den tjänst som regeln (övervakaren) har angetts för.

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.

actionStatus

Åtgärdsstatus

Name Typ Description
isSuppressed

boolean

Värde som anger om aviseringen ignoreras.

alert

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

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.

AlertState

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

Name Typ Description
Acknowledged

string

Closed

string

New

string

errorResponse

Ett felsvar från tjänsten.

Name Typ Description
error

errorResponseBody

Information om felsvar.

errorResponseBody

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

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

Name Typ Description
actionStatus

actionStatus

Åtgärdsstatus

alertRule

string

Regel (övervakare) som utlöste aviseringsinstansen. Beroende på övervakningstjänsten är detta ARM-ID eller namnet på regeln.

alertState

AlertState

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

description

string

Aviseringsbeskrivning.

lastModifiedDateTime

string

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

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 den tjänst som regeln (övervakaren) har angetts för.

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

Skapandetid (ISO-8601-format) för aviseringsinstansen.

targetResource

string

Arm-målresurs, där aviseringen skapades.

targetResourceGroup

string

Resursgrupp för arm-målresursen, 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

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

Name Typ Description
Fired

string

Resolved

string

MonitorService

Övervaka den tjänst som regeln (övervakaren) har angetts för.

Name Typ 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

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

Name Typ Description
Sev0

string

Sev1

string

Sev2

string

Sev3

string

Sev4

string

SignalType

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

Name Typ Description
Log

string

Metric

string

Unknown

string