Workspaces - Add Workspace Role Assignment

Tjeneste:: Core

API-version:: v1

Tilføjer en rolletildeling for arbejdsområdet.
Hvis du vil hente det primære brugerobjekt-id, der kræves til anmodningens brødtekst, skal du se Find brugerobjekt-id'et.

Tilladelser

Den, der ringer op, skal have rollen medlem eller et højere arbejdsområde.
Medlemmer kan tilføje medlemmer eller andre med lavere tilladelser. Du kan få flere oplysninger under: arbejdsområderoller.

Påkrævede delegerede områder

Workspace.ReadWrite.All

Begrænsninger

Hvert arbejdsområde er begrænset til maksimalt 1.000 brugere eller grupper i arbejdsområderoller (administrator, medlem, bidragyder, fremviser). Antallet af brugere i en gruppe er ikke begrænset. Begrænsningen dækker også eksterne gæster.

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Ja

Grænseflade

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

URI-parametre

Navn	I	Påkrævet	Type	Beskrivelse
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.

Brødtekst for anmodning

Navn	Påkrævet	Type	Beskrivelse
principal	True	Principal: UserPrincipal ServicePrincipalPrincipal GroupPrincipal ServicePrincipalProfilePrincipal EntireTenantPrincipal	Hovedstolen.
role	True	WorkspaceRole	Rollen for arbejdsområdet for hovedstolen.

Svar

Navn Type Beskrivelse

201 Created

Navn	Type	Beskrivelse
201 Created	WorkspaceRoleAssignment	Oprettet. Headere Location: string
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en `Retry-After` header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: UnknownError – Der opstod en fejl.

WorkspaceRoleAssignment

Oprettet.

Headere

Location: string

429 Too Many Requests

ErrorResponse

Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Retry-After header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger.

Headere

Retry-After: integer

Other Status Codes

ErrorResponse

Almindelige fejlkoder:

UnknownError – Der opstod en fejl.

Eksempler

Add workspace role assignment example

Eksempelanmodning

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

Eksempelsvar

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

Definitioner

Navn	Beskrivelse
AddWorkspaceRoleAssignmentRequest	Tilføj nyttedata for anmodning om rolletildeling i arbejdsområdet.
EntireTenantPrincipal	Repræsenterer en lejerprincipal
ErrorParameter	En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
GroupDetails	Gruppér specifikke oplysninger. Gælder, når hovedtypen er `Group`.
GroupPrincipal	Repræsenterer en sikkerhedsgruppe.
GroupType	Gruppens type. Der kan tilføjes flere gruppetyper over tid.
PrincipalType	Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.
ServicePrincipalDetails	Specifikke oplysninger om tjenesteprincipal. Gælder, når hovedtypen er `ServicePrincipal`.
ServicePrincipalPrincipal	Repræsenterer en Microsoft Entra-tjenesteprincipal.
ServicePrincipalProfileDetails	Profiloplysninger for tjenesteprincipal. Gælder, når hovedtypen er `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Repræsenterer en tjenesteprincipalprofil.
UserDetails	Specifikke oplysninger om brugerens hovedprincipal. Gælder, når hovedtypen er `User`.
UserPrincipal	Repræsenterer en Microsoft Entra-brugerprincipal.
WorkspaceRole	En arbejdsområderolle. Der kan tilføjes flere arbejdsområderoller over tid.
WorkspaceRoleAssignment	Et objekt til tildeling af arbejdsområderoller.

AddWorkspaceRoleAssignmentRequest

Objekt

Tilføj nyttedata for anmodning om rolletildeling i arbejdsområdet.

Navn	Type	Beskrivelse
principal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Hovedstolen.
role	WorkspaceRole	Rollen for arbejdsområdet for hovedstolen.

EntireTenantPrincipal

Objekt

Repræsenterer en lejerprincipal

Navn	Type	Beskrivelse
displayName	string	Hovedprincipalens viste navn.
id	string (uuid)	Hovedprincipalens id.
type	string: EntireTenant	Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.

ErrorParameter

Objekt

En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.

Navn	Type	Beskrivelse
message	string	En læsevenlig beskrivelse af parameterens betydning.
name	string	Parameter-id'et.
value	string	Parameterens værdi.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Navn	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Navn	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
isRetriable	boolean	Når sand, kan anmodningen prøves igen. Brug svarheaderen `Retry-After` til at bestemme forsinkelsen, hvis den er tilgængelig.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
parameters	ErrorParameter[]	Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Navn	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
parameters	ErrorParameter[]	Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

GroupDetails

Objekt

Gruppér specifikke oplysninger. Gælder, når hovedtypen er Group.

Navn	Type	Beskrivelse
groupType	GroupType	Gruppens type. Der kan tilføjes flere gruppetyper over tid.

GroupPrincipal

Objekt

Repræsenterer en sikkerhedsgruppe.

Navn	Type	Beskrivelse
displayName	string	Hovedprincipalens viste navn.
groupDetails	GroupDetails	Gruppér specifikke oplysninger. Gælder, når hovedtypen er `Group`.
id	string (uuid)	Hovedprincipalens id.
type	string: Group	Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.

GroupType

Optælling

Gruppens type. Der kan tilføjes flere gruppetyper over tid.

Værdi	Beskrivelse
Unknown	Hovedgruppetypen er ukendt.
SecurityGroup	Principal er en sikkerhedsgruppe.
DistributionList	Principal er en distributionsliste.

PrincipalType

Optælling

Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.

Værdi	Beskrivelse
User	Principal er en Microsoft Entra-brugerprincipal.
ServicePrincipal	Principal er en Microsoft Entra-tjenesteprincipal.
Group	Principal er en sikkerhedsgruppe.
ServicePrincipalProfile	Principal er en tjenesteprincipalprofil.
EntireTenant	Principal repræsenterer alle lejerbrugere.

ServicePrincipalDetails

Objekt

Specifikke oplysninger om tjenesteprincipal. Gælder, når hovedtypen er ServicePrincipal.

Navn	Type	Beskrivelse
aadAppId	string (uuid)	Tjenesteprincipalens Microsoft Entra AppId.

ServicePrincipalPrincipal

Objekt

Repræsenterer en Microsoft Entra-tjenesteprincipal.

Navn	Type	Beskrivelse
displayName	string	Hovedprincipalens viste navn.
id	string (uuid)	Hovedprincipalens id.
servicePrincipalDetails	ServicePrincipalDetails	Specifikke oplysninger om tjenesteprincipal. Gælder, når hovedtypen er `ServicePrincipal`.
type	string: ServicePrincipal	Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.

ServicePrincipalProfileDetails

Objekt

Profiloplysninger for tjenesteprincipal. Gælder, når hovedtypen er ServicePrincipalProfile.

Navn	Type	Beskrivelse
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Profilen for tjenesteprincipalens overordnede hoved.

ServicePrincipalProfilePrincipal

Objekt

Repræsenterer en tjenesteprincipalprofil.

Navn	Type	Beskrivelse
displayName	string	Hovedprincipalens viste navn.
id	string (uuid)	Hovedprincipalens id.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Profiloplysninger for tjenesteprincipal. Gælder, når hovedtypen er `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.

UserDetails

Objekt

Specifikke oplysninger om brugerens hovedprincipal. Gælder, når hovedtypen er User.

Navn	Type	Beskrivelse
userPrincipalName	string	Brugerens hovednavn.

UserPrincipal

Objekt

Repræsenterer en Microsoft Entra-brugerprincipal.

Navn	Type	Beskrivelse
displayName	string	Hovedprincipalens viste navn.
id	string (uuid)	Hovedprincipalens id.
type	string: User	Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.
userDetails	UserDetails	Specifikke oplysninger om brugerens hovedprincipal. Gælder, når hovedtypen er `User`.

WorkspaceRole

Optælling

En arbejdsområderolle. Der kan tilføjes flere arbejdsområderoller over tid.

Værdi	Beskrivelse
Admin	Giver administrativ adgang til arbejdsområdet.
Member	Giver adgang til arbejdsområdet for medlemskab.
Contributor	Aktiverer bidrag til arbejdsområdet.
Viewer	Aktiverer visning af arbejdsområdet.

WorkspaceRoleAssignment

Objekt

Et objekt til tildeling af arbejdsområderoller.

Navn	Type	Beskrivelse
id	string (uuid)	Tildelings-id'et for arbejdsområdets rolle.
principal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Hovedstolen.
role	WorkspaceRole	Rollen for arbejdsområdet for hovedstolen.