匯出裝置防病毒軟體健康情況詳細數據 API 方法和屬性
適用於：
想要體驗適用於端點的 Microsoft Defender 嗎？ 注册免費試用版。
注意事項
如果您是美國政府客戶，請使用美國政府客戶 適用於端點的 Microsoft Defender 中所列的 URI。
提示
為了獲得更好的效能，您可以使用更接近您地理位置的伺服器：
- us.api.security.microsoft.com
- eu.api.security.microsoft.com
- uk.api.security.microsoft.com
- au.api.security.microsoft.com
- swa.api.security.microsoft.com
- ina.api.security.microsoft.com
重要事項
本文中的部分資訊與發行前版本產品有關，在產品正式發行前可能會大幅度修改。 Microsoft 對此處提供的資訊，不提供任何明確或隱含的瑕疵擔保。
匯出裝置防病毒軟體健康情況詳細數據 API 描述
擷取 Microsoft Defender 防病毒軟體裝置健康情況詳細數據的清單。 此 API 有不同的 API 呼叫， (方法) 取得不同類型的數據。 因為數據量可能很大，所以有兩種方式可以擷取：
JSON 回應 API 會將組織中的所有數據提取為 JSON 回應。 此方法最適合 裝置少於 100 K 的小型組織。 回應會進行分頁，因此您可以使用回應中的 @odata.nextLink 欄位來擷取下一個結果。
透過檔案 此 API 解決方案可讓您更快速且更可靠地提取大量數據，並建議用於擁有超過 100,000 部裝置的大型組織。 此 API 會將組織中的所有資料提取為下載檔。 回應包含可從 Azure 記憶體下載所有數據的 URL。 此 API 可讓您從 Azure 記憶體下載所有資料，如下所示：
呼叫 API 以取得包含您所有組織資料的下載 URL 清單。
使用下載 URL 下載所有檔案，並視需要處理數據。
使用或 使用 JSON response 檔案收集的數據是目前狀態的快照集。 此數據不包含歷程記錄數據。 若要收集歷程記錄數據，您必須將資料儲存在自己的數據記憶體中。
重要事項
若要 Windows Server 2012 R2 和 Windows Server 2016 出現在裝置健康情況報告中，這些裝置必須使用新式整合解決方案套件上線。 如需詳細資訊，請參閱適用於 Windows Server 2012 R2 和 2016 的新式整合解決方案中的新功能。
如需在 Microsoft Defender 入口網站中使用裝置健康情況和防病毒軟體合規性報告工具的相關信息，請參閱：適用於端點的 Microsoft Defender 中的裝置健康情況和防病毒軟體報告。
1.1 導出裝置防病毒軟體健康情況詳細數據 API 方法
| 方法 | 資料類型 | 描述 |
|---|---|---|
| (JSON 回應) | Microsoft Defender 每個裝置集合的防病毒軟體健康情況。 請參閱 ：1.2 匯出裝置防病毒軟體健康情況詳細資料 API 屬性 (JSON 回應) | 傳回數據表，其中包含 DeviceId、 ConfigurationId 之每個唯一組合的專案。 API 會將組織中的所有數據提取為 JSON 回應。 此方法最適合裝置少於 100 K 的小型組織。 回應是分頁的，因此您可以使用 @odata.nextLink 回應中的 字段來擷取下一個結果。 |
| 透過檔案) ( | Microsoft Defender 每個裝置集合的防病毒軟體健康情況。 請參閱： 1.3 透過檔案 (匯出裝置防病毒軟體健康情況詳細資料 API 屬性) | 傳回數據表，其中包含 DeviceId、 ConfigurationId 之每個唯一組合的專案。 此 API 解決方案可讓您更快速且更可靠地提取大量數據。 因此，建議大型組織使用超過100 K的裝置。 此 API 會將組織中的所有資料提取為下載檔。 回應包含可從 Azure 記憶體下載所有數據的 URL。 此 API 可讓您從 Azure 記憶體下載所有資料，如下所示：
|
1.2 限制
- 頁面大小上限：200,000
- 此 API 的速率限制：每分鐘 30 次呼叫，每小時 1,000 次呼叫
1.3 匯出裝置防病毒軟體健康情況詳細數據 API 屬性 (JSON 回應)
- 下表中定義的屬性會依字母順序依屬性標識碼列出。 當您使用此 API 時，產生的輸出不一定會以此數據表所列的相同順序傳回。
- 請注意， 不支援 rbacgroupname 和 Id 篩選運算子。
- 回應中可能會傳回更多數據行。 這些數據行可以是暫時性的，而且可能會被移除;只使用記載的數據行。
| 屬性 (識別碼) | 資料類型 | 描述 | 傳回值的範例 |
|---|---|---|---|
avEngineUpdateTime |
DateTimeOffset | 上次更新裝置上防病毒軟體引擎的日期時間 | “2022-08-04T12：44：02Z” |
avEngineVersion |
字串 | 防病毒軟體引擎版本 | 1.1.19400.3 |
avIsEngineUpToDate |
字串 | 防病毒軟體引擎的最新狀態 |
True、False 或 Unknown |
avIsPlatformUpToDate |
字串 | 防病毒軟體平臺的最新狀態 |
True、False 或 Unknown |
avIsSignatureUpToDate |
字串 | 防病毒軟體簽章的最新狀態 |
True、False 或 Unknown |
avMode |
字串 | 防病毒軟體模式。 | 每個模式都是字串類型整數值，範圍從 0 到 5。 '' = Other0 = Active1 = Passive2 = Disabled3 = Other4 = EDRBlocked5 = PassiveAudit |
avPlatformUpdateTime |
DateTimeOffset | 上次在裝置上更新防病毒軟體平臺的日期時間 | “2022-08-04T12：44：02Z” |
avPlatformVersion |
字串 | 防病毒軟體平臺版本 | 4.18.2203.5 |
avSignaturePublishTime |
DateTimeOffset | 釋放防病毒軟體安全情報組建的日期時間 | “2022-08-04T12：44：02Z” |
avSignatureUpdateTime |
DateTimeOffset | 上次更新裝置上防病毒軟體安全情報的日期時間 | “2022-08-04T12：44：02Z” |
avSignatureVersion |
字串 | 防病毒軟體安全情報版本 | 1.371.1323.0 |
computerDnsName |
字串 | DNS 名稱 | SampleDns |
dataRefreshTimestamp |
DateTimeOffset | 重新整理此報表數據的日期時間 | 2022-08-04T12:44:02Z |
fullScanError |
字串 | 完整掃描的錯誤碼 | “0x80508023” |
fullScanResult |
字串 | 裝置的完整掃描結果 |
Completed、Canceled 或 Failed |
fullScanTime |
DateTimeOffset | 完整掃描完成的日期時間 | 2022-08-04T12:44:02Z |
id |
字串 | 機器 GUID | 30a8fa2826abf24d24379b23f8a44d471f00feab |
lastSeenTime |
DateTimeOffset | 這部電腦的上次查看日期時間 | 2022-08-04T12:44:02Z |
machineId |
字串 | 機器 GUID | 30a8fa2826abf24d24379b23f8a44d471f00feab |
osKind |
字串 | 作系統種類 |
windows、mac 或 linux |
osPlatform |
字串 | 作系統主要版本名稱 |
Windows 10 或 macOS |
osVersion |
字串 | 作業系統版本 | 10.0.18363.1440, 12.4.0.0 |
quickScanError |
字串 | 快速掃描的錯誤碼 | 0x80508023 |
quickScanResult |
字串 | 此裝置的快速掃描結果 |
Completed、Canceled 或 Failed |
quickScanTime |
DateTimeOffset | 快速掃描完成的日期時間 | 2022-08-04T12:44:02Z |
rbacGroupId |
Long | 這部電腦所屬的裝置群組標識碼 | 712 |
rbacGroupName |
字串 | 此電腦所屬的裝置組名 | SampleGroup |
1.4 透過檔案匯出裝置防病毒軟體健康情況詳細數據 API 屬性 ()
重要事項
本節中的資訊與發行前版本產品有關，可在正式發行前進行大幅修改。 Microsoft 對此處提供的資訊，不提供任何明確或隱含的瑕疵擔保。
注意事項
- 檔案是以 gzip 壓縮和多行
.json格式。 - 下載 URL 的有效期只有 3 小時;否則，您可以使用 參數。
- 如需數據的最大下載速度，您可以確定您是從數據所在的相同 Azure 區域下載。
- 每筆記錄會使用大約 1 KB 的數據。 當您選擇正確的
pageSize參數時，應該將此納入考慮。 - 回應中可能會傳回更多數據行。 這些數據行是暫時性的，而且可能會被移除，因此請只使用記載的數據行。
| 屬性 (識別碼) | 資料類型 | 描述 | 傳回值的範例 |
|---|---|---|---|
| 匯出檔案 | array[string] | 保存組織目前快照集之檔案的下載 URL 清單。 | ["https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...1", "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...2"] |
| GeneratedTime | 字串 | 產生匯出的時間。 | 2022-05-20T08：00：00Z |
注意事項
在每個匯出檔案中，都有一個名為的 DeviceGatheredInfo屬性，其中包含防病毒軟體數據。 其每個屬性都可以為您提供裝置健康情況和狀態的相關信息。
另請參閱
提示
想要深入了解? Engage 技術社群中的Microsoft安全性社群：適用於端點的 Microsoft Defender 技術社群。