Перечисление оповещений

Пространство имен: microsoft.graph

Получение списка объектов alert.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба	Правительство США L4	Правительство США L5 (DOD)	Китай управляется 21Vianet
✅	✅	✅	❌

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения	Разрешения с наименьшими привилегиями	Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись)	SecurityEvents.Read.All	SecurityEvents.ReadWrite.All
Делегированные (личная учетная запись Майкрософт)	Не поддерживается.	Не поддерживается.
Приложение	SecurityEvents.Read.All	SecurityEvents.ReadWrite.All

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}'

Необязательные параметры запросов

Этот метод поддерживает указанные ниже параметры запросов OData для настройки отклика.

• $count
• $orderby
• $select
• $skip
• $top – Возвращает объединенные лучшие результаты от каждого поставщика API безопасности.
• $filter

В таблице ниже перечислены ключевые слова $filter по именам поставщиков. Несмотря на то, что некоторые из этих продуктов поменяли название в ходе ребрендинга, API еще не обновлен. Ключевые слова фильтра будут продолжать использовать устаревшие названия до дальнейшего уведомления. Подробности см. в журнале изменений.

Наименование поставщика	ключевое слово $filter
Microsoft Defender для удостоверений	Расширенная защита от угроз Azure
Центр безопасности Azure	ASC
Microsoft Defender for Cloud Apps	MCAS
Защита Microsoft Entra ID	IPC
Microsoft Sentinel	Azure Sentinel
Microsoft Defender для конечной точки	ATP в Защитнике Windows
Office 365	В настоящее время не поддерживается.

Примечание: Некоторые поставщики могут не поддерживать $filter ключевые слова.

Чтобы вернуть альтернативный набор свойств, используйте параметр запроса OData $select , чтобы указать набор свойств оповещений , которые требуется. Например, чтобы вернуть свойства assignedTo, category и severity , добавьте в запрос следующее: $select=assignedTo,category,severity.

Примечание. Параметр запроса OData $top имеет ограничение в 1000 оповещений. В первый запрос GET рекомендуется включить только параметр $top, но не параметр $skip. Для разбивки на страницы можно использовать параметр @odata.nextLink. Если требуется применить параметр $skip, он имеет ограничение в 500 оповещений. Например, /security/alerts?$top=10&$skip=500 вернет код отклика 200 OK, но /security/alerts?$top=10&$skip=501 вернет код отклика 400 Bad Request. Дополнительные сведения см. в статье Ответы с ошибками Microsoft Graph Security API.

Заголовки запросов

Имя	Описание
Авторизация	Bearer {код}. Обязательно.

Текст запроса

Не указывайте текст запроса для этого метода. Текст запроса будет игнорироваться.

Отклик

В случае успеха этот метод возвращает код отклика 200 OK и коллекцию объектов alert в тексте отклика. Если от поставщика возвращается код состояния, отличный от 2xx или 404, или истекло время ожидания поставщика, откликом будет код состояния 206 Partial Content с ответом поставщика в заголовке предупреждения. Дополнительные сведения см. в статье Ответы с ошибками Microsoft Graph Security API.

Пример

Запрос

Ниже показан пример запроса.

HTTP

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

C#

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Security.Alerts.GetAsync();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc security alerts list

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



alerts, err := graphClient.Security().Alerts().Get(context.Background(), nil)

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

AlertCollectionResponse result = graphClient.security().alerts().get();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let alerts = await client.api('/security/alerts')
	.get();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->security()->alerts()->get()->wait();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

PowerShell

Import-Module Microsoft.Graph.Security

Get-MgSecurityAlert

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Python

from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


result = await graph_client.security.alerts.get()

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Отклик

Ниже показан пример отклика.

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

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