Workspaces - Add Workspace Role Assignment

添加工作区角色分配。
若要获取请求正文所需的主体用户对象 ID,请参阅 “查找用户对象 ID”。

权限

  • 调用方必须具有 成员 或更高的工作区角色。
  • 成员可以添加具有较低权限的成员或其他成员。 有关详细信息,请参阅: 工作区角色

所需的委派范围

Workspace.ReadWrite.All

局限性

  • 每个工作区限制为工作区角色(管理员、成员、参与者、查看器)中的最多 1,000 个用户或组。 组中的用户数不受限制。 此限制还涵盖外部来宾。

Microsoft Entra 支持的标识

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

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

接口

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

URI 参数

名称 必需 类型 说明
workspaceId
path True

string (uuid)

工作区 ID。

请求正文

名称 必需 类型 说明
principal True

Principal

主体。

role True

WorkspaceRole

主体的工作区角色。

响应

名称 类型 说明
201 Created

WorkspaceRoleAssignment

已成功创建。

标头

Location: string

Other Status Codes

ErrorResponse

常见错误代码:

  • UnknownError - 发生错误。

示例

Add workspace role assignment example

示例请求

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff512/roleAssignments

{
  "principal": {
    "id": "8eedb1b0-3af8-4b17-8e7e-663e61e12211",
    "type": "User"
  },
  "role": "Member"
}

示例响应

Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff512/roleAssignments/8eedb1b0-3af8-4b17-8e7e-663e61e12211
{
  "id": "8eedb1b0-3af8-4b17-8e7e-663e61e12211",
  "principal": {
    "id": "8eedb1b0-3af8-4b17-8e7e-663e61e12211",
    "type": "User"
  },
  "role": "Member"
}

定义

名称 说明
AddWorkspaceRoleAssignmentRequest

添加工作区角色分配请求有效负载。

ErrorRelatedResource

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

ErrorResponse

错误响应。

ErrorResponseDetails

错误响应详细信息。

GroupDetails

组特定详细信息。 当主体类型 Group时适用。

GroupType

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

Principal

表示标识或Microsoft Entra 组。

PrincipalType

主体的类型。 可能会随着时间的推移添加其他主体类型。

ServicePrincipalDetails

服务主体特定详细信息。 当主体类型 ServicePrincipal时适用。

ServicePrincipalProfileDetails

服务主体配置文件详细信息。 当主体类型 ServicePrincipalProfile时适用。

UserDetails

用户主体特定详细信息。 当主体类型 User时适用。

WorkspaceRole

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

WorkspaceRoleAssignment

工作区角色分配对象。

AddWorkspaceRoleAssignmentRequest

添加工作区角色分配请求有效负载。

名称 类型 说明
principal

Principal

主体。

role

WorkspaceRole

主体的工作区角色。

ErrorRelatedResource

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

名称 类型 说明
resourceId

string

错误中涉及的资源 ID。

resourceType

string

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

ErrorResponse

错误响应。

名称 类型 说明
errorCode

string

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

message

string

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

moreDetails

ErrorResponseDetails[]

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

relatedResource

ErrorRelatedResource

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

requestId

string

与错误关联的请求的 ID。

ErrorResponseDetails

错误响应详细信息。

名称 类型 说明
errorCode

string

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

message

string

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

relatedResource

ErrorRelatedResource

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

GroupDetails

组特定详细信息。 当主体类型 Group时适用。

名称 类型 说明
groupType

GroupType

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

GroupType

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

说明
Unknown

主体组类型未知。

SecurityGroup

主体是安全组。

DistributionList

主体是通讯组列表。

Principal

表示标识或Microsoft Entra 组。

名称 类型 说明
displayName

string

主体的显示名称。

groupDetails

GroupDetails

组特定详细信息。 当主体类型 Group时适用。

id

string (uuid)

主体的 ID。

servicePrincipalDetails

ServicePrincipalDetails

服务主体特定详细信息。 当主体类型 ServicePrincipal时适用。

servicePrincipalProfileDetails

ServicePrincipalProfileDetails

服务主体配置文件详细信息。 当主体类型 ServicePrincipalProfile时适用。

type

PrincipalType

主体的类型。 可能会随着时间的推移添加其他主体类型。

userDetails

UserDetails

用户主体特定详细信息。 当主体类型 User时适用。

PrincipalType

主体的类型。 可能会随着时间的推移添加其他主体类型。

说明
User

主体是Microsoft Entra 用户主体。

ServicePrincipal

主体是Microsoft Entra 服务主体。

Group

主体是安全组。

ServicePrincipalProfile

主体是服务主体配置文件。

EntireTenant

主体表示所有租户用户。

ServicePrincipalDetails

服务主体特定详细信息。 当主体类型 ServicePrincipal时适用。

名称 类型 说明
aadAppId

string (uuid)

服务主体的 Microsoft Entra AppId。

ServicePrincipalProfileDetails

服务主体配置文件详细信息。 当主体类型 ServicePrincipalProfile时适用。

名称 类型 说明
parentPrincipal

Principal

服务主体配置文件的父主体。

UserDetails

用户主体特定详细信息。 当主体类型 User时适用。

名称 类型 说明
userPrincipalName

string

用户主体名称。

WorkspaceRole

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

说明
Admin

启用对工作区的管理访问权限。

Member

启用对工作区的成员身份访问。

Contributor

启用对工作区的贡献。

Viewer

启用工作区的查看。

WorkspaceRoleAssignment

工作区角色分配对象。

名称 类型 说明
id

string (uuid)

工作区角色分配 ID。

principal

Principal

主体。

role

WorkspaceRole

主体的工作区角色。