Workspaces - Add Workspace Role Assignment

Serviço:: Core

Versão da API:: v1

Adiciona uma atribuição de função de workspace.
Para obter a ID do objeto de usuário principal necessária para o corpo da solicitação, consulte Localizar a ID do objeto de usuário.

Permissões

O chamador deve ter função de workspace membro ou superior.
Os membros podem adicionar membros ou outras pessoas com permissões inferiores. Para obter mais informações, consulte: funções de workspace.

Escopos delegados necessários

Workspace.ReadWrite.All

Limitações

Cada workspace é limitado a um máximo de 1.000 usuários ou grupos em funções de workspace (Administrador, Membro, Colaborador, Visualizador). O número de usuários em um grupo não é limitado. A limitação também abrange convidados externos.

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identidade	Apoio
Utilizador	Yes
Entidade de serviço e identidades gerenciadas	Yes

Interfase

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
workspaceId	path	True	string (uuid)	O identificador do espaço de trabalho.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
principal	True	Principal	A entidade de segurança.
role	True	WorkspaceRole	A função de workspace da entidade de segurança.

Respostas

Nome	Tipo	Description
201 Created	WorkspaceRoleAssignment	Criado com êxito. Cabeçalhos Location: string
Other Status Codes	ErrorResponse	Códigos de erro comuns: UnknownError – Ocorreu um erro.

Nome

Tipo

Description

201 Created

WorkspaceRoleAssignment

Criado com êxito.

Cabeçalhos

Location: string

Other Status Codes

ErrorResponse

Códigos de erro comuns:

UnknownError – Ocorreu um erro.

Exemplos

Add workspace role assignment example

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
}

Definições

Nome	Description
AddWorkspaceRoleAssignmentRequest	Adicione o conteúdo da solicitação de atribuição de função do workspace.
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
GroupDetails	Detalhes específicos do grupo. Aplicável quando o tipo principal é `Group`.
GroupType	O tipo do grupo. Tipos de grupo adicionais podem ser adicionados ao longo do tempo.
Principal	Representa uma identidade ou um grupo do Microsoft Entra.
PrincipalType	O tipo da entidade de segurança. Tipos de entidades de segurança adicionais podem ser adicionados ao longo do tempo.
ServicePrincipalDetails	Detalhes específicos da entidade de serviço. Aplicável quando o tipo principal é `ServicePrincipal`.
ServicePrincipalProfileDetails	Detalhes do perfil da entidade de serviço. Aplicável quando o tipo principal é `ServicePrincipalProfile`.
UserDetails	Detalhes específicos da entidade de usuário. Aplicável quando o tipo principal é `User`.
WorkspaceRole	Uma função de workspace. Funções de workspace adicionais podem ser adicionadas ao longo do tempo.
WorkspaceRoleAssignment	Um objeto de atribuição de função de workspace.

AddWorkspaceRoleAssignmentRequest

Objeto

Adicione o conteúdo da solicitação de atribuição de função do workspace.

Nome	Tipo	Description
principal	Principal	A entidade de segurança.
role	WorkspaceRole	A função de workspace da entidade de segurança.

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome	Tipo	Description
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.
requestId	string	ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.

GroupDetails

Objeto

Detalhes específicos do grupo. Aplicável quando o tipo principal é Group.

Nome	Tipo	Description
groupType	GroupType	O tipo do grupo. Tipos de grupo adicionais podem ser adicionados ao longo do tempo.

GroupType

Enumeração

O tipo do grupo. Tipos de grupo adicionais podem ser adicionados ao longo do tempo.

Valor	Description
Unknown	O tipo de grupo principal é desconhecido.
SecurityGroup	A entidade de segurança é um grupo de segurança.
DistributionList	Principal é uma lista de distribuição.

Principal

Objeto

Representa uma identidade ou um grupo do Microsoft Entra.

Nome	Tipo	Description
displayName	string	O nome de exibição da entidade de segurança.
groupDetails	GroupDetails	Detalhes específicos do grupo. Aplicável quando o tipo principal é `Group`.
id	string (uuid)	A ID da entidade de segurança.
servicePrincipalDetails	ServicePrincipalDetails	Detalhes específicos da entidade de serviço. Aplicável quando o tipo principal é `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Detalhes do perfil da entidade de serviço. Aplicável quando o tipo principal é `ServicePrincipalProfile`.
type	PrincipalType	O tipo da entidade de segurança. Tipos de entidades de segurança adicionais podem ser adicionados ao longo do tempo.
userDetails	UserDetails	Detalhes específicos da entidade de usuário. Aplicável quando o tipo principal é `User`.

PrincipalType

Enumeração

O tipo da entidade de segurança. Tipos de entidades de segurança adicionais podem ser adicionados ao longo do tempo.

Valor	Description
User	Principal é uma entidade de usuário do Microsoft Entra.
ServicePrincipal	A entidade de segurança é uma entidade de serviço do Microsoft Entra.
Group	A entidade de segurança é um grupo de segurança.
ServicePrincipalProfile	Principal é um perfil de entidade de serviço.
EntireTenant	A entidade de segurança representa todos os usuários do locatário.

ServicePrincipalDetails

Objeto

Detalhes específicos da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipal.

Nome	Tipo	Description
aadAppId	string (uuid)	O Microsoft Entra AppId da entidade de serviço.

ServicePrincipalProfileDetails

Objeto

Detalhes do perfil da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipalProfile.

Nome	Tipo	Description
parentPrincipal	Principal	A entidade pai do perfil da entidade de serviço.

UserDetails

Objeto

Detalhes específicos da entidade de usuário. Aplicável quando o tipo principal é User.

Nome	Tipo	Description
userPrincipalName	string	Nome principal do usuário.

WorkspaceRole

Enumeração

Uma função de workspace. Funções de workspace adicionais podem ser adicionadas ao longo do tempo.

Valor	Description
Admin	Habilita o acesso administrativo ao workspace.
Member	Habilita o acesso de associação ao workspace.
Contributor	Habilita a contribuição para o workspace.
Viewer	Habilita a exibição do workspace.

WorkspaceRoleAssignment

Objeto

Um objeto de atribuição de função de workspace.

Nome	Tipo	Description
id	string (uuid)	A ID da atribuição de função do workspace.
principal	Principal	A entidade de segurança.
role	WorkspaceRole	A função de workspace da entidade de segurança.

Compartilhar via

Workspaces - Add Workspace Role Assignment

Permissões

Escopos delegados necessários

Limitações

Identidades com suporte do Microsoft Entra

Interfase

Parâmetros de URI

Corpo da solicitação

Respostas

Exemplos

Add workspace role assignment example

Solicitação de exemplo

Resposta de exemplo

Definições

AddWorkspaceRoleAssignmentRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails

WorkspaceRole

WorkspaceRoleAssignment