通过

Domains - Update Domain

  • 参考
服务:
Admin
API 版本:
v1

注意

此 API 以预览版提供。

更新指定的域信息。

权限

调用方必须是 Fabric 管理员。

所需的委派范围

Tenant.ReadWrite.All。

局限性

每个主体每分钟最多 25 个请求。

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

身份 支持
用户 是的
服务主体 和 托管标识 是的

接口

PATCH https://api.fabric.microsoft.com/v1/admin/domains/{domainId}

URI 参数

名称 在 必需 类型 说明
domainId
 path True

string

uuid

域 ID。

请求正文

名称 类型 说明
contributorsScope

ContributorsScopeType

域参与者范围。
description

string

域说明。 说明不能包含超过 256 个字符。
displayName

string

域显示名称。 显示名称不能包含超过 40 个字符。

响应

名称 类型 说明
200 OK

Domain

请求成功完成。
Other Status Codes

ErrorResponse

常见错误代码：

  • UnknownError - 发生错误。

  • EntityConflict - 更新域失败，因为域显示名称已存在。

示例

Update a domain example

示例请求

PATCH https://api.fabric.microsoft.com/v1/admin/domains/97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f

{
  "displayName": "Domain's new name",
  "description": "Domain's new description",
  "contributorsScope": "SpecificUsersAndGroups"
}

示例响应

状态代码:
200 
{
  "id": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
  "displayName": "Domain's new name",
  "description": "Domain's new description",
  "parentDomainId": null,
  "contributorsScope": "SpecificUsersAndGroups"
}

定义

名称 说明
ContributorsScopeType

参与者范围。 可能会随着时间的推移添加其他参与者范围。
Domain

表示域或子域。
ErrorRelatedResource

与错误相关的资源详细信息对象。
ErrorResponse

错误响应。
ErrorResponseDetails

错误响应详细信息。
UpdateDomainRequest

用于更新域的请求有效负载。

ContributorsScopeType

Enumeration

参与者范围。 可能会随着时间的推移添加其他参与者范围。

值 说明
AdminsOnly

仅租户和域管理员。
AllTenant

租户的所有用户。
SpecificUsersAndGroups

特定用户和组。

Domain

Object

表示域或子域。

名称 类型 说明
contributorsScope

ContributorsScopeType

域参与者范围。
description

string

域的说明。
displayName

string

域的名称。
id

string

uuid

域对象 ID。
parentDomainId

string

uuid

域父对象 ID。

ErrorRelatedResource

Object

与错误相关的资源详细信息对象。

名称 类型 说明
resourceId

string

错误中涉及的资源 ID。
resourceType

string

错误中涉及的资源的类型。

ErrorResponse

Object

错误响应。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
moreDetails

ErrorResponseDetails[]

其他错误详细信息的列表。
relatedResource

ErrorRelatedResource

与错误相关的资源详细信息。
requestId

string

与错误关联的请求的 ID。

ErrorResponseDetails

Object

错误响应详细信息。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
relatedResource

ErrorRelatedResource

与错误相关的资源详细信息。

UpdateDomainRequest

Object

用于更新域的请求有效负载。

名称 类型 说明
contributorsScope

ContributorsScopeType

域参与者范围。
description

string

域说明。 说明不能包含超过 256 个字符。
displayName

string

域显示名称。 显示名称不能包含超过 40 个字符。