通过

Workspaces - Update Workspace

服务:
Core
API 版本:
v1

更新指定的工作区属性。

权限

调用方必须具有 管理员 工作区角色。

所需的委派范围

Workspace.ReadWrite.All

Microsoft Entra 支持的标识

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

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

接口

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}

URI 参数

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

string (uuid)

工作区 ID。

请求正文

名称 类型 说明
description

string

工作区说明。
说明不能包含超过 4000 个字符。
displayName

string

工作区显示名称。
显示名称不能包含超过 256 个字符。
工作区名称在租户中必须是唯一的。
“管理员监视”是保留的工作区名称。

响应

名称 类型 说明
200 OK

Workspace

请求成功完成。
Other Status Codes

ErrorResponse

常见错误代码：

  • UnknownError - 发生错误。

示例

Update a workspace example

示例请求

PATCH https://api.fabric.microsoft.com/v1/workspaces/33bae707-5fe7-4352-89bd-061a1318b60a

{
  "displayName": "Workspace New displayName",
  "description": "Workspace New description"
}

示例响应

状态代码:
200 
{
  "id": "33bae707-5fe7-4352-89bd-061a1318b60a",
  "displayName": "Workspace New displayName",
  "description": "Workspace New description",
  "type": "Workspace",
  "domainId": "686177b9-ef29-45e4-a5db-1786ca6dbb9f"
}

定义

名称 说明
ErrorRelatedResource

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

错误响应。
ErrorResponseDetails

错误响应详细信息。
UpdateWorkspaceRequest

更新工作区请求有效负载。
Workspace

工作区对象。
WorkspaceType

工作区类型。 可能会随着时间的推移添加其他工作区类型。

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

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

UpdateWorkspaceRequest

Object

更新工作区请求有效负载。

名称 类型 说明
description

string

工作区说明。
说明不能包含超过 4000 个字符。
displayName

string

工作区显示名称。
显示名称不能包含超过 256 个字符。
工作区名称在租户中必须是唯一的。
“管理员监视”是保留的工作区名称。

Workspace

Object

工作区对象。

名称 类型 说明
apiEndpoint

string (uri)

表示特定于工作区的 API 终结点的 HTTP URL。 当用户启用 preferWorkspaceSpecificEndpoints 时，将返回此终结点值。 它允许通过专用链接访问 API。
capacityId

string (uuid)

工作区分配给的容量的 ID。
description

string

工作区说明。
displayName

string

工作区显示名称。
domainId

string (uuid)

工作区分配到的域的 ID。
id

string (uuid)

工作区 ID。
type

WorkspaceType

工作区类型。

WorkspaceType

枚举

工作区类型。 可能会随着时间的推移添加其他工作区类型。

值 说明
Personal

我的文件夹或用于管理用户项的工作区。
Workspace

用于管理 Fabric 项的工作区。
AdminWorkspace

管理员监视工作区。 包含管理员报告，例如审核报告以及使用情况和采用报告。