執行防病毒軟體掃描 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
API 描述
起始Microsoft裝置上的Defender防病毒軟體掃描。
限制
- 此 API 的速率限制為每分鐘 100 次呼叫,每小時 1500 次呼叫。
注意事項
此頁面著重於透過 API 執行機器動作。 如需透過適用於端點的Defender Microsoft回應動作功能的詳細資訊,請參閱在 電腦上採取回應動作 。
重要事項
- 此動作適用於 Windows 10 版本 1709 或更新版本,以及 Windows 11 上的裝置。
- Microsoft Defender 防病毒軟體掃描可以與其他防病毒軟體解決方案一起執行,不論Microsoft Defender 防病毒軟體是否為作用中的防病毒軟體解決方案。 Microsoft Defender 防病毒軟體可以處於被動模式。 如需詳細資訊, 請參閱 Microsoft Defender 防病毒軟體相容性。
權限
呼叫此 API 需要下列其中一個許可權。 若要深入瞭解,包括如何選擇許可權,請參 閱使用適用於端點的 Defender Microsoft API
許可權類型 | 權限 | 許可權顯示名稱 |
---|---|---|
應用程式 | Machine.Scan | 'Scan machine' |
委派 (公司或學校帳戶) | Machine.Scan | 'Scan machine' |
注意事項
使用使用者認證取得權杖時:
適用於端點的Defender方案1和方案2支援裝置群組建立。
HTTP 要求
POST https://api.security.microsoft.com/api/machines/{id}/runAntiVirusScan
要求標頭
名稱 | 類型 | 描述 |
---|---|---|
授權 | 字串 | 持有人 {token}。 必要。 |
Content-Type | 字串 | application/json |
要求內文
在要求本文中,提供具有下列參數的 JSON 物件:
參數 | Type | 描述 |
---|---|---|
留言 | 字串 | 要與動作相關聯的批注。 必要。 |
ScanType | 字串 | 定義掃描的類型。 必要。 |
ScanType 可控制要執行的掃描類型,而且可以是下列其中一項:
- 快速:在裝置上執行快速掃描
- 完整:在裝置上執行完整掃描
回應
如果成功,這個方法會傳回響應主體中的 201、Created 回應碼和 MachineAction 物件。
如果您傳送多個 API 呼叫來執行相同裝置的防病毒軟體掃描,它會傳回「擱置中的機器動作」或 HTTP 400,並顯示「動作已在進行中」訊息。
範例
請求
以下是要求的範例。
POST https://api.security.microsoft.com/api/machines/1e5bc9d7e413ddd7902c2932e418702b84d0cc07/runAntiVirusScan
{
"Comment": "Check machine for viruses due to alert 3212",
"ScanType": "Full"
}
提示
想要深入了解? 在我們的技術社群中與Microsoft安全性社群互動:Microsoft適用於端點的Defender技術社群。