匯出非產品代碼軟體的設備庫存評估

此 API 會回傳所有未包含 通用平台列舉 (CPE) 的已安裝軟體資料，依裝置單位資料。 這個 API 所回傳的資訊，以及 Export 軟體庫存評估 API 所回傳的資訊，對於具備 CPE 的軟體，能讓你全面掌握組織內安裝的軟體及其所安裝裝置的狀況。

不同的 API 呼叫會取得不同類型的資料。 由於資料量可能很大，有兩種方式可以擷取：

• 匯出非產品程式碼軟體庫存評估 JSON 回應：API 會將組織內所有資料匯入 JSON 回應。 此方法最適合 裝置少於 100-K 的小型組織。 回應是分頁的，所以你可以用回應中的 @odata.nextLink 欄位來取得下一個結果。

• 透過檔案匯出非產品代碼軟體庫存評估：此 API 解決方案能更快且更可靠地拉取大量資料，建議用於擁有超過 100 K 裝置的大型組織。 這個 API 會以下載檔案形式拉取你組織內的所有資料。 回應包含從 Azure 儲存下載所有資料的網址。 此 API 允許您從 Azure 儲存裝置下載所有資料，具體如下：

  • 呼叫 API 以獲得包含所有組織資料的下載網址清單。
  • 用下載網址下載所有檔案，並依照你的需求處理資料。

所有列出的出口評估方法均為 完整出口 ，且 按設備 ( 也稱為 每裝置) 除非另有說明。

透過 Json 回應 或 檔案 (收集的資料) 即為當前狀態的快照。 它不包含歷史資料。 為了收集歷史資料，客戶必須將資料儲存在自己的資料儲存中。

1. 匯出非產品程式碼軟體庫存評估 (JSON 回應)

1.1 API 方法描述

此 API 回應包含所有未依裝置進行 通用平台列舉 (CPE) 的軟體資料。 回傳一個表格，包含 DeviceId、SoftwareVendor、SoftwareName、SoftwareVersion 等獨特組合的條目。

限制

• 最大頁數為200,000頁。
• 此 API 的速率限制為每分鐘 30 次呼叫及每小時 1,000 次呼叫。

1.2 權限

呼叫此 API 需要以下其中一項權限。 欲了解更多，包括如何選擇權限，請參閱「Use 適用於端點的 Microsoft Defender APIS」詳情。

1.3 網址

GET /api/machines/SoftwareInventoryNoProductCodeByMachine

1.4 參數

• pageSize (default = 50,000) ：回應結果數量。
• $top：要回傳的結果數量 (沒有回傳 @odata.nextLink ，因此無法拉取所有資料)

1.5 特性

• 每筆記錄為 0.5KB 的資料。 在選擇適合你的 pageSize 參數時，應該考慮這個大小。
• 下表中定義的屬性依屬性 ID 字母順序排列。 執行此 API 時，輸出的順序不一定與此表中列出的順序相同。
• 回應中可能會返回其他欄位。 這些欄位是暫時的，可能會被移除，因此請只使用已記錄的欄位。

1.6 範例

1.6.1 請求範例

https://api.security.microsoft.com/api/machines/SoftwareInventoryNoProductCodeByMachine?pageSize=3  &sinceTime=2021-05-19

1.6.2 回應範例

{
    "@odata.context": "https://api.security.microsoft.com/api/$metadata#Collection(microsoft.windowsDefenderATP.api.AssetNonCpeSoftware)",
    "value": [
        {
           "deviceId": "1234512345123451234512345",
            "rbacGroupId": 11,
            "rbacGroupName": "London",
            "deviceName": "Device1",
            "osPlatform": "Windows11",
            "softwareVendor": "microsoft",
            "softwareName": "vs_communitymsi",
            "softwareVersion": "11.11.31111.1",
            "softwareLastSeenTimestamp": "2021-01-30 11:31:12.271"
        },
        {
            "deviceId": "232323232323232322323232323",
            "rbacGroupId": 23,
            "rbacGroupName": "Tokyo",
            "deviceName": "Device23",
            "osPlatform": "Windows10",
            "softwareVendor": "intel",
            "softwareName": "intel®_software_installer",
            "softwareVersion": "22.20.2.2",
            "softwareLastSeenTimestamp": "2022-05-30 15:35:12.271"
        },
        {
            "deviceId": "6565656565",
            "rbacGroupId": 65,
            "rbacGroupName": "Center",
            "deviceName": "Device56",
            "osPlatform": "Windows10",
            "softwareVendor": "Lob Apps",
            "softwareName": "Headtrax",
            "softwareVersion": "60.273.3",
            "softwareLastSeenTimestamp": "2022-05-05 15:35:12.271"
        },
    ],
        "@odata.nextLink": "https://api.security.microsoft.com/api/machines/SoftwareInventoryNoProductCodeByMachine?pagesize=3%20%20&sincetime=2021-05-19&$skiptoken=eyJFeHBvcnREZWZpbml0aW9uIjp7IlRpbWVQYXRoIjoiMjAyMi0wNS0zMC8xMTAxLyJ9LCJFeHBvcnRGaWxlSW5kZXgiOjAsIkxpbmVTdG9wcGVkQXQiOjV9"
}

2. 透過檔案匯出非產品代碼軟體庫存評估 ()

2.1 API 方法描述

此 API 回應包含所有未依裝置進行 通用平台列舉 (CPE) 的軟體資料。 回傳一個表格，包含 DeviceId、SoftwareVendor、SoftwareName、SoftwareVersion 等獨特組合的條目。

2.1.1 限制

此 API 的速率限制為每分鐘 5 次呼叫及每小時 20 次呼叫。

2.2 權限

呼叫此 API 需要以下其中一項權限。 欲了解更多，包括如何選擇權限，請參閱「Use 適用於端點的 Microsoft Defender APIS」詳情。

2.3 網址

GET /api/machines/SoftwareInventoryNonCpeExport

2.4 參數

• sasValidHours下載網址有效時數。 最多6小時。

2.5 性質

• 這些檔案以 GZIP 壓縮 &，格式為多行 JSON 格式。
• 下載網址有效期為 1 小時，除非使用該 sasValidHours 參數。
• 為了讓資料下載速度達到最高，你可以確保你下載的範圍和資料所在的 Azure 區域相同。

2.6 範例

2.6.1 請求範例

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

2.6.2 回應範例

{
    "@odata.context": "https://api.security.microsoft.com/api/$metadata#microsoft.windowsDefenderATP.api.ExportFilesResponse",
    "exportFiles": [
        "https://tvmexportexternalprdcanc.blob.core.windows.net/temp-ffd80447-7b3d-4ad2-b366-f0979b129662/2022-05-30/1101/NonCpeSoftwareInventory/json/OrgId=47d41a0c-188d-46d3-bbea-a93dbc0bfcaa/_RbacGroupId=1/part-00337-5e15412b-5c85-4896-ac60-b7b3ab8da096.c000.json.gz?sv=2020-08-04&st=2022-05-30T13%3A41%3A59Z&se=2022-05-30T16%3A41%3A59Z&sr=b&sp=r&sig=aHnmuOKlIvpR0PsdamYfmCCDZ1nhpuXBzK2%2FkJ9xTpg%3D",
        "https://tvmexportexternalprdcanc.blob.core.windows.net/temp-ffd80447-7b3d-4ad2-b366-f0979b129662/2022-05-30/1101/NonCpeSoftwareInventory/json/OrgId=47d41a0c-188d-46d3-bbea-a93dbc0bfcaa/_RbacGroupId=1/part-00338-5e15412b-5c85-4896-ac60-b7b3ab8da096.c000.json.gz?sv=2020-08-04&st=2022-05-30T13%3A41%3A59Z&se=2022-05-30T16%3A41%3A59Z&sr=b&sp=r&sig=0fQg%2Ft469x26KvPLmvctLl0g6DC38CNM3lXYi9dnFfo%3D",
        "https://tvmexportexternalprdcanc.blob.core.windows.net/temp-ffd80447-7b3d-4ad2-b366-f0979b129662/2022-05-30/1101/NonCpeSoftwareInventory/json/OrgId=47d41a0c-188d-46d3-bbea-a93dbc0bfcaa/_RbacGroupId=1/part-00339-5e15412b-5c85-4896-ac60-b7b3ab8da096.c000.json.gz?sv=2020-08-04&st=2022-05-30T13%3A41%3A59Z&se=2022-05-30T16%3A41%3A59Z&sr=b&sp=r&sig=P6HGHoLXXipMauBpLueoQVrwHL7qmvLoCjcij6ERx8o%3D",
        "https://tvmexportexternalprdcanc.blob.core.windows.net/temp-ffd80447-7b3d-4ad2-b366-f0979b129662/2022-05-30/1101/NonCpeSoftwareInventory/json/OrgId=47d41a0c-188d-46d3-bbea-a93dbc0bfcaa/_RbacGroupId=1/part-00340-5e15412b-5c85-4896-ac60-b7b3ab8da096.c000.json.gz?sv=2020-08-04&st=2022-05-30T13%3A41%3A59Z&se=2022-05-30T16%3A41%3A59Z&sr=b&sp=r&sig=VnpVct%2F8vdiIFTf2xXP9DF7ngWv1Zqew30q2jBPVghg%3D",
        "https://tvmexportexternalprdcanc.blob.core.windows.net/temp-ffd80447-7b3d-4ad2-b366-f0979b129662/2022-05-30/1101/NonCpeSoftwareInventory/json/OrgId=47d41a0c-188d-46d3-bbea-a93dbc0bfcaa/_RbacGroupId=1/part-00341-5e15412b-5c85-4896-ac60-b7b3ab8da096.c000.json.gz?sv=2020-08-04&st=2022-05-30T13%3A41%3A59Z&se=2022-05-30T16%3A41%3A59Z&sr=b&sp=r&sig=GY0zxMfEmr9v9fZBWYyKEtT2k%2F0ELQIlOP0ct%2B6SdGU%3D",
    ],
    "generatedTime": "2022-05-30T11:01:00Z"
}