导出设备防病毒软件运行状况报告

适用于：

• Microsoft Defender for Endpoint 计划 1
• Microsoft Defender for Endpoint 计划 2
• Microsoft Defender XDR

希望体验 Microsoft Defender for Endpoint？ 注册免费试用版。

此 API 有两种方法可以检索Microsoft Defender 防病毒设备防病毒运行状况详细信息：

• 方法 1：1 导出运行状况报告 (JSON 响应) 此方法将组织中的所有数据作为 JSON 响应拉取。 此方法最适合 设备少于 100-K 的小型组织。 响应是分页的，因此可以使用响应中的 @odata.nextLink 字段来提取下一个结果。

• 方法 2：2 通过文件 导出运行状况报告 () 此方法可更快、更可靠地拉取大量数据。 因此，建议将它用于具有 100 K 个以上的设备的大型组织。 此 API 将组织中的所有数据作为下载文件拉取。 响应包含用于从 Azure 存储下载所有数据的 URL。 通过此 API，可以从 Azure 存储下载所有数据，如下所示：

  • 调用 API 以获取包含所有组织数据的下载 URL 列表。
  • 使用下载 URL 下载所有文件，并根据需要处理数据。

使用“JSON 响应 或通过 文件”收集的数据是当前状态的当前快照。 它不包含历史数据。 若要收集历史数据，客户必须将数据保存在自己的数据存储中。 请参阅 导出设备运行状况详细信息 API 方法和属性。

1 导出运行状况报告 (JSON 响应)

1.1 API 方法说明

此 API 检索Microsoft Defender 防病毒设备防病毒运行状况详细信息的列表。 返回一个表，其中包含以下各项的唯一组合的条目：

• DeviceId
• 设备名称
• AV 模式
• 最新状态
• 扫描结果

1.1.1 限制

• 最大页面大小为 200,000
• 此 API 的速率限制是每分钟 30 个调用和每小时 1000 个调用。

OData 支持的运算符

• $filteron：machineId、computerDnsName、、osKind、osPlatform、avModeosVersion、avSignatureVersionavPlatformVersionavEngineVersion、quickScanResult、quickScanError、fullScanResult、、fullScanError、avIsSignatureUpToDate、、avIsEngineUpToDate、、 avIsPlatformUpToDaterbacGroupId
• $top 最大值为 10,000。
• $skip

1.2 权限

要调用此 API，需要以下权限之一。 若要了解详细信息（包括如何选择权限），请参阅使用 Microsoft Defender for Endpoint API 了解详细信息。

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 的速率限制是每分钟 30 个调用和每小时 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"


}

另请参阅

导出设备运行状况方法和属性

设备运行状况和合规性报告