API 描述
提供針對每個裝置擷取漏洞管理資料的 API 的方法與屬性細節。 有不同的 API 呼叫來取得不同類型的資料。每個 API 呼叫都包含組織中裝置所需的資料。
除非另有說明，所有列出的出口評估方法均為 完整出口 ，且 依裝置 (亦稱為 依裝置) 。
你可以使用匯出評估 API 來檢索 (匯出) 不同類型的資訊：
對應匯出資訊類型的 API 詳述於第 1、2 和 3 節。
每種方法都有不同的 API 呼叫來取得不同類型的資料。 由於資料量可能很大，有兩種方式可以擷取：
JSON API 會以 JSON 回應形式拉取組織內所有資料。 此方法最適合 裝置少於 100-K 的小型組織。 回應是分頁的，所以你可以用回應中的 @odata.nextLink 欄位來取得下一個結果。
檔案 此 API 解決方案能更快且更可靠地拉取大量資料。 建議用於擁有超過 100 K 裝置的大型組織。 這個 API 會以下載檔案形式拉取你組織內的所有資料。 回應包含從 Azure 儲存下載所有資料的網址。 此 API 允許您從 Azure 儲存裝置下載所有資料，具體如下：
- 呼叫 API 以獲得包含所有組織資料的下載網址清單。
- 用下載網址下載所有檔案，並依照你的需求處理資料。
透過「JSON 回應 或 檔案」收集的資料，即為當前狀態的快照。 它不包含歷史資料。 為了收集歷史資料，客戶必須將資料儲存在自己的資料儲存中。
1. 匯出安全配置評估
會以每個裝置為單位回傳所有設定及其狀態。
1.1 方法
| 方法 | 資料類型 | 描述 |
|---|---|---|
| 匯出安全配置評估 (JSON 回應) | 依裝置集合安全配置。 參見： 1.2 JSON回應 (屬性) | 回傳一個資料表，包含 DeviceId、ConfigurationID 每個獨特組合的條目。 API 會以 JSON 回應形式拉取組織內所有資料。 此方法最適合裝置少於 100-K 的小型組織。 回應是分頁的，所以你可以用 @odata.nextLink 回應的欄位來取得下一個結果。 |
| 透過檔案匯出安全配置評估 (檔案) | 依裝置集合安全配置。 參見： 1.3 透過檔案 (屬性) | 回傳一個資料表，包含 DeviceId、ConfigurationID 每個獨特組合的條目。 此 API 解決方案能更快且更可靠地拉取大量資料。 因此，推薦給擁有超過 100 K 裝置的大型組織。 這個 API 會以下載檔案形式拉取你組織內的所有資料。 回應包含從 Azure 儲存下載所有資料的網址。 此 API 允許您從 Azure 儲存裝置下載所有資料，具體如下：
|
1.2 JSON 回應 (屬性)
| 財產 (身份) | 資料類型 | 描述 |
|---|---|---|
| 配置類別 | 字串 | 該組態所屬的類別或群組：應用程式、作業系統、網路、帳號、安全控制。 |
| configurationId（配置ID） | 字串 | 特定配置的唯一識別碼。 |
| 配置影響 | 字串 | 配置對整體配置分數的影響 (1至10) 。 |
| 配置名稱 | 字串 | 配置的顯示名稱。 |
| configuration子類別 | 字串 | 設定所屬的子類別或子群組。 在許多情況下，是特定的功能或特色。 |
| deviceId | 字串 | 服務中裝置的唯一識別碼。 |
| 裝置名稱 | 字串 | 完全合格的網域名稱 (裝置的 FQDN) 。 |
| isApplicable | 布林值 | 表示該設定或政策是否適用。 |
| 是合規的 | 布林值 | 顯示設定或政策是否被正確配置。 |
| isExpectedUserImpact | 布林值 | 表示若設定將被套用，使用者是否會受到影響。 |
| osPlatform | 字串 | 裝置上運行的作業系統平台。 同一家族內有變體的特定作業系統，例如 Windows 10 和 Windows 11。 詳情請參閱 支援的作業系統、平台與功能 。 |
| os版本 | 字串 | 裝置上執行的特定作業系統版本。 |
| rbacGroupName | 字串 | 基於角色的存取控制 (RBAC) 群組。 如果裝置沒有被分配到任何 RBAC 群組，該值就會顯示為「未分配」。如果組織中沒有任何RBAC群組，該值將為「無」。 |
| rbacGroupId（rbacGroupId） | 字串 | 基於角色的存取控制 (RBAC) 群組 ID。 |
| 推薦參考文獻 | 字串 | 這是關於該軟體推薦ID的參考。 |
| 時間戳記 | 字串 | 上次這個設定是在裝置上看到的。 |
1.3 透過檔案 (屬性)
| 財產 (身份) | 資料類型 | 描述 |
|---|---|---|
| 匯出檔案 | array[string] | 一份包含組織當前快照檔案的下載網址清單。 |
| 生成時間 | 字串 | 出口產生的時間。 |
2. 出口軟體庫存評估
會把所有安裝好的軟體和每台裝置的詳細資料都還回來。
2.1 方法
| 方法 | 資料類型 | 描述 |
|---|---|---|
| 匯出軟體庫存評估 (JSON 回應) | 依裝置集合進行軟體庫存。 參見： 2.2 JSON回應 (屬性) | 回傳一個表格，包含 DeviceId、SoftwareVendor、SoftwareName、SoftwareVersion 等獨特組合的條目。 API 會以 JSON 回應形式拉取組織內所有資料。 此方法最適合裝置少於 100-K 的小型組織。 回應是分頁的，所以你可以用 @odata.nextLink 回應的欄位來取得下一個結果。 |
| 透過檔案匯出軟體庫存評估 () | 依裝置檔案進行軟體清單管理。 參見： 2.3 透過檔案 (屬性) | 回傳一個表格，包含 DeviceId、SoftwareVendor、SoftwareName、SoftwareVersion 等獨特組合的條目。 此 API 解決方案能更快且更可靠地拉取大量資料。 因此，推薦給擁有超過 100 K 裝置的大型組織。 這個 API 會以下載檔案形式拉取你組織內的所有資料。 回應包含從 Azure 儲存下載所有資料的網址。 此 API 允許您從 Azure Storage 下載以下資料：
|
2.2 JSON回應 (屬性)
| 財產 (身份) | 資料類型 | 描述 |
|---|---|---|
| DeviceId | 字串 | 服務中裝置的唯一識別碼。 |
| DeviceName | 字串 | 完全合格的網域名稱 (裝置的 FQDN) 。 |
| 磁碟路徑 | 陣列[字串] | 磁碟證明產品已安裝在裝置上。 |
| 支援結束日期 | 字串 | 此軟體支援結束或將結束的日期。 |
| 支援狀態結束 | 字串 | 支援狀態結束。 可包含以下可能值：無、EOS 版本、即將推出的 EOS 版本、EOS 軟體、即將推出的 EOS 軟體。 |
| 弱點的數量 | 臨界值 | 這台裝置上這套軟體的弱點數量。 |
| OSPlatform | 字串 | 執行於裝置上的作業系統平台;特定作業系統，並包含同一家族的變體，例如 Windows 10 和 Windows 11。 詳情請參閱 支援的作業系統、平台與功能 。 |
| RbacGroupName | 字串 | 基於角色的存取控制 (RBAC) 群組。 如果這個裝置沒有被指派到任何 RBAC 群組，該值就會顯示為「未分配」。如果組織中沒有任何RBAC群組，該值將為「無」。 |
| rbacGroupId（rbacGroupId） | 字串 | 基於角色的存取控制 (RBAC) 群組 ID。 |
| 登錄路徑 | 陣列[字串] | 登錄證明產品已安裝在裝置中。 |
| 軟體首次見時間戳記 | 字串 | 這是該軟體首次出現在裝置上。 |
| 軟體名稱 | 字串 | 軟體產品的名稱。 |
| 軟體供應商 | 字串 | 軟體供應商名稱。 |
| 軟體版本 | 字串 | 軟體產品的版本號。 |
2.3 透過檔案 (屬性)
| 財產 (身份) | 資料類型 | 描述 |
|---|---|---|
| 匯出檔案 | array[string] | 一份包含組織當前快照檔案的下載網址清單。 |
| 生成時間 | 字串 | 出口產生的時間。 |
3. 軟體漏洞評估
回傳裝置上所有已知的漏洞及其詳細資訊，適用於所有裝置。
3.1 方法
| 方法 | 資料類型 | 描述 |
|---|---|---|
| 匯出軟體漏洞評估 (JSON 回應) | 調查收集 參見： 3.2 屬性 (JSON 回應) | 回傳一個表格，包含 DeviceId、SoftwareVendor、SoftwareName、SoftwareVersion、CveId 等獨特組合的條目。 API 會以 JSON 回應形式拉取組織內所有資料。 此方法最適合裝置少於 100-K 的小型組織。 回應是分頁的，所以你可以用 @odata.nextLink 回應的欄位來取得下一個結果。 |
| 透過檔案匯出軟體漏洞評估 () | 調查實體 參見： 3.3 透過檔案 (屬性) | 回傳一個表格，包含 DeviceId、SoftwareVendor、SoftwareName、SoftwareVersion、CveId 等獨特組合的條目。 此 API 解決方案能更快且更可靠地拉取大量資料。 因此，推薦給擁有超過 100 K 裝置的大型組織。 這個 API 會以下載檔案形式拉取你組織內的所有資料。 回應包含從 Azure 儲存下載所有資料的網址。 此 API 允許您從 Azure 儲存裝置下載所有資料，具體如下：
|
| Delta 出口 軟體漏洞評估 (JSON 回應) | 調查收集 參見： 3.4 屬性 Delta 匯出 (JSON 回應) | 回傳一個表格，包含 DeviceId、SoftwareVendor、SoftwareName、SoftwareVersion、CveId、EventTimestamp 等獨特組合的條目。 API 會以 JSON 回應的形式拉取組織內的資料。 回應是分頁的，所以你可以用 @odata.nextLink 回應的欄位來取得下一個結果。 完整的軟體漏洞評估 (JSON 回應) 用於取得您組織依裝置評估軟體的整體快照。 然而，delta export API 呼叫僅用於擷取從某個日期到當前日期之間的變更， (「delta」API 呼叫) 。 您只會取得有關新、已修正及更新弱點的特定資訊，而不是每次取得大量資料的完整匯出。 Delta export API 呼叫也可用來計算不同的 KPI，例如「修復了多少漏洞？」或「我的組織新增了多少漏洞？」 由於 Delta 對軟體漏洞的匯出 API 呼叫只回傳目標日期範圍的資料，因此不被視為 完整匯出。 |
3.2 JSON回應 (屬性)
| 財產 (身份) | 資料類型 | 描述 |
|---|---|---|
| CveId | 字串 | 根據 CVE) 系統的共通漏洞與暴露 (分配給安全漏洞的唯一識別碼。 |
| CVSS分數 | 字串 | CVE 的 CVSS 分數。 |
| DeviceId | 字串 | 服務中裝置的唯一識別碼。 |
| DeviceName | 字串 | 完全合格的網域名稱 (裝置的 FQDN) 。 |
| 磁碟路徑 | 陣列[字串] | 磁碟證明產品已安裝在裝置上。 |
| 可利用性等級 | 字串 | 此漏洞的可利用等級 (NoExploit、ExploitIsPublic、ExploitIsVerified、ExploitIsInKit) |
| 首次見時間戳記 | 字串 | 這是該產品首次在裝置上看到 CVE。 |
| 識別碼 | 字串 | 紀錄的唯一識別碼。 |
| 最後見過時間戳記 | 字串 | 上次裝置上有看到 CVE。 |
| OSPlatform | 字串 | 執行於裝置上的作業系統平台;特定作業系統，並包含同一家族的變體，例如 Windows 10 和 Windows 11。 詳情請參閱 支援的作業系統、平台與功能 。 |
| RbacGroupName | 字串 | 基於角色的存取控制 (RBAC) 群組。 如果這個裝置沒有被指派到任何 RBAC 群組，該值就會顯示為「未分配」。如果組織中沒有任何RBAC群組，該值將為「無」。 |
| rbacGroupId（rbacGroupId） | 字串 | 基於角色的存取控制 (RBAC) 群組 ID。 |
| 推薦參考 | 字串 | 參考與此軟體相關的推薦 ID。 |
| 推薦安全更新 | 字串 | 軟體廠商為解決漏洞所提供的安全更新名稱或描述。 |
| 推薦安全更新ID | 字串 | 適用的安全更新識別碼，或對應指引或知識庫 (知識庫) 條目的識別碼。 |
| 登錄路徑 | 陣列[字串] | 登錄證明產品已安裝在裝置中。 |
| 安全更新可用 | 布林值 | 顯示軟體是否提供安全更新。 |
| 軟體名稱 | 字串 | 軟體產品的名稱。 |
| 軟體供應商 | 字串 | 軟體供應商名稱。 |
| 軟體版本 | 字串 | 軟體產品的版本號。 |
| 脆弱性嚴重程度 | 字串 | 根據 CVSS 分數，為安全漏洞分配的嚴重程度等級。 |
3.3 透過檔案 (屬性)
| 財產 (身份) | 資料類型 | 描述 |
|---|---|---|
| 匯出檔案 | array[string] | 一份包含組織當前快照檔案的下載網址清單。 |
| 生成時間 | 字串 | 出口產生的時間。 |
3.4 屬性 (delta export JSON 回應)
| 財產 (身份) | 資料類型 | 描述 |
|---|---|---|
| CveId | 字串 | 根據 CVE) 系統的共通漏洞與暴露 (分配給安全漏洞的唯一識別碼。 |
| CVSS分數 | 字串 | CVE 的 CVSS 分數。 |
| DeviceId | 字串 | 服務中裝置的唯一識別碼。 |
| DeviceName | 字串 | 完全合格的網域名稱 (裝置的 FQDN) 。 |
| 磁碟路徑 | 陣列[字串] | 磁碟證明產品已安裝在裝置上。 |
| 事件時間戳記 | 字串 | 發現三角洲事件的時間。 |
| 可利用性等級 | 字串 | 該漏洞的可利用等級 (NoExploit、ExploitIsPublic、ExploitIsVerified、ExploitIsInKit) |
| 首次見時間戳記 | 字串 | 這是裝置上首次出現該產品的 CVE 標誌。 |
| 識別碼 | 字串 | 紀錄的唯一識別碼。 |
| 最後見過時間戳記 | 字串 | 上次裝置上有看到 CVE。 |
| OSPlatform | 字串 | 執行於裝置上的作業系統平台;特定作業系統，並包含同一家族的變體，例如 Windows 10 和 Windows 11。 詳情請參閱 支援的作業系統、平台與功能 。 |
| RbacGroupName | 字串 | 基於角色的存取控制 (RBAC) 群組。 如果這個裝置沒有被指派到任何 RBAC 群組，該值就會顯示為「未分配」。如果組織中沒有任何RBAC群組，該值將為「無」。 |
| 推薦參考 | 字串 | 參考與此軟體相關的推薦 ID。 |
| 推薦安全更新 | 字串 | 軟體廠商為解決漏洞所提供的安全更新名稱或描述。 |
| 推薦安全更新ID | 字串 | 適用安全更新的識別碼，或對應指引或知識庫 (KB) 條目的識別碼 |
| 登錄路徑 | 陣列[字串] | 登錄證明產品已安裝在裝置中。 |
| 軟體名稱 | 字串 | 軟體產品的名稱。 |
| 軟體供應商 | 字串 | 軟體供應商名稱。 |
| 軟體版本 | 字串 | 軟體產品的版本號。 |
| 狀態 | 字串 | 針對裝置) 引入的新漏洞的新 (。 修復 了 (裝置上已經不存在的漏洞，代表) 已經修復了。 更新 (針對一個已變更裝置的漏洞。可能的變更包括：CVSS 分數、可利用性等級、嚴重程度等級、磁碟路徑、登錄檔路徑、推薦安全更新) 。 |
| 脆弱性嚴重程度 | 字串 | 根據 CVSS 分數，安全漏洞的嚴重程度等級。 |
4. 匯出非產品代碼軟體庫存評估
回傳所有未在每個裝置上 (CPE) Common Platform Enumeration 的已安裝軟體及其詳細資訊。
4.1 方法
| 方法 | 資料類型 | 描述 |
|---|---|---|
| 匯出非產品程式碼軟體庫存評估 (JSON 回應) | 非產品代碼軟體依裝置集合盤點。 參見： 4.2 JSON回應 (屬性) | 回傳一個表格，包含 DeviceId、SoftwareVendor、SoftwareName、SoftwareVersion 等獨特組合的條目。 API 會以 JSON 回應形式拉取組織內所有資料。 此方法最適合裝置少於 100-K 的小型組織。 回應是分頁的，所以你可以用 @odata.nextLink 回應的欄位來取得下一個結果。 |
| 透過檔案匯出非產品代碼軟體庫存評估 () | 非產品代碼軟體依裝置檔案盤點。 參見： 4.3 透過檔案 (屬性) | 回傳一個表格，包含 DeviceId、SoftwareVendor、SoftwareName、SoftwareVersion 等獨特組合的條目。 此 API 解決方案能更快且更可靠地拉取大量資料。 因此，推薦給擁有超過 100 K 裝置的大型組織。 這個 API 會以下載檔案形式拉取你組織內的所有資料。 回應包含從 Azure 儲存下載所有資料的網址。 此 API 允許您從 Azure Storage 下載以下資料：
|
4.2 JSON回應 (屬性)
| 財產 (身份) | 資料類型 | 描述 |
|---|---|---|
| DeviceId | 字串 | 服務中裝置的唯一識別碼。 |
| DeviceName | 字串 | 完全合格的網域名稱 (裝置的 FQDN) 。 |
| OSPlatform | 字串 | 裝置上運行的作業系統平台。 這些是同一家族中具有變體的特定作業系統，例如 Windows 10 和 Windows 11。 詳情請參閱 支援的作業系統、平台與功能 。 |
| RbacGroupName | 字串 | 基於角色的存取控制 (RBAC) 群組。 如果這個裝置沒有被指派到任何 RBAC 群組，該值就會顯示為「未分配」。如果組織中沒有任何RBAC群組，該值將為「無」。 |
| RbacGroupId | 字串 | 基於角色的存取控制 (RBAC) 群組 ID。 |
| 軟體最後見過時間戳記 | 字串 | 這是上次在裝置上看到這個軟體。 |
| 軟體名稱 | 字串 | 軟體產品的名稱。 |
| 軟體供應商 | 字串 | 軟體供應商名稱。 |
| 軟體版本 | 字串 | 軟體產品的版本號。 |
4.3 透過檔案 (屬性)
| 財產 (身份) | 資料類型 | 描述 |
|---|---|---|
| 匯出檔案 | array[string] | 一份包含組織當前快照檔案的下載網址清單。 |
| 生成時間 | 字串 | 出口產生的時間。 |