Connections - Add Connection Role Assignment

Tjeneste:: Admin

API-version:: v1

Tilføjer en tildeling af forbindelsesrolle.

Notat

Fabric administration af lejeradministrationsforbindelse findes i øjeblikket som prøveversion (få mere at vide).

Permissions

Den, der ringer op, skal være Fabric-administrator eller godkende ved hjælp af en tjenesteprincipal.

Påkrævede delegerede områder

Tenant.ReadWrite.All

Begrænsninger

Ingen yderligere begrænsninger.

Microsoft Entra understøttede identiteter

Denne API understøtter de Microsoft identities, der er angivet i dette afsnit.

Identity	Support
User	Ja
tjenesteprincipal og administrerede identiteter	Ja

Interface

POST https://api.fabric.microsoft.com/v1/admin/connections/{connectionId}/roleAssignments

URI-parametre

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

Brødtekst for anmodning

Navn	Påkrævet	Type	Beskrivelse
principal	True	Principal: UserPrincipal ServicePrincipalPrincipal GroupPrincipal ServicePrincipalProfilePrincipal EntireTenantPrincipal	Hovedstolen. Gruppeprincipaltypen understøttes ikke.
role	True	AssignableAdminConnectionRole	Forbindelsesrollen for hovedstolen.

Svar

Navn Type Beskrivelse

201 Created

Navn	Type	Beskrivelse
201 Created	ConnectionRoleAssignment	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: UnsupportedPrincipalType – Gruppens hovedtype understøttes ikke for denne handling. InvalidInput – Der mangler en påkrævet parameter.

ConnectionRoleAssignment

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:

UnsupportedPrincipalType – Gruppens hovedtype understøttes ikke for denne handling.
InvalidInput – Der mangler en påkrævet parameter.

Eksempler

Add connection role assignment as admin example

Eksempelanmodning

HTTP

POST https://api.fabric.microsoft.com/v1/admin/connections/f3a2e6af-d048-4f85-94d9-b3d16140df05/roleAssignments

{
  "principal": {
    "id": "6a002b3d-e4ec-43df-8c08-e8eb7547d9dd",
    "type": "User"
  },
  "role": "Owner"
}

Eksempelsvar

Statuskode:: 201

Location: https://api.fabric.microsoft.com/v1/admin/connections/f3a2e6af-d048-4f85-94d9-b3d16140df05/roleAssignments/6a002b3d-e4ec-43df-8c08-e8eb7547d9dd

{
  "id": "6a002b3d-e4ec-43df-8c08-e8eb7547d9dd",
  "principal": {
    "id": "6a002b3d-e4ec-43df-8c08-e8eb7547d9dd",
    "type": "User"
  },
  "role": "Owner"
}

Definitioner

Navn	Beskrivelse
AddAdminConnectionRoleAssignmentRequest	Anmodningen om tildeling af forbindelsesrolle for en hovedkonto.
AssignableAdminConnectionRole	En forbindelsesrolle. Der kan tilføjes flere forbindelsesroller over tid.
ConnectionRole	En forbindelsesrolle. Der kan tilføjes flere forbindelsesroller over tid.
ConnectionRoleAssignment	Forbindelsesrolletildelingen for en hovedkonto.
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.

AddAdminConnectionRoleAssignmentRequest

Objekt

Anmodningen om tildeling af forbindelsesrolle for en hovedkonto.

Navn	Type	Beskrivelse
principal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Hovedstolen. Gruppeprincipaltypen understøttes ikke.
role	AssignableAdminConnectionRole	Forbindelsesrollen for hovedstolen.

AssignableAdminConnectionRole

Optælling

En forbindelsesrolle. Der kan tilføjes flere forbindelsesroller over tid.

Værdi	Beskrivelse
Owner	Gør det muligt for hovedprincipalen at få ejerskab over forbindelsen. Hovedprincipalen er oprindeligt tildelt rollen 'PendingOwner' og for at fuldføre overgangen til 'Owner', skal hovedprincipalen opdatere legitimationsoplysningerne for forbindelsen ved hjælp af Update Connection API.

ConnectionRole

Optælling

En forbindelsesrolle. Der kan tilføjes flere forbindelsesroller over tid.

Værdi	Beskrivelse
User	Giver brugeren adgang til forbindelsen.
UserWithReshare	Giver brugeren mulighed for at videredelingsadgangen for forbindelsen.
Owner	Aktiverer ejerskabsadgang for forbindelsen.
PendingOwner	Ejerskabet af forbindelsen er endnu ikke effektivt. hovedprincipalen skal opdatere legitimationsoplysningerne for forbindelsen (ved hjælp af Api til opdateringsforbindelse) for at gøre den gældende.

ConnectionRoleAssignment

Objekt

Forbindelsesrolletildelingen for en hovedkonto.

Navn	Type	Beskrivelse
id	string (uuid)	Objekt-id'et for forbindelsesrolletildelingen.
principal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Hovedstolen.
role	ConnectionRole	Forbindelsesrollen 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`.