共用方式為

Domains - Update Domain

  • 參考
服務:
Admin
API 版本:
v1

注意

此 API 處於預覽狀態。

更新指定的網域資訊。

權限

呼叫端必須是網狀架構系統管理員。

必要的委派範圍

Tenant.ReadWrite.All。

局限性

每個主體每分鐘最多 25 個要求。

Microsoft Entra 支援的身分識別

此 API 支援本節中列出的Microsoft 身分識別。

身份 支援
使用者 是的
服務主體 和 受控識別 是的

介面

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

URI 參數

名稱 位於 必要 類型 Description
domainId
 path True

string

uuid

網域標識碼。

要求本文

名稱 類型 Description
contributorsScope

ContributorsScopeType

網域參與者範圍。
description

string

網域描述。 描述不能包含超過 256 個字元。
displayName

string

網域顯示名稱。 顯示名稱不能包含超過 40 個字元。

回應

名稱 類型 Description
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"
}

定義

名稱 Description
ContributorsScopeType

參與者範圍。 可能會隨著時間新增其他參與者範圍。
Domain

表示網域或子域。
ErrorRelatedResource

錯誤相關的資源詳細資料物件。
ErrorResponse

錯誤回應。
ErrorResponseDetails

錯誤回應詳細數據。
UpdateDomainRequest

更新網域的要求承載。

ContributorsScopeType

Enumeration

參與者範圍。 可能會隨著時間新增其他參與者範圍。

值 Description
AdminsOnly

僅限租用戶和網域系統管理員。
AllTenant

所有租用戶的使用者。
SpecificUsersAndGroups

特定使用者和群組。

Domain

Object

表示網域或子域。

名稱 類型 Description
contributorsScope

ContributorsScopeType

網域參與者範圍。
description

string

網域的描述。
displayName

string

功能變數名稱。
id

string

uuid

網域對象識別碼。
parentDomainId

string

uuid

網域父物件標識碼。

ErrorRelatedResource

Object

錯誤相關的資源詳細資料物件。

名稱 類型 Description
resourceId

string

發生錯誤的資源識別碼。
resourceType

string

發生錯誤的資源類型。

ErrorResponse

Object

錯誤回應。

名稱 類型 Description
errorCode

string

提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message

string

錯誤的人類可讀取表示法。
moreDetails

ErrorResponseDetails[]

其他錯誤詳細數據的清單。
relatedResource

ErrorRelatedResource

錯誤相關的資源詳細數據。
requestId

string

與錯誤相關聯的要求標識碼。

ErrorResponseDetails

Object

錯誤回應詳細數據。

名稱 類型 Description
errorCode

string

提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message

string

錯誤的人類可讀取表示法。
relatedResource

ErrorRelatedResource

錯誤相關的資源詳細數據。

UpdateDomainRequest

Object

更新網域的要求承載。

名稱 類型 Description
contributorsScope

ContributorsScopeType

網域參與者範圍。
description

string

網域描述。 描述不能包含超過 256 個字元。
displayName

string

網域顯示名稱。 顯示名稱不能包含超過 40 個字元。