共用方式為


匯出每個裝置的軟體清查評估

適用於:

想要體驗適用於端點的 Microsoft Defender 嗎? 注册免費試用版。

此 API 會傳回每個裝置上具有 Common Platform Enumeration (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 API 以取得詳細數據。

許可權類型 權限 許可權顯示名稱
應用程式 Software.Read.All 「讀取威脅和弱點管理軟體資訊」
委派 (公司或學校帳戶) Software.Read 「讀取威脅和弱點管理軟體資訊」

1.3 URL

GET /api/machines/SoftwareInventoryByMachine

1.4 參數

  • pageSize (預設值 = 50,000) :回應中的結果數目。
  • $top:要傳回的結果數目 (不會傳回 @odata.nextLink ,因此不會提取所有數據)

1.5 屬性

注意事項

  • 每筆記錄大約是 0.5 KB 的數據。 為您選擇正確的 pageSize 參數時,應該將此納入考慮。
  • 下表中定義的屬性會依字母順序依屬性標識碼列出。 執行此 API 時,產生的輸出不一定會以此數據表所列的相同順序傳回。
  • 回應中可能會傳回一些額外的數據行。 這些數據行是暫時性的,而且可能會被移除,請只使用記載的數據行。


屬性 (識別碼) 資料類型 描述 傳回值的範例
DeviceId 字串 服務中裝置的唯一標識符。 9eaf3a8b5962e0e6b1af9ec756664a9b823df2d1
DeviceName 字串 裝置的 FQDN) (完整功能變數名稱。 johnlaptop.europe.contoso.com
DiskPaths Array[string] 裝置上已安裝產品的磁碟辨識項。 [“C:\Program Files (x86) \Microsoft\Silverlight\Application\silverlight.exe”]
EndOfSupportDate 字串 支援此軟體的日期已或即將結束。 2020-12-30
EndOfSupportStatus 字串 終止支持狀態。 可以包含下列可能的值:None、EOS 版本、即將推出的EOS版本、EOS 軟體、即將推出的EOS軟體。 即將推出的EOS
NumberOfWeaknesses int 此裝置上此軟體的弱點數目 3
OSPlatform 字串 在裝置上執行之作業系統的平臺。 這些是相同系列內有變化的特定操作系統,例如 Windows 10和 Windows 11。 如需詳細資訊,請參閱 Microsoft Defender 弱點管理 支援的操作系統和平臺。 Windows 10 和 Windows 11
RbacGroupName 字串 角色型訪問控制 (RBAC) 群組。 如果未將此裝置指派給任何 RBAC 群組,則值會是 “Unassigned”。如果組織不包含任何 RBAC 群組,則值會是 「None」。 伺服器
RegistryPaths Array[string] 裝置中已安裝產品的登錄辨識項。 [“HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Microsoft\Windows\CurrentVersion\Uninstall\Microsoft Silverlight”]
SoftwareFirstSeenTimestamp 字串 第一次在裝置上看到此軟體。 2019-04-07 02:06:47
SoftwareName 字串 軟體產品的名稱。 Silverlight
SoftwareVendor 字串 軟體廠商的名稱。 微軟
SoftwareVersion 字串 軟體產品的版本號碼。 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 許可權

呼叫此 API 需要下列其中一個許可權。 若要深入瞭解,包括如何選擇許可權,請參閱使用 適用於端點的 Microsoft Defender API 以取得詳細數據。

許可權類型 權限 許可權顯示名稱
應用程式 Software.Read.All 「讀取威脅和弱點管理軟體資訊」
委派 (公司或學校帳戶) Software.Read 「讀取威脅和弱點管理軟體資訊」

2.3 URL

GET /api/machines/SoftwareInventoryExport

參數

  • sasValidHours:下載 URL 的有效時數 (最多 24 小時)

2.5 屬性

注意事項

  • 檔案是以多行 JSON 格式壓縮 &。
  • 下載 URL 的有效期只有 3 小時。 否則,您可以使用 參數。
  • 如需數據的最大下載速度,您可以確定您是從數據所在的相同 Azure 區域下載。


屬性 (識別碼) 資料類型 描述 傳回值的範例
匯出檔案 array[string] 保存組織目前快照集之檔案的下載 URL 清單 "[Https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...1", "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...2"]
GeneratedTime 字串 產生匯出的時間。 2021-05-20T08:00:00Z

2.6 範例

2.6.1 要求範例

GET https://api.securitycenter.microsoft.com/api/machines/SoftwareInventoryExport

2.6.2 回應範例

{
    "@odata.context": "https://api.securitycenter.microsoft.com/api/$metadata#microsoft.windowsDefenderATP.api.ExportFilesResponse",
    "exportFiles": [
        "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export/2021-01-11/1101/SoftwareInventory/json/OrgId=12345678-195f-4223-9c7a-99fb420fd000/part-00393-e423630d-4c69-4490-8769-a4f5468c4f25.c000.json.gz?sv=2019-12-12&st=2021-01-11T11%3A55%3A51Z&se=2021-01-11T14%3A55%3A51Z&sr=b&sp=r&sig=...",
        "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export/2021-01-11/1101/SoftwareInventory/json/OrgId=12345678-195f-4223-9c7a-99fb420fd000/part-00394-e423630d-4c69-4490-8769-a4f5468c4f25.c000.json.gz?sv=2019-12-12&st=2021-01-11T11%3A55%3A51Z&se=2021-01-11T14%3A55%3A51Z&sr=b&sp=r&sig=...",
        "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export/2021-01-11/1101/SoftwareInventory/json/OrgId=12345678-195f-4223-9c7a-99fb420fd000/part-00394-e423630d-4c69-4490-8769-a4f5468c4f25.c001.json.gz?sv=2019-12-12&st=2021-01-11T11%3A55%3A51Z&se=2021-01-11T14%3A55%3A51Z&sr=b&sp=r&sig=..."
    ],
    "generatedTime": "2021-01-11T11:01:00Z"
}

另請參閱

其他相關

提示

想要深入了解? Engage 技術社群中的 Microsoft 安全性社群:適用於端點的 Microsoft Defender 技術社群。