Workspaces - Add Workspace Role Assignment

Tjänst:: Core

API-version:: v1

Lägger till en rolltilldelning för arbetsytan.
Information om hur du hämtar det huvudobjekt-ID som krävs för begärandetexten finns i Hitta användarobjektets ID.

Behörigheter

Anroparen måste ha rollen medlem eller högre arbetsyta.
Medlemmar kan lägga till medlemmar eller andra med lägre behörigheter. Mer information finns i: arbetsyteroller.

Obligatoriska delegerade omfång

Arbetsutrymme.LäsSkriv.Allt

Begränsningar

Varje arbetsyta är begränsad till högst 1 000 användare eller grupper i arbetsyteroller (administratör, medlem, deltagare, visningsprogram). Antalet användare i en grupp är inte begränsat. Begränsningen omfattar även externa gäster.

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet	Stöd
Användare	Ja
Tjänsthuvudnamn och hanterade identiteter	Ja

Gränssnitt

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
workspaceId	path	True	string (uuid)	Arbetsyte-ID.

Begärandetext

Name	Obligatorisk	Typ	Description
principal	True	Principal: UserPrincipal ServicePrincipalPrincipal GroupPrincipal ServicePrincipalProfilePrincipal EntireTenantPrincipal	Huvudmannen.
role	True	WorkspaceRole	Huvudnamnets arbetsyteroll.

Svar

Name Typ Description

201 Created

Name	Typ	Description
201 Created	WorkspaceRoleAssignment	Har skapats. Sidhuvuden Location: string
429 Too Many Requests	ErrorResponse	Gränsen för tjänstfrekvens överskreds. Servern returnerar ett `Retry-After` huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas. Sidhuvuden Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: UnknownError – Ett fel uppstod.

WorkspaceRoleAssignment

Har skapats.

Sidhuvuden

Location: string

429 Too Many Requests

ErrorResponse

Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas.

Sidhuvuden

Retry-After: integer

Other Status Codes

ErrorResponse

Vanliga felkoder:

UnknownError – Ett fel uppstod.

Exempel

Add workspace role assignment example

Exempelbegäran

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

Exempelsvar

Statuskod:: 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

Name	Description
AddWorkspaceRoleAssignmentRequest	Lägg till nyttolasten för rolltilldelning för arbetsytor.
EntireTenantPrincipal	Representerar ett klientorganisationsobjekt
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
GroupDetails	Gruppera specifik information. Gäller när huvudtypen är `Group`.
GroupPrincipal	Representerar en säkerhetsgrupp.
GroupType	Gruppens typ. Ytterligare grupptyper kan läggas till över tid.
PrincipalType	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.
ServicePrincipalDetails	Specifik information om tjänstens huvudnamn. Gäller när huvudtypen är `ServicePrincipal`.
ServicePrincipalPrincipal	Representerar tjänstens huvudnamn för Microsoft Entra.
ServicePrincipalProfileDetails	Profilinformation för tjänstens huvudnamn. Gäller när huvudtypen är `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Representerar en profil för tjänstens huvudnamn.
UserDetails	Specifik information om användarens huvudnamn. Gäller när huvudtypen är `User`.
UserPrincipal	Representerar ett Microsoft Entra-användarhuvudnamn.
WorkspaceRole	En arbetsyteroll. Ytterligare arbetsyteroller kan läggas till över tid.
WorkspaceRoleAssignment	Ett rolltilldelningsobjekt för arbetsytan.

AddWorkspaceRoleAssignmentRequest

Objekt

Lägg till nyttolasten för rolltilldelning för arbetsytor.

Name	Typ	Description
principal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Huvudmannen.
role	WorkspaceRole	Huvudnamnets arbetsyteroll.

EntireTenantPrincipal

Objekt

Representerar ett klientorganisationsobjekt

Name	Typ	Description
displayName	string	Huvudkontots visningsnamn.
id	string (uuid)	Huvudmannens ID.
type	string: EntireTenant	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Det resurs-ID som ingår i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
isRetriable	boolean	När det är sant kan begäran göras på nytt. Använd svarshuvudet `Retry-After` för att fastställa fördröjningen, om den är tillgänglig.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string (uuid)	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.

GroupDetails

Objekt

Gruppera specifik information. Gäller när huvudtypen är Group.

Name	Typ	Description
groupType	GroupType	Gruppens typ. Ytterligare grupptyper kan läggas till över tid.

GroupPrincipal

Objekt

Representerar en säkerhetsgrupp.

Name	Typ	Description
displayName	string	Huvudkontots visningsnamn.
groupDetails	GroupDetails	Gruppera specifik information. Gäller när huvudtypen är `Group`.
id	string (uuid)	Huvudmannens ID.
type	string: Group	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

GroupType

Uppräkning

Gruppens typ. Ytterligare grupptyper kan läggas till över tid.

Värde	Description
Unknown	Huvudgrupptypen är okänd.
SecurityGroup	Huvudnamn är en säkerhetsgrupp.
DistributionList	Huvudnamn är en distributionslista.

PrincipalType

Uppräkning

Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

Värde	Description
User	Principal är ett Microsoft Entra-användarhuvudnamn.
ServicePrincipal	Principal är microsoft entra-tjänstens huvudnamn.
Group	Huvudnamn är en säkerhetsgrupp.
ServicePrincipalProfile	Huvudnamn är en profil för tjänstens huvudnamn.
EntireTenant	Huvudkontot representerar alla klientanvändare.

ServicePrincipalDetails

Objekt

Specifik information om tjänstens huvudnamn. Gäller när huvudtypen är ServicePrincipal.

Name	Typ	Description
aadAppId	string (uuid)	Tjänstens huvudnamns Microsoft Entra AppId.

ServicePrincipalPrincipal

Objekt

Representerar tjänstens huvudnamn för Microsoft Entra.

Name	Typ	Description
displayName	string	Huvudkontots visningsnamn.
id	string (uuid)	Huvudmannens ID.
servicePrincipalDetails	ServicePrincipalDetails	Specifik information om tjänstens huvudnamn. Gäller när huvudtypen är `ServicePrincipal`.
type	string: ServicePrincipal	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

ServicePrincipalProfileDetails

Objekt

Profilinformation för tjänstens huvudnamn. Gäller när huvudtypen är ServicePrincipalProfile.

Name	Typ	Description
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Tjänstens huvudnamnsprofils överordnade huvudnamn.

ServicePrincipalProfilePrincipal

Objekt

Representerar en profil för tjänstens huvudnamn.

Name	Typ	Description
displayName	string	Huvudkontots visningsnamn.
id	string (uuid)	Huvudmannens ID.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Profilinformation för tjänstens huvudnamn. Gäller när huvudtypen är `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

UserDetails

Objekt

Specifik information om användarens huvudnamn. Gäller när huvudtypen är User.

Name	Typ	Description
userPrincipalName	string	Användarens huvudnamn.

UserPrincipal

Objekt

Representerar ett Microsoft Entra-användarhuvudnamn.

Name	Typ	Description
displayName	string	Huvudkontots visningsnamn.
id	string (uuid)	Huvudmannens ID.
type	string: User	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.
userDetails	UserDetails	Specifik information om användarens huvudnamn. Gäller när huvudtypen är `User`.

WorkspaceRole

Uppräkning

En arbetsyteroll. Ytterligare arbetsyteroller kan läggas till över tid.

Värde	Description
Admin	Ger administrativ åtkomst till arbetsytan.
Member	Aktiverar medlemskapsåtkomst till arbetsytan.
Contributor	Aktiverar bidrag till arbetsytan.
Viewer	Aktiverar visning av arbetsytan.

WorkspaceRoleAssignment

Objekt

Ett rolltilldelningsobjekt för arbetsytan.

Name	Typ	Description
id	string (uuid)	Rolltilldelnings-ID för arbetsytan.
principal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Huvudmannen.
role	WorkspaceRole	Huvudnamnets arbetsyteroll.