デバイス ウイルス対策の正常性レポートをエクスポートする

適用対象:

• Microsoft Defender for Endpoint Plan 1
• Microsoft Defender for Endpoint Plan 2
• Microsoft Defender XDR

Microsoft Defender ATP を試してみたいですか? 無料試用版にサインアップしてください。

この API には、Microsoft Defender ウイルス対策デバイスウイルス対策の正常性の詳細を取得する 2 つの方法があります。

• 方法 1:1 正常性レポートのエクスポート (JSON 応答) メソッドは、組織内のすべてのデータを JSON 応答としてプルします。 この方法は、 100 K 未満のデバイスを持つ小規模な組織に最適です。 応答はページ分割されるため、応答の@odata.nextLink フィールドを使用して、次の結果をフェッチできます。

• 方法 2:2 (ファイルを使用して) 正常性レポートをエクスポートするこの 方法を使用すると、大量のデータをより迅速かつ確実にプルできます。 そのため、100 K を超えるデバイスを持つ大規模な組織におすすめです。 この API は、組織内のすべてのデータをダウンロード ファイルとしてプルします。 応答には、Azure Storage からすべてのデータをダウンロードするための URL が含まれています。 この API を使用すると、次のように Azure Storage からすべてのデータをダウンロードできます:

  • すべての組織データを含むダウンロード URL の一覧を取得するには、API を呼び出します。
  • ダウンロード URL を使用してすべてのファイルをダウンロードし、データを好きなように処理します。

"JSON 応答 または ファイル経由" を使用して収集されるデータは、現在の状態の現在のスナップショットです。 履歴データは含まれません。 履歴データを収集するには、お客様が独自のデータ ストレージにデータを保存する必要があります。 「 デバイス正常性の詳細 API のメソッドとプロパティをエクスポートする」を参照してください。

1 正常性レポートのエクスポート (JSON 応答)

1.1 API メソッドの説明

この API は、Microsoft Defender ウイルス対策デバイスのウイルス対策の正常性の詳細の一覧を取得します。 次の一意の組み合わせごとにエントリを持つテーブルを返します。

• DeviceId
• デバイス名
• AV モード
• 最新の状態
• スキャン結果

1.1.1 制限事項

• 最大ページ サイズは 200,000 です
• この API のレート制限は、1 分あたり 30 呼び出しと 1 時間あたり 1000 呼び出しです。

OData でサポートされる演算子

• $filter オン: machineId、 computerDnsName、 osKind、 osPlatform、 osVersion、 avMode、 avSignatureVersion、 avEngineVersionavPlatformVersion、 quickScanResult、 quickScanError、 fullScanResult、 fullScanError、 avIsSignatureUpToDate、 avIsEngineUpToDate、 avIsPlatformUpToDate、 rbacGroupId
• $top 最大値が 10,000 です。
• $skip

1.2 アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。 アクセス許可の選択方法など、詳細については、「エンドポイント API に Microsoft Defender を使用する」を参照してください。

1.3 URL (HTTP 要求)

URL: GET: /api/deviceavinfo

1.3.1 要求ヘッダー

1.3.2 要求本文

Empty

1.3.3 応答

成功した場合、このメソッドは 200 OK をデバイスの正常性の詳細のリストと共に返します。

1.4 パラメーター

• 既定のページ サイズは 20 です
• Microsoft Defender for Endpoint を使用した OData クエリの例を参照してください。

1.5 プロパティ

参照: 1.3 デバイスウイルス対策正常性の詳細 API プロパティのエクスポート (JSON 応答)

OData V4 クエリをサポートします。

1.6 例

要求の例

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

GET https://api.securitycenter.microsoft.com/api/deviceavinfo

応答の例

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

{

    @odata.context: "https://api.securitycenter.microsoft.com/api/$metadata#DeviceAvInfo",

"value": [{

            "id": "Sample Guid",

            "machineId": "Sample Machine Guid",

            "computerDnsName": "appblockstg1",

            "osKind": "windows",

            "osPlatform": "Windows10",

            "osVersion": "10.0.19044.1865",

            "avMode": "0",

            "avSignatureVersion": "1.371.1279.0",

            "avEngineVersion": "1.1.19428.0",

            "avPlatformVersion": "4.18.2206.108",

            "lastSeenTime": "2022-08-02T19:40:45Z",

            "quickScanResult": "Completed",

            "quickScanError": "",

            "quickScanTime": "2022-08-02T18:40:15.882Z",

            "fullScanResult": "",

            "fullScanError": "",

            "fullScanTime": null,

            "dataRefreshTimestamp": "2022-08-02T21:16:23Z",

            "avEngineUpdateTime": "2022-08-02T00:03:39Z",

            "avSignatureUpdateTime": "2022-08-02T00:03:39Z",

            "avPlatformUpdateTime": "2022-06-20T16:59:35Z",

            "avIsSignatureUpToDate": "True",

            "avIsEngineUpToDate": "True",

            "avIsPlatformUpToDate": "True",

            "avSignaturePublishTime": "2022-08-02T00:03:39Z",

            "rbacGroupName": "TVM1",

            "rbacGroupId": 4415

        },

        ...

     ]

}

2 正常性レポートのエクスポート (ファイル経由)

2.1 API メソッドの説明

この API 応答には、デバイスごとのウイルス対策の正常性と状態のすべてのデータが含まれています。 次の一意の組み合わせごとにエントリを持つテーブルを返します。

• DeviceId
• デバイス名
• AV モード
• 最新の状態
• スキャン結果

2.1.2 制限事項

• 最大ページ サイズは 200,000 です。
• この API のレート制限は、1 分あたり 30 呼び出しと 1 時間あたり 1000 呼び出しです。

2.2 権限

この API を呼び出すには、次のいずれかのアクセス許可が必要です。

アクセス許可の選択方法など、詳細については、「 Microsoft Defender for Endpoint API を使用する」を参照してください。

2.3 URL

GET /api/machines/InfoGatheringExport

2.4 パラメーター

• sasValidHours: ダウンロード URL が有効になる時間数 (最大 24 時間)。

2.5 プロパティ

「 1.4 デバイスウイルス対策の正常性の詳細 API プロパティをファイル経由でエクスポートする」を参照してください。

2.6 例

2.6.1 要求の例

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

GET https://api-us.securitycenter.contoso.com/api/machines/InfoGatheringExport

2.6.2 応答の例

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

{

   "@odata.context": "https://api-us.securitycenter.windows.com/api/$metadata#microsoft.windowsDefenderATP.api.ExportFilesResponse",

   "exportFiles": [

       "https://tvmexportexternalprdeus.blob.core.windows.net/temp-../2022-08-02/2201/InfoGatheringExport/json/OrgId=../_RbacGroupId=../part-00055-12fc2fcd-8f56-4e09-934f-e8efe7ce74a0.c000.json.gz?sv=2020-08-04&st=2022-08-02T22%3A47%3A11Z&se=2022-08-03T01%3A47%3A11Z&sr=b&sp=r&sig=..",

       "https://tvmexportexternalprdeus.blob.core.windows.net/temp-../2022-08-02/2201/InfoGatheringExport/json/OrgId=../_RbacGroupId=../part-00055-12fc2fcd-8f56-4e09-934f-e8efe7ce74a0.c000.json.gz?sv=2020-08-04&st=2022-08-02T22%3A47%3A11Z&se=2022-08-03T01%3A47%3A11Z&sr=b&sp=r&sig=.."

   ],


   "generatedTime": "2022-08-02T22:01:00Z"


}

関連項目

デバイスの正常性のメソッドとプロパティをエクスポートする

デバイスの正常性とコンプライアンスのレポート