Gateways - Add Gateway Role Assignment

服务:

Core

API 版本:

v1

注意

此 API 以预览版提供。

添加网关角色分配。
若要获取请求正文所需的主体用户 ID，请参阅 查找用户 ID。

网关角色分配不支持服务主体配置文件。

权限

• 调用方必须在网关上具有 ConnectionCreatorWithResharing 或更高版本的角色。

所需的委派范围

Gateway.ReadWrite.All

Microsoft Entra 支持的标识

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

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

接口

POST https://api.fabric.microsoft.com/v1/gateways/{gatewayId}/roleAssignments

URI 参数

名称	在	必需	类型	说明
gatewayId	path	True	string uuid	网关的 ID。

请求正文

名称	必需	类型	说明
principal	True	Principal	主体。
role	True	GatewayRole	主体的网关角色。

响应

名称	类型	说明
201 Created	GatewayRoleAssignment	已成功创建。 标头 Location: string
Other Status Codes	ErrorResponse	常见错误代码： BadRequest - 缺少必需的参数。

示例

Add gateway role assignment example

示例请求

HTTP

POST https://api.fabric.microsoft.com/v1/gateways/d12d139f-4141-467c-9f53-80787b198843/roleAssignments

{
  "principal": {
    "id": "6a002b3d-e4ec-43df-8c08-e8eb7547d9dd",
    "type": "User"
  },
  "role": "ConnectionCreator"
}

示例响应

状态代码:

201

Location: https://api.fabric.microsoft.com/v1/gateways/d12d139f-4141-467c-9f53-80787b198843/roleAssignments/6a002b3d-e4ec-43df-8c08-e8eb7547d9dd

{
  "id": "6a002b3d-e4ec-43df-8c08-e8eb7547d9dd",
  "principal": {
    "id": "6a002b3d-e4ec-43df-8c08-e8eb7547d9dd",
    "type": "User"
  },
  "role": "ConnectionCreator"
}

定义

名称	说明
AddGatewayRoleAssignmentRequest	为主体添加网关角色分配请求。
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
GatewayRole	网关角色。 可能会随着时间的推移添加其他网关角色。
GatewayRoleAssignment	主体的网关角色分配。
GroupDetails	组特定详细信息。 当主体类型 Group时适用。
GroupType	组的类型。 可能会随着时间的推移添加其他组类型。
Principal	表示标识或Microsoft Entra 组。
PrincipalType	主体的类型。 可能会随着时间的推移添加其他主体类型。
ServicePrincipalDetails	服务主体特定详细信息。 当主体类型 ServicePrincipal时适用。
ServicePrincipalProfileDetails	服务主体配置文件详细信息。 当主体类型 ServicePrincipalProfile时适用。
UserDetails	用户主体特定详细信息。 当主体类型 User时适用。

AddGatewayRoleAssignmentRequest

Object

为主体添加网关角色分配请求。

名称	类型	说明
principal	Principal	主体。
role	GatewayRole	主体的网关角色。

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	与错误相关的资源详细信息。

GatewayRole

Enumeration

网关角色。 可能会随着时间的推移添加其他网关角色。

值	说明
Admin	启用网关的管理访问权限。
ConnectionCreator	启用网关的连接创建者访问权限。
ConnectionCreatorWithResharing	启用连接创建者并重新共享网关的访问权限。

GatewayRoleAssignment

Object

主体的网关角色分配。

名称	类型	说明
id	string uuid	网关角色分配的对象 ID。
principal	Principal	主体。
role	GatewayRole	主体的网关角色。

GroupDetails

Object

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

名称	类型	说明
groupType	GroupType	组的类型。 可能会随着时间的推移添加其他组类型。

GroupType

Enumeration

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

值	说明
DistributionList	主体是通讯组列表。
SecurityGroup	主体是安全组。
Unknown	主体组类型未知。

Principal

Object

表示标识或Microsoft Entra 组。

名称	类型	说明
displayName	string	主体的显示名称。
groupDetails	GroupDetails	组特定详细信息。 当主体类型 Group时适用。
id	string uuid	主体的 ID。
servicePrincipalDetails	ServicePrincipalDetails	服务主体特定详细信息。 当主体类型 ServicePrincipal时适用。
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	服务主体配置文件详细信息。 当主体类型 ServicePrincipalProfile时适用。
type	PrincipalType	主体的类型。 可能会随着时间的推移添加其他主体类型。
userDetails	UserDetails	用户主体特定详细信息。 当主体类型 User时适用。

PrincipalType

Enumeration

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

值	说明
Group	主体是安全组。
ServicePrincipal	主体是Microsoft Entra 服务主体。
ServicePrincipalProfile	主体是服务主体配置文件。
User	主体是Microsoft Entra 用户主体。

ServicePrincipalDetails

Object

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

名称	类型	说明
aadAppId	string uuid	服务主体的 Microsoft Entra AppId。

ServicePrincipalProfileDetails

Object

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

名称	类型	说明
parentPrincipal	Principal	服务主体配置文件的父主体。

UserDetails

Object

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

名称	类型	说明
userPrincipalName	string	用户主体名称。