Répertorier les alertes

Espace de noms: microsoft.graph

Récupérer une liste d’objets alerte.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) SecurityEvents.Read.All SecurityEvents.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application SecurityEvents.Read.All SecurityEvents.ReadWrite.All

Requête HTTP

GET /security/alerts
GET /security/alerts?$top=1
GET /security/alerts?$filter={property} eq '{property-value}'
GET /security/alerts?$filter={property} eq '{property-value}'&$top=5
GET /security/alerts?$filter={property} eq '{property-value}' and {property} eq '{property-value}'

Paramètres facultatifs de la requête

Cette méthode prend en charge les paramètres de requête OData suivants pour vous aider à personnaliser la réponse :

  • $count
  • $orderby
  • $select
  • $skip
  • $top Renvoie les meilleurs résultats agrégés de chaque fournisseur d’API de sécurité.
  • $filter

Le tableau suivant répertorie $filter les mots clés par nom de fournisseur. Même si certains de ces produits ont été renommés, l’API n’est pas encore mise à jour. Les mots clés de filtre continueront d’utiliser les noms hérités jusqu’à nouvel ordre. Consultez le journal des modifications pour connaître les mises à jour.

Nom de fournisseur mot clé $filter
Microsoft Defender pour l’identité Azure Advanced Threat Protection
Azure Security Center CROIS.
Microsoft Defender for Cloud Apps MCAS
Protection Microsoft Entra ID IPC
Microsoft Sentinel Azure Sentinel
Microsoft Defender pour point de terminaison Microsoft Defender ATP
Office 365 N’est pas pris en charge actuellement.

Note: Certains fournisseurs peuvent ne pas prendre en charge les $filter mots clés.

Pour renvoyer un autre jeu de propriétés, utilisez le paramètre de requête OData $select pour spécifier le jeu de propriétés d’alerte que vous souhaitez. Par exemple, pour retourner les propriétés assignedTo, category et severity , ajoutez les éléments suivants à votre requête : $select=assignedTo,category,severity.

Remarque : le $top paramètre de requête OData a une limite de 1000 alertes. Nous vous recommandons d’inclure uniquement $top et non $skip dans la première requête obtenir. Vous pouvez utiliser @odata.nextLink pour la pagination. Si vous devez utiliser $skip, la limite est de 500 alertes. Par exemple, /security/alerts?$top=10&$skip=500 renvoie un code de réponse 200 OK, et /security/alerts?$top=10&$skip=501 un code de réponse 400 Bad Request. Pour plus d’informations, voir Réponses d’erreur de l’API Microsoft Graph Security.

En-têtes de demande

Nom Description
Autorisation Porteur {code}. Obligatoire.

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode. Le corps de la demande est ignoré.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 200 OK et la collection d’objets alerte dans le corps de la réponse. Si un code d’état autre que 2xx ou 404 est renvoyé par un fournisseur ou si un fournisseur expire, la réponse est un code d’état 206 Partial Content avec la réponse du fournisseur dans un en-tête d’avertissement. Pour plus d’informations, voir Réponses d’erreur de l’API Microsoft Graph Security.

Exemple

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/v1.0/security/alerts

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": [
    {
      "activityGroupName": "activityGroupName-value",
      "assignedTo": "assignedTo-value",
      "azureSubscriptionId": "azureSubscriptionId-value",
      "azureTenantId": "azureTenantId-value",
      "category": "category-value",
      "closedDateTime": "datetime-value"
    }
  ]
}