Workspaces - Add Workspace Role Assignment

Служба:: Core

Версия API:: v1

Добавляет назначение роли рабочей области.
Чтобы получить идентификатор основного объекта пользователя, необходимый для текста запроса, см. раздел "Поиск идентификатора объекта пользователя".

Разрешения

Вызывающий объект должен иметь роль участника или более поздней рабочей области.
Участники могут добавлять участников или других пользователей с более низкими разрешениями. Дополнительные сведения см. в статье "Роли рабочей области".

Обязательные делегированные области

Workspace.ReadWrite.All

Идентификаторы, поддерживаемые Microsoft Entra

Этот API поддерживает идентичности Microsoft, перечисленные в этом разделе.

Идентичность	Поддержка
Пользователь	Да
Представитель службы и управляемые удостоверения	Да

Интерфейс

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
workspaceId	path	True	string (uuid)	Идентификатор рабочей области.

Текст запроса

Имя	Обязательно	Тип	Описание
principal	True	Principal	Субъект.
role	True	WorkspaceRole	Роль рабочей области субъекта.

Ответы

Имя	Тип	Описание
201 Created	WorkspaceRoleAssignment	Успешно создано. Заголовки Location: string
Other Status Codes	ErrorResponse	Распространенные коды ошибок: UnknownError — произошла ошибка.

Имя

Тип

Описание

201 Created

WorkspaceRoleAssignment

Успешно создано.

Заголовки

Location: string

Other Status Codes

ErrorResponse

Распространенные коды ошибок:

UnknownError — произошла ошибка.

Примеры

Add workspace role assignment example

Образец запроса

HTTP

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"
}

Пример ответа

Код состояния:: 201

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

Object

Добавьте полезные данные запроса на назначение ролей рабочей области.

Имя	Тип	Описание
principal	Principal	Субъект.
role	WorkspaceRole	Роль рабочей области субъекта.

ErrorRelatedResource

Object

Объект сведений об ошибках, связанных с ресурсом.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Object

Ответ на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
moreDetails	ErrorResponseDetails[]	Список дополнительных сведений об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.
requestId	string	Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Object

Сведения об ответе на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.

GroupDetails

Object

Группировка конкретных сведений. Применимо, если тип субъекта Group.

Имя	Тип	Описание
groupType	GroupType	Тип группы. С течением времени могут добавляться дополнительные типы групп.

GroupType

Перечисление

Тип группы. С течением времени могут добавляться дополнительные типы групп.

Значение	Описание
Unknown	Тип основной группы неизвестен.
SecurityGroup	Субъект — это группа безопасности.
DistributionList	Субъект — это список рассылки.

Principal

Object

Представляет удостоверение или группу Microsoft Entra.

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта.
groupDetails	GroupDetails	Группировка конкретных сведений. Применимо, если тип субъекта `Group`.
id	string (uuid)	Идентификатор субъекта.
servicePrincipalDetails	ServicePrincipalDetails	Сведения о субъекте-службе. Применимо, если тип субъекта `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Сведения о профиле субъекта-службы. Применимо, если тип субъекта `ServicePrincipalProfile`.
type	PrincipalType	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.
userDetails	UserDetails	Сведения о субъекте-пользователе. Применимо, если тип субъекта `User`.

PrincipalType

Перечисление

Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.

Значение	Описание
User	Субъект является субъектом-пользователем Microsoft Entra.
ServicePrincipal	Субъект является субъектом-службой Microsoft Entra.
Group	Субъект — это группа безопасности.
ServicePrincipalProfile	Субъект — это профиль субъекта-службы.

ServicePrincipalDetails

Object

Сведения о субъекте-службе. Применимо, если тип субъекта ServicePrincipal.

Имя	Тип	Описание
aadAppId	string (uuid)	Microsoft Entra AppId субъекта-службы.

ServicePrincipalProfileDetails

Object

Сведения о профиле субъекта-службы. Применимо, если тип субъекта ServicePrincipalProfile.

Имя	Тип	Описание
parentPrincipal	Principal	Родительский субъект профиля субъекта-службы.

UserDetails

Object

Сведения о субъекте-пользователе. Применимо, если тип субъекта User.

Имя	Тип	Описание
userPrincipalName	string	Основное имя пользователя.

WorkspaceRole

Перечисление

Роль рабочей области. С течением времени могут добавляться дополнительные роли рабочей области.

Значение	Описание
Admin	Включает административный доступ к рабочей области.
Member	Включает доступ к рабочей области для членства.
Contributor	Включает вклад в рабочую область.
Viewer	Включает просмотр рабочей области.

WorkspaceRoleAssignment

Object

Объект назначения роли рабочей области.

Имя	Тип	Описание
id	string (uuid)	Идентификатор назначения роли рабочей области.
principal	Principal	Субъект.
role	WorkspaceRole	Роль рабочей области субъекта.

Поделиться через

Workspaces - Add Workspace Role Assignment

Разрешения

Обязательные делегированные области

Идентификаторы, поддерживаемые Microsoft Entra

Интерфейс

Параметры URI

Текст запроса

Ответы

Примеры

Add workspace role assignment example

Образец запроса

Пример ответа

Определения

AddWorkspaceRoleAssignmentRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails

WorkspaceRole

WorkspaceRoleAssignment