API 说明
从 Defender for Endpoint 卸载设备。
先决条件
支持的操作系统
| 操作系统 | 支持的版本 |
|---|---|
| Windows客户端 | Windows 11 和 Windows 10，版本 1703 及以后版本 |
| Windows Server | Windows Server 2019及以后版本;使用新的统一代理 Defender for Endpoint 时，使用 Windows Server 2012 R2 和 Windows Server 2016 |
| macOS | macOS 14及以后版本 |
| Linux | 支持的Linux分发版 |
限制
- 此 API 的速率限制是每分钟 100 个调用和每小时 1,500 个调用。
- 在 Windows 设备上，运行 Offboarding API 只会停止传感器服务。 它不会像离职脚本那样从登记册中删除入职信息。
权限
Microsoft 建议使用权限最少的角色。 这有助于提高组织的安全性。 全局管理员是一个权限很高的角色，应仅限于在无法使用现有角色的紧急情况下使用。
使用用户凭据获取令牌时：
要调用此 API，需要以下权限之一。 若要了解详细信息（包括如何选择权限），请参阅 使用 Defender for Endpoint API
| 权限类型 | 权限 | 权限显示名称 |
|---|---|---|
| 应用程序 | Machine.Offboard |
Offboard machine |
| 委派（工作或学校帐户） | Machine.Offboard |
Offboard machine |
HTTP 请求
POST https://api.security.microsoft.com/api/machines/{id}/offboard
选择设备时，可以在 URL 中找到计算机 ID。 通常，它是可在 URL 中找到的 40 位字母数字。
请求标头
| 名称 | 类型 | 说明 |
|---|---|---|
| Authorization | String | 持有者 {token}。 必需。 |
| Content-Type | 字符串 | application/json. 必需。 |
请求正文
在请求正文中，提供具有以下参数的 JSON 对象：
| 参数 | 类型 | 说明 |
|---|---|---|
| 评论 | String | 要与操作关联的注释。 必需。 |
响应
如果成功，此方法在 200 - Created response 响应正文中返回代码和 计算机操作 。
示例
请求
下面是请求的示例。 如果未添加 JSON 注释，则代码 400出错。
POST https://api.security.microsoft.com/api/machines/1e5bc9d7e413ddd7902c2932e418702b84d0cc07/offboard
{
"Comment": "Offboard machine by automation"
}