domain:forceDelete

命名空间:microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

使用异步操作删除域。

在调用 forceDelete 之前,必须更新或删除对 Exchange 作为预配服务的任何引用。

以下操作作为此操作的一部分执行:

  • 使用对已删除域的引用重命名用户的 UPN、EmailAddress 和 ProxyAddress。

  • 重命名包含对已删除域的引用的组的 EmailAddress。

  • 使用对已删除域的引用重命名应用程序的 identifierUris。

  • 如果要重命名的对象数大于 1,000,则返回错误。

  • 如果要重命名的应用程序之一是多租户应用,则返回错误。

域删除完成后,已删除域的 API 操作将返回 404 HTTP 响应代码。 若要验证域的删除,可以执行 获取域。 如果已成功删除域,响应中将返回 404 HTTP 响应代码。

此 API 可用于以下国家级云部署

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) Domain.ReadWrite.All 不可用。
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用程序 Domain.ReadWrite.All 不可用。

工作或学校帐户至少需要属于域名管理员Microsoft Entra角色

HTTP 请求

POST /domains/{id}/forceDelete

对于 {id},请使用其完全限定的域名指定该域。

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权
Content-Type application/json

请求正文

在请求正文中,提供具有以下参数的 JSON 对象。

参数 类型 说明
disableUserAccounts 布尔值 用于禁用已重命名用户帐户的选项。 如果禁用了用户帐户,则不允许该用户登录。
True (默认) - 禁用在此操作过程中重命名的用户帐户。
False - 不会禁用在此操作过程中重命名的用户帐户。

响应

如果成功,此方法返回 200 OK 响应代码。

示例

请求

POST https://graph.microsoft.com/beta/domains/contoso.com/forceDelete
Content-type: application/json

{
  "disableUserAccounts": true
}

响应

HTTP/1.1 200 OK