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 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
workspace
|
path | True |
string (uuid) |
工作区 ID。 |
请求正文
| 名称 | 必需 | 类型 | 说明 |
|---|---|---|---|
| principal | True |
主体。 |
|
| role | True |
主体的工作区角色。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 201 Created |
已成功创建。 标头 Location: string |
|
| Other Status Codes |
常见错误代码:
|
示例
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"
}
定义
| 名称 | 说明 |
|---|---|
|
Add |
添加工作区角色分配请求有效负载。 |
|
Error |
与错误相关的资源详细信息对象。 |
|
Error |
错误响应。 |
|
Error |
错误响应详细信息。 |
|
Group |
组特定详细信息。 当主体类型 |
|
Group |
组的类型。 可能会随着时间的推移添加其他组类型。 |
| Principal |
表示标识或Microsoft Entra 组。 |
|
Principal |
主体的类型。 可能会随着时间的推移添加其他主体类型。 |
|
Service |
服务主体特定详细信息。 当主体类型 |
|
Service |
服务主体配置文件详细信息。 当主体类型 |
|
User |
用户主体特定详细信息。 当主体类型 |
|
Workspace |
工作区角色。 可能会随着时间的推移添加其他工作区角色。 |
|
Workspace |
工作区角色分配对象。 |
AddWorkspaceRoleAssignmentRequest
添加工作区角色分配请求有效负载。
| 名称 | 类型 | 说明 |
|---|---|---|
| principal |
主体。 |
|
| role |
主体的工作区角色。 |
ErrorRelatedResource
与错误相关的资源详细信息对象。
| 名称 | 类型 | 说明 |
|---|---|---|
| resourceId |
string |
错误中涉及的资源 ID。 |
| resourceType |
string |
错误中涉及的资源的类型。 |
ErrorResponse
错误响应。
| 名称 | 类型 | 说明 |
|---|---|---|
| errorCode |
string |
提供有关错误条件的信息的特定标识符,允许服务与其用户之间的标准化通信。 |
| message |
string |
错误的人工可读表示形式。 |
| moreDetails |
其他错误详细信息的列表。 |
|
| relatedResource |
与错误相关的资源详细信息。 |
|
| requestId |
string |
与错误关联的请求的 ID。 |
ErrorResponseDetails
错误响应详细信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| errorCode |
string |
提供有关错误条件的信息的特定标识符,允许服务与其用户之间的标准化通信。 |
| message |
string |
错误的人工可读表示形式。 |
| relatedResource |
与错误相关的资源详细信息。 |
GroupDetails
组特定详细信息。 当主体类型 Group时适用。
| 名称 | 类型 | 说明 |
|---|---|---|
| groupType |
组的类型。 可能会随着时间的推移添加其他组类型。 |
GroupType
组的类型。 可能会随着时间的推移添加其他组类型。
| 值 | 说明 |
|---|---|
| Unknown |
主体组类型未知。 |
| SecurityGroup |
主体是安全组。 |
| DistributionList |
主体是通讯组列表。 |
Principal
表示标识或Microsoft Entra 组。
| 名称 | 类型 | 说明 |
|---|---|---|
| displayName |
string |
主体的显示名称。 |
| groupDetails |
组特定详细信息。 当主体类型 |
|
| id |
string (uuid) |
主体的 ID。 |
| servicePrincipalDetails |
服务主体特定详细信息。 当主体类型 |
|
| servicePrincipalProfileDetails |
服务主体配置文件详细信息。 当主体类型 |
|
| type |
主体的类型。 可能会随着时间的推移添加其他主体类型。 |
|
| userDetails |
用户主体特定详细信息。 当主体类型 |
PrincipalType
主体的类型。 可能会随着时间的推移添加其他主体类型。
| 值 | 说明 |
|---|---|
| User |
主体是Microsoft Entra 用户主体。 |
| ServicePrincipal |
主体是Microsoft Entra 服务主体。 |
| Group |
主体是安全组。 |
| ServicePrincipalProfile |
主体是服务主体配置文件。 |
| EntireTenant |
主体表示所有租户用户。 |
ServicePrincipalDetails
服务主体特定详细信息。 当主体类型 ServicePrincipal时适用。
| 名称 | 类型 | 说明 |
|---|---|---|
| aadAppId |
string (uuid) |
服务主体的 Microsoft Entra AppId。 |
ServicePrincipalProfileDetails
服务主体配置文件详细信息。 当主体类型 ServicePrincipalProfile时适用。
| 名称 | 类型 | 说明 |
|---|---|---|
| parentPrincipal |
服务主体配置文件的父主体。 |
UserDetails
用户主体特定详细信息。 当主体类型 User时适用。
| 名称 | 类型 | 说明 |
|---|---|---|
| userPrincipalName |
string |
用户主体名称。 |
WorkspaceRole
工作区角色。 可能会随着时间的推移添加其他工作区角色。
| 值 | 说明 |
|---|---|
| Admin |
启用对工作区的管理访问权限。 |
| Member |
启用对工作区的成员身份访问。 |
| Contributor |
启用对工作区的贡献。 |
| Viewer |
启用工作区的查看。 |
WorkspaceRoleAssignment
工作区角色分配对象。
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
string (uuid) |
工作区角色分配 ID。 |
| principal |
主体。 |
|
| role |
主体的工作区角色。 |