共用方式為

匯出每個裝置的評量方法和屬性

  • 發行項

適用於：

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

API 描述

提供有關 API 的方法和屬性詳細數據，這些 API 會根據每個裝置提取弱點管理數據。 有不同的 API 呼叫可取得不同類型的數據。 一般而言，每個 API 呼叫都會包含組織中裝置的必要數據。

注意事項

除非另有指示，否則列出的所有導出評估方法都是 完整匯 出，而 裝置 (也稱為 每個裝置) 。

您可以使用匯出評定 API 來擷取 (匯出) 不同類型的資訊：

第 1、2 和 3 節說明對應至匯出資訊類型的 API。

每個方法都有不同的 API 呼叫來取得不同類型的數據。 因為數據量可能很大，所以有兩種方式可以擷取：

  • JSON 回應 API 會將組織中的所有數據提取為 JSON 回應。 此方法最適合 裝置少於 100 K 的小型組織。 回應會進行分頁，因此您可以使用回應中的 @odata.nextLink 欄位來擷取下一個結果。

  • 透過檔案 此 API 解決方案可讓您更快速且更可靠地提取大量數據。 因此，建議大型組織使用超過100 K的裝置。 此 API 會將組織中的所有資料提取為下載檔。 回應包含可從 Azure 記憶體下載所有數據的 URL。 此 API 可讓您從 Azure 記憶體下載所有資料，如下所示：

    • 呼叫 API 以取得包含您所有組織資料的下載 URL 清單。
    • 使用下載 URL 下載所有檔案，並視需要處理數據。

使用「JSON 回應 或 透過檔案」收集的數據是目前狀態的目前快照集。 它不包含歷史數據。 若要收集歷史數據，客戶必須將數據儲存在自己的數據記憶體中。

1.導出安全設定評量

根據每個裝置傳回所有組態及其狀態。

1.1 方法

方法 資料類型 描述
依裝置集合的安全設定。 請參閱： 1.2 屬性 (JSON 回應) 傳回數據表，其中包含 DeviceId、 ConfigurationId 之每個唯一組合的專案。 API 會將組織中的所有數據提取為 JSON 回應。 此方法最適合裝置少於 100 K 的小型組織。 回應是分頁的，因此您可以使用 @odata.nextLink 回應中的 字段來擷取下一個結果。
依裝置集合的安全設定。 請參閱： 透過檔案 (1.3 屬性) 傳回數據表，其中包含 DeviceId、 ConfigurationId 之每個唯一組合的專案。 此 API 解決方案可讓您更快速且更可靠地提取大量數據。 因此，建議大型組織使用超過100 K的裝置。 此 API 會將組織中的所有資料提取為下載檔。 回應包含可從 Azure 記憶體下載所有數據的 URL。 此 API 可讓您從 Azure 記憶體下載所有資料，如下所示：
  1. 呼叫 API 以取得包含您所有組織資料的下載 URL 清單。
  2. 使用下載 URL 下載所有檔案，並視需要處理數據。

1.2 JSON 回應 (屬性)

屬性 (識別碼) 資料類型 描述
configurationCategory 字串 設定所屬的類別或群組：應用程式、OS、網路、帳戶、安全性控制。
configurationId 字串 特定組態的唯一標識碼。
configurationImpact 字串 設定對整體設定分數的評分效果 (1-10) 。
configurationName 字串 組態的顯示名稱。
configurationSubcategory 字串 設定所屬的子類別或子群組。 在許多情況下，特定功能或功能。
deviceId 字串 服務中裝置的唯一標識符。
deviceName 字串 裝置的 FQDN) (完整功能變數名稱。
isApplicable 布林值 指出組態或原則是否適用。
isCompliant 布林值 指出組態或原則是否已正確設定。
isExpectedUserImpact 布林值 指出如果將套用設定，使用者是否會受到影響。
osPlatform 字串 在裝置上執行之作業系統的平臺。 在相同系列內具有變化的特定操作系統，例如 Windows 10 和 Windows 11。 如需詳細資訊，請參閱 支援的操作系統、平臺和功能 。
osVersion 字串 在裝置上執行的特定作業系統版本。
rbacGroupName 字串 角色型訪問控制 (RBAC) 群組。 如果裝置未指派給任何 RBAC 群組，則值會是 “Unassigned”。如果組織不包含任何 RBAC 群組，則值會是 「None」。
rbacGroupId 字串 角色型訪問控制 (RBAC) 群組標識碼。
recommendationReference 字串 與軟體相關的建議標識碼參考。
時間 戳 字串 上次在裝置上看到設定的時間。

1.3 透過檔案 (的屬性)

屬性 (識別碼) 資料類型 描述
匯出檔案 array[string] 保存組織目前快照集之檔案的下載 URL 清單。
GeneratedTime 字串 產生匯出的時間。

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 記憶體下載所有數據的 URL。 此 API 可讓您從 Azure 記憶體下載數據，如下所示：
  1. 呼叫 API 以取得包含組織數據的下載 URL 清單
  2. 使用下載 URL 下載檔，並視需要處理數據。

2.2 JSON 回應 (屬性)

屬性 (識別碼) 資料類型 描述
DeviceId 字串 服務中裝置的唯一標識符。
DeviceName 字串 裝置的 FQDN) (完整功能變數名稱。
DiskPaths Array[string] 裝置上已安裝產品的磁碟辨識項。
EndOfSupportDate 字串 支援此軟體的日期已或即將結束。
EndOfSupportStatus 字串 終止支持狀態。 可以包含下列可能的值：None、EOS 版本、即將推出的EOS版本、EOS 軟體、即將推出的EOS軟體。
NumberOfWeaknesses 臨界值 此裝置上此軟體的弱點數目。
OSPlatform 字串 在裝置上執行之作業系統的平臺;在相同系列內具有變化的特定操作系統，例如 Windows 10 和 Windows 11。 如需詳細資訊，請參閱 支援的操作系統、平臺和功能 。
RbacGroupName 字串 角色型訪問控制 (RBAC) 群組。 如果未將此裝置指派給任何 RBAC 群組，則值會是 “Unassigned”。如果組織不包含任何 RBAC 群組，則值會是 「None」。
rbacGroupId 字串 角色型訪問控制 (RBAC) 群組標識碼。
RegistryPaths Array[string] 裝置中已安裝產品的登錄辨識項。
SoftwareFirstSeenTimestamp 字串 第一次在裝置上看到此軟體。
SoftwareName 字串 軟體產品的名稱。
SoftwareVendor 字串 軟體廠商的名稱。
SoftwareVersion 字串 軟體產品的版本號碼。

2.3 透過檔案 (的屬性)

屬性 (識別碼) 資料類型 描述
匯出檔案 array[string] 保存組織目前快照集之檔案的下載 URL 清單。
GeneratedTime 字串 產生匯出的時間。

3.導出軟體弱點評估

針對所有裝置，傳回裝置上的所有已知弱點及其詳細數據。

3.1 方法

方法 資料類型 描述
調查集合 請參閱： 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 記憶體下載所有數據的 URL。 此 API 可讓您從 Azure 記憶體下載所有資料，如下所示：
  1. 呼叫 API 以取得包含您所有組織資料的下載 URL 清單。
  2. 使用下載 URL 下載所有檔案，並視需要處理數據。
調查集合 請參閱： 3.4 屬性差異匯出 (JSON 回應) 傳回數據表，其中包含每個唯一組合的專案：DeviceId、SoftwareVendor、SoftwareName、SoftwareVersion、CveId 和 EventTimestamp。

API 會將組織中的數據提取為 JSON 回應。 回應是分頁的，因此您可以使用 @odata.nextLink 回應中的 字段來擷取下一個結果。 完整的軟體弱點評估 (JSON 回應) 可用來依裝置取得組織軟體弱點評估的完整快照集。 不過，差異導出 API 呼叫僅用來擷取在所選日期與目前日期之間發生的變更， (「差異」API 呼叫) 。 您只會取得有關新、已修正及更新弱點的特定資訊，而不是每次取得大量資料的完整匯出。 差異匯出 API 呼叫也可用來計算不同的 KPI，例如「已修正多少弱點？」或「已將多少新的弱點新增至我的組織？」

由於針對軟體弱點的 Delta 匯出 API 呼叫只會傳回目標日期範圍的數據，因此不會視為 完整匯出。

3.2 JSON 回應 (屬性)

屬性 (識別碼) 資料類型 描述
CveId 字串 指派給 CVE) 系統中常見弱點和暴露 (安全性弱點的唯一標識符。
CvssScore 字串 CVE 的 CVSS 分數。
DeviceId 字串 服務中裝置的唯一標識符。
DeviceName 字串 裝置的 FQDN) (完整功能變數名稱。
DiskPaths Array[string] 裝置上已安裝產品的磁碟辨識項。
ExploitabilityLevel 字串 此弱點的可利用性層級 (NoExploit、ExploitIsPublic、ExploitIsVerified、ExploitIsInKit)
FirstSeenTimestamp 字串 第一次在裝置上看到此產品的 CVE。
識別碼 字串 記錄的唯一標識碼。
LastSeenTimestamp 字串 上次在裝置上看到 CVE。
OSPlatform 字串 在裝置上執行之作業系統的平臺;在相同系列內具有變化的特定操作系統，例如 Windows 10 和 Windows 11。 如需詳細資訊，請參閱 支援的操作系統、平臺和功能 。
RbacGroupName 字串 角色型訪問控制 (RBAC) 群組。 如果未將此裝置指派給任何 RBAC 群組，則值會是 “Unassigned”。如果組織不包含任何 RBAC 群組，則值會是 「None」。
rbacGroupId 字串 角色型訪問控制 (RBAC) 群組標識碼。
RecommendationReference 字串 與此軟體相關的建議標識碼參考。
RecommendedSecurityUpdate 字串 軟體廠商提供的安全性更新名稱或描述，以解決此弱點。
RecommendedSecurityUpdateId 字串 對應指引或 知識庫 (KB) 文章適用安全性更新或標識碼的標識碼。
登錄路徑 Array[string] 裝置中已安裝產品的登錄辨識項。
SecurityUpdateAvailable 布林值 指出軟體是否提供安全性更新。
SoftwareName 字串 軟體產品的名稱。
SoftwareVendor 字串 軟體廠商的名稱。
SoftwareVersion 字串 軟體產品的版本號碼。
VulnerabilitySeverityLevel 字串 根據 CVSS 分數指派給安全性弱點的嚴重性層級。

3.3 透過檔案 (屬性)

屬性 (識別碼) 資料類型 描述
匯出檔案 array[string] 保存組織目前快照集之檔案的下載 URL 清單。
GeneratedTime 字串 產生匯出的時間。

3.4 差異導出 JSON 回應 (屬性)

屬性 (識別碼) 資料類型 描述
CveId 字串 指派給 CVE) 系統中常見弱點和暴露 (安全性弱點的唯一標識符。
CvssScore 字串 CVE 的 CVSS 分數。
DeviceId 字串 服務中裝置的唯一標識符。
DeviceName 字串 裝置的 FQDN) (完整功能變數名稱。
DiskPaths Array[string] 裝置上已安裝產品的磁碟辨識項。
EventTimestamp 字串 找到差異事件的時間。
ExploitabilityLevel 字串 (NoExploit、ExploitIsPublic、ExploitIsVerified、ExploitIsInKit) 弱點的可惡意探索性層級
FirstSeenTimestamp 字串 第一次在裝置上看到產品的 CVE。
識別碼 字串 記錄的唯一標識碼。
LastSeenTimestamp 字串 上次在裝置上看到 CVE。
OSPlatform 字串 在裝置上執行之作業系統的平臺;在相同系列內具有變化的特定操作系統，例如 Windows 10 和 Windows 11。 如需詳細資訊，請參閱 支援的操作系統、平臺和功能 。
RbacGroupName 字串 角色型訪問控制 (RBAC) 群組。 如果未將此裝置指派給任何 RBAC 群組，則值會是 “Unassigned”。如果組織不包含任何 RBAC 群組，則值會是 「None」。
RecommendationReference 字串 與此軟體相關的建議標識碼參考。
RecommendedSecurityUpdate 字串 軟體廠商提供的安全性更新名稱或描述，以解決此弱點。
RecommendedSecurityUpdateId 字串 對應指引或 知識庫 (KB) 文章適用安全性更新或標識碼的標識碼
RegistryPaths Array[string] 裝置中已安裝產品的登錄辨識項。
SoftwareName 字串 軟體產品的名稱。
SoftwareVendor 字串 軟體廠商的名稱。
SoftwareVersion 字串 軟體產品的版本號碼。
狀態 字串 裝置) 上引進新弱點的新 (。 已 修正 (裝置上不再存在的弱點，這表示已補救) 。 已針對 已變更裝置上的弱點更新 (。可能的變更包括：CVSS 分數、惡意探索性層級、嚴重性層級、DiskPaths、RegistryPaths、RecommendedSecurityUpdate) 。
VulnerabilitySeverityLevel 字串 根據 CVSS 分數指派給安全性弱點的嚴重性層級。

4.導出非產品代碼軟體清查評估

傳回所有沒有 通用平臺列舉 (CPE) 及其在每個裝置上的詳細數據的已安裝軟體。

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 記憶體下載所有數據的 URL。 此 API 可讓您從 Azure 記憶體下載數據，如下所示：
  1. 呼叫 API 以取得包含組織數據的下載 URL 清單
  2. 使用下載 URL 下載檔，並視需要處理數據。

4.2 JSON 回應 (屬性)

屬性 (識別碼) 資料類型 描述
DeviceId 字串 服務中裝置的唯一標識符。
DeviceName 字串 裝置的 FQDN) (完整功能變數名稱。
OSPlatform 字串 在裝置上執行之作業系統的平臺。 這些是相同系列內有變化的特定操作系統，例如 Windows 10和 Windows 11。 如需詳細資訊，請參閱 支援的操作系統、平臺和功能 。
RbacGroupName 字串 角色型訪問控制 (RBAC) 群組。 如果未將此裝置指派給任何 RBAC 群組，則值會是 “Unassigned”。如果組織不包含任何 RBAC 群組，則值會是 「None」。
RbacGroupId 字串 角色型訪問控制 (RBAC) 群組標識碼。
SoftwareLastSeenTimestamp 字串 上次在裝置上看到此軟體的時間。
SoftwareName 字串 軟體產品的名稱。
SoftwareVendor 字串 軟體廠商的名稱。
SoftwareVersion 字串 軟體產品的版本號碼。

4.3 透過檔案 (的屬性)

屬性 (識別碼) 資料類型 描述
匯出檔案 array[string] 保存組織目前快照集之檔案的下載 URL 清單。
GeneratedTime 字串 產生匯出的時間。

另請參閱

其他相關

提示

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