Partager via

Alerts - Get All

  • Référence
Service:
Monitor
Version d'API:
2023-07-12-preview

Répertorier toutes les alertes existantes, où les résultats peuvent être filtrés sur la base de plusieurs paramètres (par exemple, intervalle de temps). Les résultats peuvent ensuite être triés sur la base de champs spécifiques, avec la valeur par défaut lastModifiedDateTime.

GET https://management.azure.com/{scope}/providers/Microsoft.AlertsManagement/alerts?api-version=2023-07-12-preview
Avec des paramètres facultatifs: 
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

Paramètres URI

Nom Dans Obligatoire Type Description
scope
 path True

string

l’étendue ici est resourceId pour laquelle l’alerte est créée.
api-version
 query True

string

minLength: 1

Version de l’API à utiliser pour cette opération.
alertRule
 query

string

Filtrez par règle d’alerte spécifique. La valeur par défaut consiste à sélectionner tout.
alertState
 query

AlertState

Filtrez par état de l’instance d’alerte. La valeur par défaut consiste à sélectionner tout.
customTimeRange
 query

string

Filtrez par intervalle de temps personnalisé au format /où l’heure est au format (format ISO-8601)'. Les valeurs autorisées sont comprises dans les 30 jours suivant l’heure de la requête. TimeRange ou customTimeRange peut être utilisé, mais pas les deux. La valeur par défaut n’est aucune.
includeContext
 query

boolean

Incluez le contexte qui a des données contextuelles spécifiques au service de surveillance. La valeur par défaut est false'
includeEgressConfig
 query

boolean

Incluez la configuration de sortie qui serait utilisée pour afficher le contenu dans le portail. La valeur par défaut est « false ».
monitorCondition
 query

MonitorCondition

Filtrez par condition de surveillance qui est « Déclenché » ou « Résolu ». La valeur par défaut consiste à sélectionner tout.
monitorService
 query

MonitorService

Filtrez par service de surveillance qui génère l’instance d’alerte. La valeur par défaut est tout sélectionnée.
pageCount
 query

integer (int64)

Détermine le nombre d’alertes retournées par page en réponse. La valeur autorisée est comprise entre 1 et 250. Lorsque le filtre « includeContent » est sélectionné, la valeur maximale autorisée est 25. La valeur par défaut est 25.
select
 query

string

Ce filtre permet de sélectionner les champs (séparés par des virgules) qui font partie de la section essentielle. Cela permet de projeter uniquement les champs requis plutôt que d’obtenir du contenu entier. La valeur par défaut consiste à extraire tous les champs de la section Essentials.
severity
 query

Severity

Filtrer par gravité. La valeur par défaut est tout sélectionnée.
smartGroupId
 query

string

Filtrez la liste des alertes par id de groupe intelligent. La valeur par défaut n’est pas.
sortBy
 query

AlertsSortByFields

Triez les résultats de la requête par champ d’entrée, la valeur par défaut est « lastModifiedDateTime ».
sortOrder
 query

SortOrder

Triez l’ordre des résultats de la requête dans l’ordre croissant ou décroissant. La valeur par défaut est « desc » pour les champs de temps et « asc » pour d’autres personnes.
targetResource
 query

string

Filtrez par ressource cible( qui est l’ID ARM complet) La valeur par défaut est sélectionnée.
targetResourceGroup
 query

string

Filtrez par nom de groupe de ressources cible. La valeur par défaut est tout sélectionnée.
targetResourceType
 query

string

Filtrez par type de ressource cible. La valeur par défaut est tout sélectionnée.
timeRange
 query

TimeRange

Filtrez par intervalle de temps les valeurs répertoriées ci-dessous. La valeur par défaut est 1 jour.

Réponses

Nom Type Description
200 OK

alertsList

D’ACCORD. Objets d’alerte répertoriés avec succès.
Other Status Codes

errorResponse

Réponse d’erreur décrivant pourquoi l’opération a échoué.

Exemples

ListAlerts

Exemple de requête

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

Exemple de réponse

Code d’état:
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"
    }
  ]
}

Définitions

Nom Description
actionStatus

État d’action
alert

Alerte créée dans le service de gestion des alertes.
alertProperties

Conteneur de propriétés d’alerte
alertsList

Répertoriez les alertes.
AlertsSortByFields

Triez les résultats de la requête par champ d’entrée, la valeur par défaut est « lastModifiedDateTime ».
AlertState

État de l’objet d’alerte, qui peut être modifié par l’utilisateur.
errorResponse

Réponse d’erreur du service.
errorResponseBody

Détails de la réponse d’erreur.
essentials

Cet objet contient des champs cohérents entre différents services de surveillance.
MonitorCondition

Condition de la règle au niveau du service d’analyse. Elle indique si les conditions sous-jacentes ont franchi les seuils de règle d’alerte définis.
MonitorService

Surveiller le service sur lequel la règle(monitor) est définie.
Severity

Gravité de l’alerte Sev0 étant la plus élevée et Sev4 étant le plus bas.
SignalType

Le type de signal sur lequel l’alerte est basée, qui peut être des métriques, des journaux d’activité ou des journaux d’activité.
SortOrder

Triez l’ordre des résultats de la requête dans l’ordre croissant ou décroissant. La valeur par défaut est « desc » pour les champs de temps et « asc » pour d’autres personnes.
TimeRange

Filtrez par intervalle de temps les valeurs répertoriées ci-dessous. La valeur par défaut est 1 jour.

actionStatus

Object

État d’action

Nom Type Description
isSuppressed

boolean

Valeur indiquant si l’alerte est supprimée.

alert

Object

Alerte créée dans le service de gestion des alertes.

Nom Type Description
id

string

ID de ressource Azure
name

string

Nom de la ressource Azure
properties

alertProperties

Conteneur de propriétés d’alerte
type

string

Type de ressource Azure

alertProperties

Object

Conteneur de propriétés d’alerte

Nom Type Description
context

object

Informations spécifiques au service de surveillance qui donnent des détails contextuels sur l’alerte.
egressConfig

object

Configuration qui serait utilisée pour afficher les données dans le portail.
essentials

essentials

Cet objet contient des champs cohérents entre différents services de surveillance.

alertsList

Object

Répertoriez les alertes.

Nom Type Description
nextLink

string

URL permettant d’extraire le jeu d’alertes suivant.
value

alert[]

Liste des alertes

AlertsSortByFields

Énumération

Triez les résultats de la requête par champ d’entrée, la valeur par défaut est « lastModifiedDateTime ».

Valeur Description
alertState
lastModifiedDateTime
monitorCondition
name
severity
startDateTime
targetResource
targetResourceGroup
targetResourceName
targetResourceType

AlertState

Énumération

État de l’objet d’alerte, qui peut être modifié par l’utilisateur.

Valeur Description
Acknowledged
Closed
New

errorResponse

Object

Réponse d’erreur du service.

Nom Type Description
error

errorResponseBody

Détails de la réponse d’erreur.

errorResponseBody

Object

Détails de la réponse d’erreur.

Nom Type Description
code

string

Code d’erreur destiné à être consommé par programme.
details

errorResponseBody[]

Liste des détails supplémentaires sur l’erreur.
message

string

Description de l’erreur, destinée à être affichée dans l’interface utilisateur.
target

string

Cible de l’erreur particulière, par exemple le nom de la propriété.

essentials

Object

Cet objet contient des champs cohérents entre différents services de surveillance.

Nom Type Description
actionStatus

actionStatus

État d’action
alertRule

string

Rule(monitor) qui a déclenché l’instance d’alerte. Selon le service de surveillance, il s’agit de l’ID ARM ou du nom de la règle.
alertState

AlertState

État de l’objet d’alerte, qui peut être modifié par l’utilisateur.
description

string

Description de l’alerte.
lastModifiedDateTime

string (date-time)

Heure de dernière modification (format ISO-8601) de l’instance d’alerte.
lastModifiedUserName

string

L’utilisateur qui a modifié l’alerte pour la dernière fois, en cas de surveillance des mises à jour du service, serait « système », sinon le nom de l’utilisateur.
monitorCondition

MonitorCondition

Condition de la règle au niveau du service d’analyse. Elle indique si les conditions sous-jacentes ont franchi les seuils de règle d’alerte définis.
monitorConditionResolvedDateTime

string (date-time)

Heure résolue (format ISO-8601) de l’instance d’alerte. Cette opération est mise à jour lorsque le service de surveillance résout l’instance d’alerte, car la condition de règle n’est plus remplie.
monitorService

MonitorService

Surveiller le service sur lequel la règle(monitor) est définie.
severity

Severity

Gravité de l’alerte Sev0 étant la plus élevée et Sev4 étant le plus bas.
signalType

SignalType

Le type de signal sur lequel l’alerte est basée, qui peut être des métriques, des journaux d’activité ou des journaux d’activité.
smartGroupId

string

ID unique du groupe intelligent
smartGroupingReason

string

Raison détaillée décrivant la raison pour laquelle cette instance d’alerte est ajoutée à un groupe intelligent
sourceCreatedId

string

ID unique créé par le service de surveillance pour chaque instance d’alerte. Cela peut être utilisé pour suivre le problème au niveau du service de surveillance, en cas de Nagios, Zabbix, SCOM, etc.
startDateTime

string (date-time)

Heure de création (format ISO-8601) de l’instance d’alerte.
targetResource

string

Ressource ARM cible sur laquelle l’alerte a été créée.
targetResourceGroup

string

Groupe de ressources de la ressource ARM cible sur laquelle l’alerte a été créée.
targetResourceName

string

Nom du nom de la ressource ARM cible sur laquelle l’alerte a été créée.
targetResourceType

string

Type de ressource de la ressource ARM cible sur laquelle l’alerte a été créée.

MonitorCondition

Énumération

Condition de la règle au niveau du service d’analyse. Elle indique si les conditions sous-jacentes ont franchi les seuils de règle d’alerte définis.

Valeur Description
Fired
Resolved

MonitorService

Énumération

Surveiller le service sur lequel la règle(monitor) est définie.

Valeur 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

Énumération

Gravité de l’alerte Sev0 étant la plus élevée et Sev4 étant le plus bas.

Valeur Description
Sev0
Sev1
Sev2
Sev3
Sev4

SignalType

Énumération

Le type de signal sur lequel l’alerte est basée, qui peut être des métriques, des journaux d’activité ou des journaux d’activité.

Valeur Description
Log
Metric
Unknown

SortOrder

Énumération

Triez l’ordre des résultats de la requête dans l’ordre croissant ou décroissant. La valeur par défaut est « desc » pour les champs de temps et « asc » pour d’autres personnes.

Valeur Description
asc
desc

TimeRange

Énumération

Filtrez par intervalle de temps les valeurs répertoriées ci-dessous. La valeur par défaut est 1 jour.

Valeur Description
1d
1h
30d
7d