域:forceDelete

命名空间:microsoft.graph

重要

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

使用异步操作删除域。

在调用 forceDelete之前,必须更新或删除对 Exchange设置服务 的任何引用。

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

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

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

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

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

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

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

Permissions

要调用此 API,需要以下权限之一。要了解详细信息,包括如何选择权限的信息,请参阅权限

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

HTTP 请求

POST /domains/{id}/forceDelete

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

请求标头

名称 说明
Authorization Bearer {token}。必需。
Content-Type application/json

请求正文

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

参数 类型 说明
disableUserAccounts 布尔 用于禁用重命名的用户帐户的选项。 如果禁用用户帐户,将不允许用户登录。
为 ( 默认) - 已禁用作为此操作的一部分重命名的用户帐户。
False - 不会禁用作为此操作的一部分重命名的用户帐户。

响应

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

示例

请求

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

{
  "disableUserAccounts": true
}

响应

HTTP/1.1 200 OK