アラートを一覧表示する

名前空間: microsoft.graph

alert オブジェクトのリストを取得する。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス	米国政府機関 L4	米国政府機関 L5 (DOD)	21Vianet が運営する中国
✅	✅	✅	❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください。

アクセス許可の種類	最小特権アクセス許可	特権の高いアクセス許可
委任 (職場または学校のアカウント)	SecurityEvents.Read.All	SecurityEvents.ReadWrite.All
委任 (個人用 Microsoft アカウント)	サポートされていません。	サポートされていません。
アプリケーション	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 はまだ更新されていません。 フィルター キーワードは、さらなる通知がされるまで、従来の名前を引き続き使用します。 更新プログラムについては、changelog を参照してください。

ベンダー名	$filter キーワード
Microsoft Defender for Identity	Azure Advanced Threat Protection
Azure Security Center	ASC
Microsoft Defender for Cloud Apps	MCAS
Microsoft Entra ID 保護	IPC
Microsoft Sentinel	Azure Sentinel
Microsoft Defender for Endpoint	Microsoft Defender ATP
Office 365	現在サポートされていません。

メモ： 一部のプロバイダーでは、キーワードがサポート $filter されていない場合があります。

代替プロパティ セットを返すには、OData $select クエリ パラメーターを使用して、必要な アラート プロパティのセットを指定します。たとえば、 assignedTo、 category、 および severity プロパティを返すには、クエリに 次を追加します $select=assignedTo,category,severity。

注:$top OData クエリ パラメーターには、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 グラフ セキュリティ API のエラー応答」を参照してください。

要求ヘッダー

名前	説明
Authorization	ベアラー {code}。 必須です。

要求本文

このメソッドには、要求本文を指定しません。 要求本文は無視されます。

応答

成功した場合、このメソッドは応答コード 200 OK と alert オブジェクトのコレクションを応答本文で返します。 プロバイダーから 2xx または 404 以外の状態コードが返されるか、プロバイダーがタイムアウトした場合、応答は、警告ヘッダー内のプロバイダーの応答と共に状態コード 206 Partial Content になります。 詳細については、「Microsoft グラフ セキュリティ 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

mgc security alerts list

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

Go

// Code snippets are only available for the latest major version. Current major version is $v1.*

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


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
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

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

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