Connections - Update Connection Role Assignment

Tjeneste:
Admin
API-versjon:
v1

Oppdaterer hovedstolens rolletilordning for tilkoblingen.

Note

Fabric administrasjon av leieradministratortilkobling er for øyeblikket i forhåndsvisning (finn ut mer).

Permissions

Innringeren må være en Fabric-administrator eller godkjenne ved hjelp av en tjenestekontohaver.

Nødvendige delegerte omfang

Tenant.ReadWrite.All

Begrensninger

Ingen flere begrensninger.

Microsoft Entra støttede identiteter

Denne API-en støtter Microsoft identiteter oppført i denne delen.

Identity Støtte
Bruker Ja
tjenestekontohaver og administrerte identiteter Ja

Interface

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

URI-parametere

Name I Obligatorisk Type Beskrivelse
connectionId
 path True

string (uuid)

Tilkoblings-ID-en.
connectionRoleAssignmentId
 path True

string (uuid)

ID-en for tilkoblingsrolletilordningen.

Brødtekst for forespørsel

Name Obligatorisk Type Beskrivelse
role True

AssignableAdminConnectionRole

Tilkoblingsrollen til hovedstolen.

Svar

Name Type Beskrivelse
200 OK

ConnectionRoleAssignment

OK. Operasjonen var vellykket.
429 Too Many Requests

ErrorResponse

Grensen for tjenestesats ble overskredet. Serveren returnerer en Retry-After topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler.

Overskrifter

Retry-After: integer
Other Status Codes

ErrorResponse

Vanlige feilkoder:

  • UnknownError - Det oppstod en feil.

Eksempler

Update connection role assignment as admin example

Eksempelforespørsel

PATCH https://api.fabric.microsoft.com/v1/admin/connections/fe8e181d-dbb8-471a-99f0-fdbf0a2ad4fd/roleAssignments/43970761-afc9-4428-ae6e-3b08bef098ff

{
  "role": "Owner"
}

Eksempelsvar

Statuskode:
200 
{
  "id": "43970761-afc9-4428-ae6e-3b08bef098ff",
  "principal": {
    "id": "43970761-afc9-4428-ae6e-3b08bef098ff",
    "type": "User"
  },
  "role": "Owner"
}

Definisjoner

Name Beskrivelse
AssignableAdminConnectionRole

En tilkoblingsrolle. Flere tilkoblingsroller kan legges til over tid.
ConnectionRole

En tilkoblingsrolle. Flere tilkoblingsroller kan legges til over tid.
ConnectionRoleAssignment

Tilkoblingsrolletilordningen for en hovedstol.
EntireTenantPrincipal

Representerer en leierkontohaver
ErrorParameter

En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.
ErrorRelatedResource

Objektet for feilrelaterte ressursdetaljer.
ErrorResponse

Feilsvaret.
ErrorResponseDetails

Feilsvardetaljene.
GroupDetails

Grupper bestemte detaljer. Gjelder når hovedtypen er Group.
GroupPrincipal

Representerer en sikkerhetsgruppe.
GroupType

Typen gruppe. Flere gruppetyper kan legges til over tid.
PrincipalType

Typen hovedstol. Flere hovedstoltyper kan legges til over tid.
ServicePrincipalDetails

Spesifikke detaljer for tjenestekontohaver. Gjelder når hovedtypen er ServicePrincipal.
ServicePrincipalPrincipal

Representerer en Microsoft Entra tjenestekontohaver.
ServicePrincipalProfileDetails

Detaljer for tjenestekontohaverprofil. Gjelder når hovedtypen er ServicePrincipalProfile.
ServicePrincipalProfilePrincipal

Representerer en tjenestekontohaverprofil.
UpdateAdminConnectionRoleAssignmentRequest

En nyttelast for tilordningsforespørsel for oppdateringstilkoblingsrolle.
UserDetails

Spesifikke detaljer for brukerkontohaver. Gjelder når hovedtypen er User.
UserPrincipal

Representerer en Microsoft Entra brukerkontohaver.

AssignableAdminConnectionRole

Opplisting

En tilkoblingsrolle. Flere tilkoblingsroller kan legges til over tid.

Verdi Beskrivelse
Owner

Gjør det mulig for hovedstolen å få eierskap til tilkoblingen. Hovedstolen tilordnes opprinnelig rollen Venter eier, og for å fullføre overgangen til Eier må hovedstolen oppdatere tilkoblingslegitimasjonen ved hjelp av API for oppdateringstilkobling.

ConnectionRole

Opplisting

En tilkoblingsrolle. Flere tilkoblingsroller kan legges til over tid.

Verdi Beskrivelse
User

Aktiverer brukertilgang for tilkoblingen.
UserWithReshare

Aktiverer bruker med deling av tilgang på nytt for tilkoblingen.
Owner

Aktiverer eierskapstilgang for tilkoblingen.
PendingOwner

Eierskapet til tilkoblingen er ennå ikke effektivt. hovedstolen må oppdatere tilkoblingslegitimasjonen (ved hjelp av API for oppdateringstilkobling) for å gjøre den effektiv.

ConnectionRoleAssignment

Objekt

Tilkoblingsrolletilordningen for en hovedstol.

Name Type Beskrivelse
id

string (uuid)

Objekt-ID-en for tilkoblingsrolletilordningen.
principal Principal:

Rektor.
role

ConnectionRole

Tilkoblingsrollen til hovedstolen.

EntireTenantPrincipal

Objekt

Representerer en leierkontohaver

Name Type Beskrivelse
displayName

string

Hovedkontohaverens visningsnavn.
id

string (uuid)

Hovedkontohaverens ID.
type string:

EntireTenant

Typen hovedstol. Flere hovedstoltyper kan legges til over tid.

ErrorParameter

Objekt

En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.

Name Type Beskrivelse
message

string

En lesbar beskrivelse av parameterens betydning.
name

string

Parameteridentifikatoren.
value

string

Parameterverdien.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Name Type Beskrivelse
resourceId

string

Ressurs-ID-en som er involvert i feilen.
resourceType

string

Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Name Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
isRetriable

boolean

Når sann, kan forespørselen prøves på nytt. Retry-After Bruk svarhodet til å fastslå forsinkelsen, hvis tilgjengelig.
message

string

En menneskelig lesbar representasjon av feilen.
moreDetails

ErrorResponseDetails[]

Liste over flere feildetaljer.
parameters

ErrorParameter[]

Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.
requestId

string (uuid)

ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Name Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message

string

En menneskelig lesbar representasjon av feilen.
parameters

ErrorParameter[]

Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.

GroupDetails

Objekt

Grupper bestemte detaljer. Gjelder når hovedtypen er Group.

Name Type Beskrivelse
groupType

GroupType

Typen gruppe. Flere gruppetyper kan legges til over tid.

GroupPrincipal

Objekt

Representerer en sikkerhetsgruppe.

Name Type Beskrivelse
displayName

string

Hovedkontohaverens visningsnavn.
groupDetails

GroupDetails

Grupper bestemte detaljer. Gjelder når hovedtypen er Group.
id

string (uuid)

Hovedkontohaverens ID.
type string:

Group

Typen hovedstol. Flere hovedstoltyper kan legges til over tid.

GroupType

Opplisting

Typen gruppe. Flere gruppetyper kan legges til over tid.

Verdi Beskrivelse
Unknown

Hovedgruppetypen er ukjent.
SecurityGroup

Hovedstol er en sikkerhetsgruppe.
DistributionList

Hovedstol er en distribusjonsliste.

PrincipalType

Opplisting

Typen hovedstol. Flere hovedstoltyper kan legges til over tid.

Verdi Beskrivelse
User

Hovedstol er en Microsoft Entra brukerkontohaver.
ServicePrincipal

Principal er en Microsoft Entra tjenestekontohaver.
Group

Hovedstol er en sikkerhetsgruppe.
ServicePrincipalProfile

Principal er en tjenestekontohaverprofil.
EntireTenant

Hovedstol representerer alle leierbrukere.

ServicePrincipalDetails

Objekt

Spesifikke detaljer for tjenestekontohaver. Gjelder når hovedtypen er ServicePrincipal.

Name Type Beskrivelse
aadAppId

string (uuid)

Tjenestekontohaverens Microsoft Entra AppId.

ServicePrincipalPrincipal

Objekt

Representerer en Microsoft Entra tjenestekontohaver.

Name Type Beskrivelse
displayName

string

Hovedkontohaverens visningsnavn.
id

string (uuid)

Hovedkontohaverens ID.
servicePrincipalDetails

ServicePrincipalDetails

Spesifikke detaljer for tjenestekontohaver. Gjelder når hovedtypen er ServicePrincipal.
type string:

ServicePrincipal

Typen hovedstol. Flere hovedstoltyper kan legges til over tid.

ServicePrincipalProfileDetails

Objekt

Detaljer for tjenestekontohaverprofil. Gjelder når hovedtypen er ServicePrincipalProfile.

Name Type Beskrivelse
parentPrincipal Principal:

Overordnet hovedkontohaver for tjenestekontohaverprofilen.

ServicePrincipalProfilePrincipal

Objekt

Representerer en tjenestekontohaverprofil.

Name Type Beskrivelse
displayName

string

Hovedkontohaverens visningsnavn.
id

string (uuid)

Hovedkontohaverens ID.
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Detaljer for tjenestekontohaverprofil. Gjelder når hovedtypen er ServicePrincipalProfile.
type string:

ServicePrincipalProfile

Typen hovedstol. Flere hovedstoltyper kan legges til over tid.

UpdateAdminConnectionRoleAssignmentRequest

Objekt

En nyttelast for tilordningsforespørsel for oppdateringstilkoblingsrolle.

Name Type Beskrivelse
role

AssignableAdminConnectionRole

Tilkoblingsrollen til hovedstolen.

UserDetails

Objekt

Spesifikke detaljer for brukerkontohaver. Gjelder når hovedtypen er User.

Name Type Beskrivelse
userPrincipalName

string

Brukerhovednavn.

UserPrincipal

Objekt

Representerer en Microsoft Entra brukerkontohaver.

Name Type Beskrivelse
displayName

string

Hovedkontohaverens visningsnavn.
id

string (uuid)

Hovedkontohaverens ID.
type string:

User

Typen hovedstol. Flere hovedstoltyper kan legges til over tid.
userDetails

UserDetails

Spesifikke detaljer for brukerkontohaver. Gjelder når hovedtypen er User.