导出每个设备的硬件和固件评估清单

项目
04/26/2024

适用于：

想要体验Microsoft Defender 漏洞管理？详细了解如何注册Microsoft Defender 漏洞管理公共预览版试用版。

可通过不同的 API 调用来获取不同类型的数据。通常，每个 API 调用都包含组织中设备的必要数据。

JSON 响应 API 会将组织中的所有数据作为 JSON 响应进行拉取。此方法最适合 设备少于 100-K 的小型组织。响应是分页的，因此可以使用响应中的 @odata.nextLink 字段来提取下一个结果。
通过文件 借助此 API 解决方案，可以更快、更可靠地拉取大量数据。因此，建议将它用于具有 100 K 个以上的设备的大型组织。此 API 将组织中的所有数据作为下载文件拉取。响应包含用于从 Azure 存储下载所有数据的 URL。可以从 Azure 存储下载数据，如下所示：
- 调用 API 以获取包含所有组织数据的下载 URL 列表。
- 使用下载 URL 下载所有文件，并根据需要处理数据。

使用“JSON 响应或通过文件”收集的数据是当前状态的当前快照。它不包含历史数据。若要收集历史数据，客户必须将数据保存在自己的数据存储中。

注意

除非另有说明，否则列出的所有导出硬件和固件评估方法都是 完全导出 的， 并且按设备 (也称为 按设备)

1. 导出硬件和固件评估 (JSON 响应)

1.1 API 方法说明

返回每个设备的所有设备的所有硬件和固件评估。它返回一个表，其中包含 deviceId 和 componentType 的每个唯一组合的单独条目。

1.1.1 限制

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

1.2 权限

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

权限类型	权限	权限显示名称
应用程序	Software.Read.All	“读取威胁和漏洞管理软件信息”
委派（工作或学校帐户）	Software.Read	“读取威胁和漏洞管理软件信息”

1.3 URL

GET api/machines/HardwareFirmwareInventoryByMachine

1.4 参数

pageSize (默认值 = 50,000) ：响应结果数。
$top：要返回的结果数 (不返回 @odata.nextLink ，因此不会拉取所有数据) 。

1.5 JSON 响应) (属性

注意

每个记录大约是 1 KB 的数据。选择正确的 pageSize 参数时，应考虑到这一点。

响应中可能会返回一些其他列。这些列是临时的，可能会删除。仅使用记录的列。

下表中定义的属性按属性 ID 的字母顺序列出。运行此 API 时，生成的输出不一定按此表中列出的相同顺序返回。

属性 (ID)	数据类型	说明
deviceId	String	服务中设备的唯一标识符。
rbacGroupId	Int	基于角色的访问控制 (RBAC) 组 ID。如果设备未分配给任何 RBAC 组，则值为“未分配”。如果组织不包含任何 RBAC 组，则值为“无”。
rbacGroupName	String	基于角色的访问控制 (RBAC) 组。如果设备未分配给任何 RBAC 组，则值为“未分配”。如果组织不包含任何 RBAC 组，则值为“无”。
deviceName	String	设备的 FQDN) (完全限定的域名。
componentType	String	硬件或固件组件的类型。
manufacturer	String	特定硬件或固件组件的制造商。
componentName	String	特定硬件或固件组件的名称。
componentVersion	String	特定硬件或固件组件的版本。
additionalFields	String	有关 JSON 数组格式的组件的其他信息。

1.6 示例

1.6.1 请求示例

GET https://api.security.microsoft.com/api/machines/HardwareFirmwareInventoryByMachine

1.6.2 响应示例

      {
        "@odata.context": "https://api-df.securitycenter.microsoft.com/api/$metadata#Collection(microsoft.windowsDefenderATP.api.AssetHardwareFirmware)",
        "value":[
        {
            "deviceId": "49126b9e4a5473b5229c73799e9e55c48668101b",
            "rbacGroupId": 39,
            "rbacGroupName": "testO6343398Gq31",
            "deviceName": "testmachine5",
            "componentType": "Hardware",
            "manufacturer": "razer",
            "componentName": "blade_15_advanced_model_(mid_2021)_-_rz09-0409",
            "componentVersion": "7.04",
            "additionalFields": "{\"SystemSKU\":\"RZ09-0409CE53\",\"BaseBoardManufacturer\":\"Razer\",\"BaseBoardProduct\":\"CH570\",\"BaseBoardVersion\":\"4\",\"DeviceFamily\":\"Workstation\"}"
          }  
        ]  
      },

2. 通过文件) 导出硬件和固件评估 (

2.1 API 方法说明

返回每个设备的所有设备的所有硬件和固件评估。它返回一个表，其中包含 DeviceId、ComponentType 和 ComponentName 的每个唯一组合的单独条目。

2.1.1 限制

此 API 的速率限制是每分钟 5 个调用和每小时 20 个调用。

2.2 权限

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

权限类型	权限	权限显示名称
应用程序	Software.Read.All	“读取威胁和漏洞管理软件信息”
委派（工作或学校帐户）	Software.Read	“读取威胁和漏洞管理软件信息”

2.3 URL

GET /api/machines/HardwareFirmwareInventoryExport

2.4 参数

sasValidHours：下载 URL 在最长 24 小时) (有效小时数。

2.5 json 响应) (属性

注意

这些文件是多行 Json 格式的 gzip 压缩 &。

下载 URL 仅在 3 小时内有效;否则，可以使用参数。

若要最大程度地提高下载速度，请确保从数据所在的同一 Azure 区域下载数据。

每个记录大约为 1KB 的数据。选择适合你的 pageSize 参数时，应考虑到这一点。