Partilhar via

Workspaces - Add Workspace Role Assignment

Serviço:
Core
Versão da API:
v1

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

Permissões

  • O chamador deve ter a função de membro ou de espaço de trabalho superior.
  • Os membros podem adicionar membros ou outras pessoas com permissões mais baixas. Para obter mais informações, consulte: funções do espaço de trabalho.

Escopos delegados necessários

Workspace.ReadWrite.All

Limitações

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

Identidades suportadas pelo Entra da Microsoft

Esta API suporta as identidades do Microsoft listadas nesta secção.

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

Interfaz

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

Parâmetros do URI

Name Em Necessário Tipo Description
workspaceId
 path True

string (uuid)

O ID do espaço de trabalho.

Corpo do Pedido

Name Necessário Tipo Description
principal True

Principal

O principal.
role True

WorkspaceRole

A função de espaço de trabalho da entidade de segurança.

Respostas

Name Tipo Description
201 Created

WorkspaceRoleAssignment

Criado com sucesso.

Cabeçalhos

Location: string
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • UnknownError - Ocorreu um erro.

Exemplos

Add workspace role assignment example

Pedido de amostra

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 da amostra

Código de estado:
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

Name Description
AddWorkspaceRoleAssignmentRequest

Adicionar carga útil de solicitação de atribuição de função de espaço de trabalho.
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 do principal. Ao longo do tempo, podem ser acrescentados tipos principais adicionais.
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 principais do usuário. Aplicável quando o tipo principal é User.
WorkspaceRole

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

Um objeto de atribuição de função de espaço de trabalho.

AddWorkspaceRoleAssignmentRequest

Object

Adicionar carga útil de solicitação de atribuição de função de espaço de trabalho.

Name Tipo Description
principal

Principal

O principal.
role

WorkspaceRole

A função de espaço de trabalho da entidade de segurança.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.
requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.

GroupDetails

Object

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

Name 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

Principal é um grupo de segurança.
DistributionList

Principal é uma lista de distribuição.

Principal

Object

Representa uma identidade ou um grupo do Microsoft Entra.

Name 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)

O 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 do principal. Ao longo do tempo, podem ser acrescentados tipos principais adicionais.
userDetails

UserDetails

Detalhes específicos principais do usuário. Aplicável quando o tipo principal é User.

PrincipalType

Enumeração

O tipo do principal. Ao longo do tempo, podem ser acrescentados tipos principais adicionais.

Valor Description
User

Principal é uma entidade de usuário do Microsoft Entra.
ServicePrincipal

Principal é uma entidade de serviço do Microsoft Entra.
Group

Principal é um grupo de segurança.
ServicePrincipalProfile

Principal é um perfil de entidade de serviço.
EntireTenant

Principal representa todos os usuários locatários.

ServicePrincipalDetails

Object

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

Name Tipo Description
aadAppId

string (uuid)

O Microsoft Entra AppId da entidade de serviço.

ServicePrincipalProfileDetails

Object

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

Name Tipo Description
parentPrincipal

Principal

A entidade principal do perfil da entidade de serviço.

UserDetails

Object

Detalhes específicos principais do usuário. Aplicável quando o tipo principal é User.

Name Tipo Description
userPrincipalName

string

O nome principal do usuário.

WorkspaceRole

Enumeração

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

Valor Description
Admin

Permite o acesso administrativo ao espaço de trabalho.
Member

Permite o acesso da associação ao espaço de trabalho.
Contributor

Permite a contribuição para o espaço de trabalho.
Viewer

Permite a visualização do espaço de trabalho.

WorkspaceRoleAssignment

Object

Um objeto de atribuição de função de espaço de trabalho.

Name Tipo Description
id

string (uuid)

A ID de atribuição da função do espaço de trabalho.
principal

Principal

O principal.
role

WorkspaceRole

A função de espaço de trabalho da entidade de segurança.