导出每台设备的软件清单评估

项目
04/26/2024

适用于：

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

此 API 基于每个设备返回具有通用平台枚举 (CPE) 的已安装软件的所有数据。

不同的 API 调用获取不同类型的数据。由于数据量可能很大，因此可通过两种方式检索数据：

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

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

注意

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

1. 导出软件清单评估 (JSON 响应)

1.1 API 方法说明

此 API 响应包含每个设备具有公共平台枚举 (CPE) 的已安装软件的所有数据。返回一个表，其中包含 DeviceId、SoftwareVendor、SoftwareName、SoftwareVersion 的每个唯一组合的条目。

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/SoftwareInventoryByMachine

1.4 参数

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

1.5 属性

注意

每个记录大约为 0.5KB 的数据。在为你选择正确的 pageSize 参数时，应考虑到这一点。
下表中定义的属性按属性 ID 按字母顺序列出。运行此 API 时，生成的输出不一定按此表中列出的相同顺序返回。
响应中可能会返回一些其他列。这些列是临时的，可能会删除，请仅使用记录的列。

属性 (ID)	数据类型	说明	返回值的示例
DeviceId	string	服务中设备的唯一标识符。	9eaf3a8b5962e0e6b1af9ec756664a9b823df2d1
DeviceName	string	设备的 FQDN) (完全限定的域名。	johnlaptop.europe.contoso.com
DiskPaths	Array[string]	磁盘证明产品已安装在设备上。	[“C：\Program Files (x86) \Microsoft\Silverlight\Application\silverlight.exe”]
EndOfSupportDate	string	对该软件的支持已结束或即将结束的日期。	2020-12-30
EndOfSupportStatus	string	终止支持状态。可以包含以下可能的值：None、EOS 版本、即将推出的 EOS 版本、EOS 软件、即将推出的 EOS 软件。	即将推出的 EOS
NumberOfWeaknesses	int	此设备上此软件的弱点数	3
OSPlatform	string	在设备上运行的操作系统的平台。这些是同一系列中具有变体的特定操作系统，例如Windows 10和Windows 11。有关详细信息，请参阅Microsoft Defender 漏洞管理支持的操作系统和平台。	Windows10 和 Windows 11
RbacGroupName	string	基于角色的访问控制 (RBAC) 组。如果此设备未分配给任何 RBAC 组，则值为“未分配”。如果组织不包含任何 RBAC 组，则值为“无”。	服务器
RegistryPaths	Array[string]	注册表证明产品已安装在设备中。	[“HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Microsoft\Windows\CurrentVersion\Uninstall\Microsoft Silverlight”]
SoftwareFirstSeenTimestamp	string	首次在设备上看到此软件。	2019-04-07 02:06:47
SoftwareName	string	软件产品的名称。	Silverlight
SoftwareVendor	string	软件供应商的名称。	microsoft
SoftwareVersion	string	软件产品的版本号。	81.0.4044.138

1.6 示例

1.6.1 请求示例

GET https://api.securitycenter.microsoft.com/api/machines/SoftwareInventoryByMachine?pageSize=5  &sinceTime=2021-05-19T18%3A35%3A49.924Z

1.6.2 响应示例

{
    "@odata.context": "https://api.securitycenter.microsoft.com/api/$metadata#Collection(contoso.windowsDefenderATP.api.AssetSoftware)",
    "value": [
        {
            "deviceId": "00044f68765bbaf712342dbe6db733b6a9c59ab4",
            "rbacGroupName": "hhh",
            "deviceName": "ComputerPII_18993b45912eeb224b2be2f5ea3142726e63f16a.DomainPII_21eeb80d086e79dbfa178eadfa25e8de9acfa346.corp.contoso.com",
            "osPlatform": "Windows10" "Windows11",
            "softwareVendor": "microsoft",
            "softwareName": "windows_10" "Windows_11",
            "softwareVersion": "10.0.17763.1637",
            "numberOfWeaknesses": 58,
            "diskPaths": [],
            "registryPaths": [],
            "softwareFirstSeenTimestamp": "2020-12-30 11:07:15",
            "endOfSupportStatus": "Upcoming EOS Version",
            "endOfSupportDate": "2021-05-11T00:00:00+00:00"
        },
        {
            "deviceId": "00044f68765bbaf712342dbe6db733b6a9c59ab4",
            "rbacGroupName": "hhh",
            "deviceName": "ComputerPII_18993b45912eeb224b2be2f5ea3142726e63f16a.DomainPII_21eeb80d086e79dbfa178eadfa25e8de9acfa346.corp.contoso.com",
            "osPlatform": "Windows10" "Windows11",
            "softwareVendor": "microsoft",
            "softwareName": ".net_framework",
            "softwareVersion": "4.0.0.0",
            "numberOfWeaknesses": 0,
            "diskPaths": [],
            "registryPaths": [
                "SOFTWARE\\Microsoft\\NET Framework Setup\\NDP\\v4.0\\Client\\Install"
            ],
            "softwareFirstSeenTimestamp": "2020-12-30 11:07:15",
            "endOfSupportStatus": "None",
            "endOfSupportDate": null
        },
        {
            "deviceId": "00044f68765bbaf712342dbe6db733b6a9c59ab4",
            "rbacGroupName": "hhh",
            "deviceName": "ComputerPII_18993b45912eeb224b2be2f5ea3142726e63f16a.DomainPII_21eed80d086e79bdfa178eadfa25e8de9acfa346.corp.contoso.com",
            "osPlatform": "Windows10" "Windows11",
            "softwareVendor": "microsoft",
            "softwareName": "system_center_2012_endpoint_protection",
            "softwareVersion": "4.7.214.0",
            "numberOfWeaknesses": 0,
            "diskPaths": [],
            "registryPaths": [
                "HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\Microsoft Security Client"
            ],
            "softwareFirstSeenTimestamp": "2020-12-30 11:07:15",
            "endOfSupportStatus": "None",
            "endOfSupportDate": null
        },
        {
            "deviceId": "00044f68765ddaf71234bde6bd733d6a9c59ad4",
            "rbacGroupName": "hhh",
            "deviceName": "ComputerPII_18993b45912eeb224b2be2f5ea3142726e63f16a.DomainPII_21eeb80d086e79dbfa178aedfa25e8be9acfa346.corp.contoso.com",
            "osPlatform": "Windows10" "Windows11",
            "softwareVendor": "microsoft",
            "softwareName": "configuration_manager",
            "softwareVersion": "5.0.8634.1000",
            "numberOfWeaknesses": 0,
            "diskPaths": [],
            "registryPaths": [
                "HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\{B7D3A842-E826-4542-B39B-1D883264B279}"
            ],
            "softwareFirstSeenTimestamp": "2020-12-30 11:07:15",
            "endOfSupportStatus": "None",
            "endOfSupportDate": null
        },
        {
            "deviceId": "00044f38765bbaf712342dbe6db733b6a9c59ab4",
            "rbacGroupName": "hhh",
            "deviceName": "ComputerPII_18993b45912eeb224b2de2f5ea3142726e63f16a.DomainPII_21eeb80d086e79bdfa178eadfa25e8be9acfa346.corp.contoso.com",
            "osPlatform": "Windows10" "Windows11",
            "softwareVendor": "microsoft",
            "softwareName": "system_center_2012_endpoint_protection",
            "softwareVersion": "4.10.209.0",
            "numberOfWeaknesses": 0,
            "diskPaths": [],
            "registryPaths": [
                "HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\Microsoft Security Client"
            ],
            "softwareFirstSeenTimestamp": "2020-12-30 11:07:15",
            "endOfSupportStatus": "None",
            "endOfSupportDate": null
        }
    ],
    "@odata.nextLink": "https://api.securitycenter.microsoft.com/api/machines/SoftwareInventoryByMachine?pagesize=5&$skiptoken=eyJFeHBvcnREZWZpbml0aW9uIjp7IlRpbWVQYXRoIjoiMjAyMS0wMS0yNS8wMjAwLyJ9LCJFeHBvcnRGaWxlSW5kZXgiOjAsIkxpbmVTdG9wcGVkQXQiOjV9"
}

注意

对于没有 CPE 的软件，此 API 返回的信息以及导出非产品代码软件清单评估 API 返回的信息，使你能够全面了解整个组织中安装的软件及其安装的设备。

2. 通过文件) 导出软件清单评估 (

2.1 API 方法说明

此 API 响应包含每个设备已安装软件的所有数据。返回一个表，其中包含 DeviceId、SoftwareVendor、SoftwareName、SoftwareVersion 的每个唯一组合的条目。

2.1.1 限制

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

2.2 权限