フィードバック 編集

アラートを一覧表示する

  • [アーティクル]

名前空間: microsoft.graph

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

アクセス許可

この 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
Azure Active Directory Identity Protection IPC
Azure Sentinel Azure Sentinel
Microsoft Defender for Endpoint Microsoft Defender ATP
Office 365 現在サポートされていません。

別のプロパティ セットを返すには、OData $select クエリ パラメーターを使用し、目的の alert プロパティのセットを指定します。 例えば、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 のエラー応答」を参照してください。

例

要求

要求の例を次に示します。

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

応答

応答の例を次に示します。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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