Connections - Update Connection Role Assignment

Service:
Admin
Versione API:
v1

Aggiorna l'assegnazione di ruolo dell'entità per la connessione.

Note

Fabric gestione delle connessioni dell'amministratore tenant è attualmente disponibile in anteprima (altre informazioni).

Permissions

Il chiamante deve essere un amministratore di Fabric o eseguire l'autenticazione usando un'entità servizio.

Ambiti delegati obbligatori

Tenant.ReadWrite.All

Limitations

Nessuna limitazione aggiuntiva.

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità Support
User Yes
Principale del servizio e Identità gestite Yes

Interface

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
connectionId
 path True

string (uuid)

ID connessione.
connectionRoleAssignmentId
 path True

string (uuid)

ID dell'assegnazione del ruolo di connessione.

Corpo della richiesta

Nome Necessario Tipo Descrizione
role True

AssignableAdminConnectionRole

Ruolo di connessione dell'entità.

Risposte

Nome Tipo Descrizione
200 OK

ConnectionRoleAssignment

OK. Operazione riuscita.
429 Too Many Requests

ErrorResponse

È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione Retry-After che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive.

Intestazioni

Retry-After: integer
Other Status Codes

ErrorResponse

Codici di errore comuni:

  • UnknownError: si è verificato un errore.

Esempio

Update connection role assignment as admin example

Esempio di richiesta

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

{
  "role": "Owner"
}

Risposta di esempio

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

Definizioni

Nome Descrizione
AssignableAdminConnectionRole

Ruolo di connessione. È possibile aggiungere altri ruoli di connessione nel tempo.
ConnectionRole

Ruolo di connessione. È possibile aggiungere altri ruoli di connessione nel tempo.
ConnectionRoleAssignment

Assegnazione di ruolo di connessione per un'entità.
EntireTenantPrincipal

Rappresenta un'entità tenant
ErrorParameter

Parametro strutturato che fornisce un contesto aggiuntivo leggibile dal computer relativo a un errore.
ErrorRelatedResource

Oggetto dei dettagli della risorsa relativo all'errore.
ErrorResponse

Risposta di errore.
ErrorResponseDetails

Dettagli della risposta di errore.
GroupDetails

Dettagli specifici del gruppo. Applicabile quando il tipo di entità è Group.
GroupPrincipal

Rappresenta un gruppo di sicurezza.
GroupType

Tipo del gruppo. È possibile aggiungere altri tipi di gruppo nel tempo.
PrincipalType

Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.
ServicePrincipalDetails

Dettagli specifici dell'entità servizio. Applicabile quando il tipo di entità è ServicePrincipal.
ServicePrincipalPrincipal

Rappresenta un'entità servizio Microsoft Entra.
ServicePrincipalProfileDetails

Dettagli del profilo dell'entità servizio. Applicabile quando il tipo di entità è ServicePrincipalProfile.
ServicePrincipalProfilePrincipal

Rappresenta un profilo dell'entità servizio.
UpdateAdminConnectionRoleAssignmentRequest

Payload della richiesta di assegnazione del ruolo di connessione di aggiornamento.
UserDetails

Dettagli specifici dell'entità utente. Applicabile quando il tipo di entità è User.
UserPrincipal

Rappresenta un'entità utente Microsoft Entra.

AssignableAdminConnectionRole

Enumerazione

Ruolo di connessione. È possibile aggiungere altri ruoli di connessione nel tempo.

Valore Descrizione
Owner

Consente all'entità di ottenere la proprietà della connessione. All'entità viene assegnato inizialmente il ruolo "PendingOwner" e per completare la transizione a "Proprietario", l'entità deve aggiornare le credenziali di connessione usando l'API di connessione di aggiornamento.

ConnectionRole

Enumerazione

Ruolo di connessione. È possibile aggiungere altri ruoli di connessione nel tempo.

Valore Descrizione
User

Abilita l'accesso utente per la connessione.
UserWithReshare

Abilita l'utente con accesso di ricondivisione per la connessione.
Owner

Abilita l'accesso alla proprietà per la connessione.
PendingOwner

La proprietà della connessione non è ancora effettiva; l'entità deve aggiornare le credenziali di connessione (usando l'API di connessione di aggiornamento) per renderla effettiva.

ConnectionRoleAssignment

Oggetto

Assegnazione di ruolo di connessione per un'entità.

Nome Tipo Descrizione
id

string (uuid)

ID oggetto dell'assegnazione del ruolo di connessione.
principal Principal:

Entità.
role

ConnectionRole

Ruolo di connessione dell'entità.

EntireTenantPrincipal

Oggetto

Rappresenta un'entità tenant

Nome Tipo Descrizione
displayName

string

Nome visualizzato dell'entità.
id

string (uuid)

ID dell'entità.
type string:

EntireTenant

Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.

ErrorParameter

Oggetto

Parametro strutturato che fornisce un contesto aggiuntivo leggibile dal computer relativo a un errore.

Nome Tipo Descrizione
message

string

Descrizione leggibile del significato del parametro.
name

string

L'identificatore dei parametri.
value

string

Valore del parametro.

ErrorRelatedResource

Oggetto

Oggetto dei dettagli della risorsa relativo all'errore.

Nome Tipo Descrizione
resourceId

string

ID risorsa coinvolto nell'errore.
resourceType

string

Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Oggetto

Risposta di errore.

Nome Tipo Descrizione
errorCode

string

Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
isRetriable

boolean

Se true, la richiesta può essere ritentata. Usare l'intestazione della Retry-After risposta per determinare il ritardo, se disponibile.
message

string

Rappresentazione leggibile dell'errore.
moreDetails

ErrorResponseDetails[]

Elenco di dettagli aggiuntivi sull'errore.
parameters

ErrorParameter[]

Parametri strutturati che forniscono un contesto aggiuntivo leggibile dal computer sull'errore.
relatedResource

ErrorRelatedResource

Dettagli della risorsa correlati all'errore.
requestId

string (uuid)

ID della richiesta associata all'errore.

ErrorResponseDetails

Oggetto

Dettagli della risposta di errore.

Nome Tipo Descrizione
errorCode

string

Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message

string

Rappresentazione leggibile dell'errore.
parameters

ErrorParameter[]

Parametri strutturati che forniscono un contesto aggiuntivo leggibile dal computer sull'errore.
relatedResource

ErrorRelatedResource

Dettagli della risorsa correlati all'errore.

GroupDetails

Oggetto

Dettagli specifici del gruppo. Applicabile quando il tipo di entità è Group.

Nome Tipo Descrizione
groupType

GroupType

Tipo del gruppo. È possibile aggiungere altri tipi di gruppo nel tempo.

GroupPrincipal

Oggetto

Rappresenta un gruppo di sicurezza.

Nome Tipo Descrizione
displayName

string

Nome visualizzato dell'entità.
groupDetails

GroupDetails

Dettagli specifici del gruppo. Applicabile quando il tipo di entità è Group.
id

string (uuid)

ID dell'entità.
type string:

Group

Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.

GroupType

Enumerazione

Tipo del gruppo. È possibile aggiungere altri tipi di gruppo nel tempo.

Valore Descrizione
Unknown

Il tipo di gruppo principale è sconosciuto.
SecurityGroup

Principal è un gruppo di sicurezza.
DistributionList

Principal è una lista di distribuzione.

PrincipalType

Enumerazione

Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.

Valore Descrizione
User

Principal è un'entità utente Microsoft Entra.
ServicePrincipal

Principal è un'entità servizio Microsoft Entra.
Group

Principal è un gruppo di sicurezza.
ServicePrincipalProfile

Principal è un profilo dell'entità servizio.
EntireTenant

Principal rappresenta tutti gli utenti tenant.

ServicePrincipalDetails

Oggetto

Dettagli specifici dell'entità servizio. Applicabile quando il tipo di entità è ServicePrincipal.

Nome Tipo Descrizione
aadAppId

string (uuid)

L'entità servizio Microsoft Entra AppId.

ServicePrincipalPrincipal

Oggetto

Rappresenta un'entità servizio Microsoft Entra.

Nome Tipo Descrizione
displayName

string

Nome visualizzato dell'entità.
id

string (uuid)

ID dell'entità.
servicePrincipalDetails

ServicePrincipalDetails

Dettagli specifici dell'entità servizio. Applicabile quando il tipo di entità è ServicePrincipal.
type string:

ServicePrincipal

Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.

ServicePrincipalProfileDetails

Oggetto

Dettagli del profilo dell'entità servizio. Applicabile quando il tipo di entità è ServicePrincipalProfile.

Nome Tipo Descrizione
parentPrincipal Principal:

Entità padre del profilo dell'entità servizio.

ServicePrincipalProfilePrincipal

Oggetto

Rappresenta un profilo dell'entità servizio.

Nome Tipo Descrizione
displayName

string

Nome visualizzato dell'entità.
id

string (uuid)

ID dell'entità.
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Dettagli del profilo dell'entità servizio. Applicabile quando il tipo di entità è ServicePrincipalProfile.
type string:

ServicePrincipalProfile

Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.

UpdateAdminConnectionRoleAssignmentRequest

Oggetto

Payload della richiesta di assegnazione del ruolo di connessione di aggiornamento.

Nome Tipo Descrizione
role

AssignableAdminConnectionRole

Ruolo di connessione dell'entità.

UserDetails

Oggetto

Dettagli specifici dell'entità utente. Applicabile quando il tipo di entità è User.

Nome Tipo Descrizione
userPrincipalName

string

Nome principale utente.

UserPrincipal

Oggetto

Rappresenta un'entità utente Microsoft Entra.

Nome Tipo Descrizione
displayName

string

Nome visualizzato dell'entità.
id

string (uuid)

ID dell'entità.
type string:

User

Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.
userDetails

UserDetails

Dettagli specifici dell'entità utente. Applicabile quando il tipo di entità è User.