重要事項
本文中的部分資訊與發行前版本產品有關,在產品正式發行前可能會大幅度修改。 Microsoft 對此處提供的資訊,不提供任何明確或隱含的瑕疵擔保。
匯出裝置防毒健康細節 API 描述
取得 Microsoft Defender 防毒裝置健康資訊清單。 這個 API 有不同的 API 呼叫 (方法) 取得不同類型的資料。 由於資料量可能很大,有兩種方式可以擷取:
JSON API 會以 JSON 回應形式拉取組織內所有資料。 此方法最適合 裝置少於 100-K 的小型組織。 回應是分頁的,所以你可以用回應中的 @odata.nextLink 欄位來取得下一個結果。
檔案 此 API 解決方案能更快且更可靠地拉取大量資料,建議給擁有超過 100,000 台裝置的大型組織。 這個 API 會以下載檔案形式拉取你組織內的所有資料。 回應包含從 Azure 儲存下載所有資料的網址。 此 API 允許您從 Azure 儲存裝置下載所有資料,具體如下:
呼叫 API 以獲得包含所有組織資料的下載網址清單。
用下載網址下載所有檔案,並依照你的需求處理資料。
使用或 JSON response 使用檔案收集的資料,是當前狀態的快照。 這些資料不包含歷史資料。 要收集歷史資料,你必須將資料儲存在自己的資料儲存中。
關於在Microsoft Defender入口中使用裝置健康與防毒合規報告工具的資訊,請參見:裝置健康與防毒報告於適用於端點的 Microsoft Defender。
必要條件
- 若要讓 Windows Server 2012 R2 與 Windows Server 2016 出現在裝置健康報告中,這些裝置必須使用現代統一解決方案套件進行上線。 欲了解更多資訊,請參閱 Windows Server 2012 R2 與 2016 現代統一解決方案的新功能。
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 儲存下載所有資料的網址。 此 API 允許您從 Azure 儲存裝置下載所有資料,具體如下:
|
1.2 限制
- 最大頁數:200,000
- 此 API 的速率限制:每分鐘 30 次呼叫及每小時 1,000 次呼叫
1.3 匯出裝置防毒健康細節 API 屬性 (JSON 回應)
- 下表中定義的屬性依屬性 ID 字母順序排列。 當你使用這個 API 時,產生的輸出不一定會以表格中列出的相同順序回傳。
- 請注意, rbacgroupname 和 Id 並不支援使用過濾操作符。
- 回覆中可能會回覆更多專欄。 這些欄位可能是暫時的,且可能被移除;只使用已記錄的欄位。
| 財產 (身份) | 資料類型 | 描述 | 回傳值的範例 |
|---|---|---|---|
avEngineUpdateTime |
日期時間偏移 | 防毒引擎最後一次更新的日期 | 「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 |
日期時間偏移 | 裝置上防毒平台最後更新的時間 | 「2022-08-04T12:44:02Z」 |
avPlatformVersion |
字串 | 防毒平台版本 | 4.18.2203.5 |
avSignaturePublishTime |
日期時間偏移 | 防毒安全情報版本發布的時間點 | 「2022-08-04T12:44:02Z」 |
avSignatureUpdateTime |
日期時間偏移 | 防毒安全情報最後一次更新裝置的時間 | 「2022-08-04T12:44:02Z」 |
avSignatureVersion |
字串 | 防毒安全智慧版本 | 1.371.1323.0 |
computerDnsName |
字串 | DNS 名稱 | SampleDns |
dataRefreshTimestamp |
日期時間偏移 | 本報告資料刷新的日期 | 2022-08-04T12:44:02Z |
fullScanError |
字串 | 完整掃描的錯誤代碼 | 「0x80508023」 |
fullScanResult |
字串 | 裝置的完整掃描結果 |
Completed、Canceled 或 Failed |
fullScanTime |
日期時間偏移 | 完整掃描完成的日期 | 2022-08-04T12:44:02Z |
id |
字串 | 機器 GUID | 30a8fa2826abf24d24379b23f8a44d471f00feab |
lastSeenTime |
日期時間偏移 | 這台機器最後一次出現的日期 | 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 |
日期時間偏移 | 快速掃描完成的日期 | 2022-08-04T12:44:02Z |
rbacGroupId |
Long | 這台機器所屬的裝置群組 ID | 712 |
rbacGroupName |
字串 | 該機器所屬的裝置群組名稱 | SampleGroup |
1.4 匯出裝置防毒健康細節 API 屬性 (透過檔案)
重要事項
本節資訊涉及預售產品,可在商業發行前進行大幅修改。 Microsoft 對此處提供的資訊,不提供任何明確或隱含的瑕疵擔保。
在每個匯出檔案中,都有一個屬性叫 DeviceGatheredInfo做 ,裡面包含防毒資料。 它的每個屬性都能提供裝置健康狀況與狀態的資訊。
- 這些檔案採用 gzip 壓縮,並採用多行
.json格式。 - 下載網址僅有效 3 小時;否則你可以用參數。
- 為了讓資料下載速度達到最高,你可以確保你下載的範圍和資料所在的 Azure 區域相同。
- 每筆紀錄約佔用 1KB 的資料。 在選擇正確
pageSize參數時,你應該考慮這點。 - 回覆中可能會回覆更多專欄。 這些欄位是暫時的,可能會被移除,因此只使用已記錄的欄位。
| 財產 (身份) | 資料類型 | 描述 | 回傳值的範例 |
|---|---|---|---|
| 匯出檔案 | array[string] | 一份包含組織當前快照檔案的下載網址清單。 | ["https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...1", "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...2"] |
| 生成時間 | 字串 | 出口產生的時間。 | 2022-05-20T08:00:00Z |