Role Assignments - List Role Assignments

服务:

Synapse

API 版本:

2020-12-01

列出角色分配。

GET {endpoint}/roleAssignments?api-version=2020-12-01

具有可选参数:

GET {endpoint}/roleAssignments?api-version=2020-12-01&roleId={roleId}&principalId={principalId}&scope={scope}

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string	工作区开发终结点，例如 https://myworkspace.dev.azuresynapse.net。
api-version	query	True	string	Synapse 客户端 API 版本。
principalId	query		string	AAD 主体或安全组的对象 ID。
roleId	query		string	Synapse Built-In 角色 ID。
scope	query		string	Synapse 内置角色的范围。

请求头

名称	必需	类型	说明
x-ms-continuation		string	继续标记。

响应

名称	类型	说明
200 OK	RoleAssignmentDetailsList	成功响应。 Media Types: "application/json", "text/json" 标头 x-ms-continuation: string
Other Status Codes	ErrorContract	描述作失败的原因的错误响应。 Media Types: "application/json", "text/json"

示例

List role assignments

示例请求

HTTP

GET exampleWorkspace.dev.azuresynapse.net/roleAssignments?api-version=2020-12-01&roleId=00000000-0000-0000-0000-000000000000&principalId=00000000-0000-0000-0000-000000000000&scope=workspaces/exampleWorkspace

示例响应

状态代码:

200

{
  "count": 2,
  "value": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "roleDefinitionId": "00000000-0000-0000-0000-000000000000",
      "principalId": "00000000-0000-0000-0000-000000000000",
      "scope": "workspaces/exampleWorkspace",
      "principalType": "User || Group || ServicePrincipal"
    },
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "roleDefinitionId": "00000000-0000-0000-0000-000000000000",
      "principalId": "00000000-0000-0000-0000-000000000000",
      "scope": "workspaces/exampleWorkspace",
      "principalType": "User || Group || ServicePrincipal"
    }
  ]
}

状态代码:

default

{
  "error": {
    "code": "Error code",
    "message": "Error message"
  }
}

定义

名称	说明
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorContract	错误详细信息。
ErrorResponse	错误响应
RoleAssignmentDetails	角色分配响应详细信息
RoleAssignmentDetailsList	角色分配响应详细信息

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorContract

Object

错误详细信息。

名称	类型	说明
error	ErrorResponse	错误响应 错误详细信息。

ErrorResponse

Object

错误响应

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorResponse[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

RoleAssignmentDetails

Object

角色分配响应详细信息

名称	类型	说明
id	string	角色分配 ID
principalId	string (uuid)	AAD 主体或安全组的对象 ID
principalType	string	主体 ID 的类型：用户、组或 ServicePrincipal
roleDefinitionId	string (uuid)	Synapse Built-In 角色的角色 ID
scope	string	创建角色分配的范围

RoleAssignmentDetailsList

Object

角色分配响应详细信息

名称	类型	说明
count	integer	角色分配数
value	RoleAssignmentDetails[]	角色分配列表