Connections - Update Connection Role Assignment

Service:: Admin

Version d’API:: v1

Met à jour l’attribution de rôle du principal pour la connexion.

Note

Fabric gestion des connexions d’administrateur client est actuellement en préversion (en savoir plus).

Permissions

L’appelant doit être un administrateur Fabric ou s’authentifier à l’aide d’un principal de service.

Étendues déléguées requises

Tenant.ReadWrite.All

Limitations

Aucune limitation supplémentaire.

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identity	Support
Utilisateur	Yes
Service principal et identités gérées	Yes

Interface

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
connectionId	path	True	string (uuid)	ID de connexion.
connectionRoleAssignmentId	path	True	string (uuid)	ID de l’attribution de rôle de connexion.

Corps de la demande

Nom	Obligatoire	Type	Description
role	True	AssignableAdminConnectionRole	Rôle de connexion du principal.

Réponses

Nom Type Description

200 OK

Nom	Type	Description
200 OK	ConnectionRoleAssignment	OK. L’opération a réussi.
429 Too Many Requests	ErrorResponse	La limite de débit de service a été dépassée. Le serveur retourne un `Retry-After` en-tête indiquant, en secondes, combien de temps le client doit attendre avant d’envoyer des demandes supplémentaires. En-têtes Retry-After: integer
Other Status Codes	ErrorResponse	Codes d’erreur courants : UnknownError : une erreur s’est produite.

ConnectionRoleAssignment

OK. L’opération a réussi.

429 Too Many Requests

ErrorResponse

La limite de débit de service a été dépassée. Le serveur retourne un Retry-After en-tête indiquant, en secondes, combien de temps le client doit attendre avant d’envoyer des demandes supplémentaires.

En-têtes

Retry-After: integer

Other Status Codes

ErrorResponse

Codes d’erreur courants :

UnknownError : une erreur s’est produite.

Exemples

Update connection role assignment as admin example

Exemple de requête

HTTP

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

{
  "role": "Owner"
}

Exemple de réponse

Code d’état:: 200

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

Définitions

Nom	Description
AssignableAdminConnectionRole	Rôle de connexion. Des rôles de connexion supplémentaires peuvent être ajoutés au fil du temps.
ConnectionRole	Rôle de connexion. Des rôles de connexion supplémentaires peuvent être ajoutés au fil du temps.
ConnectionRoleAssignment	Attribution de rôle de connexion pour un principal.
EntireTenantPrincipal	Représente un principal de locataire
ErrorParameter	Paramètre structuré fournissant un contexte lisible par l’ordinateur supplémentaire à propos d’une erreur.
ErrorRelatedResource	Objet de détails de ressource associé à l’erreur.
ErrorResponse	Réponse d’erreur.
ErrorResponseDetails	Détails de la réponse d’erreur.
GroupDetails	Détails spécifiques du groupe. Applicable lorsque le type principal est `Group`.
GroupPrincipal	Représente un groupe de sécurité.
GroupType	Type du groupe. Des types de groupes supplémentaires peuvent être ajoutés au fil du temps.
PrincipalType	Type du principal. Des types principaux supplémentaires peuvent être ajoutés au fil du temps.
ServicePrincipalDetails	Détails spécifiques au principal de service. Applicable lorsque le type principal est `ServicePrincipal`.
ServicePrincipalPrincipal	Représente un principal de service Microsoft Entra.
ServicePrincipalProfileDetails	Détails du profil du principal de service. Applicable lorsque le type principal est `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Représente un profil de principal de service.
UpdateAdminConnectionRoleAssignmentRequest	Charge utile de demande d’attribution de rôle de connexion de mise à jour.
UserDetails	Détails spécifiques au principal de l’utilisateur. Applicable lorsque le type principal est `User`.
UserPrincipal	Représente un principal d’utilisateur Microsoft Entra.

AssignableAdminConnectionRole

Énumération

Rôle de connexion. Des rôles de connexion supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
Owner	Permet au principal d’obtenir la propriété de la connexion. Le principal est initialement affecté au rôle « PendingOwner » et pour terminer la transition vers « Propriétaire », le principal doit mettre à jour les informations d’identification de connexion à l’aide de l’API Update Connection.

ConnectionRole

Énumération

Rôle de connexion. Des rôles de connexion supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
User	Permet à l’utilisateur d’accéder à la connexion.
UserWithReshare	Permet à l’utilisateur d’accéder à nouveau pour la connexion.
Owner	Active l’accès à la propriété pour la connexion.
PendingOwner	La propriété de la connexion n’est pas encore effective ; le principal doit mettre à jour les informations d’identification de connexion (à l’aide de l’API Mettre à jour la connexion) pour qu’elle soit effective.

ConnectionRoleAssignment

Objet

Attribution de rôle de connexion pour un principal.

Nom	Type	Description
id	string (uuid)	ID d’objet de l’attribution de rôle de connexion.
principal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Principal.
role	ConnectionRole	Rôle de connexion du principal.

EntireTenantPrincipal

Objet

Représente un principal de locataire

Nom	Type	Description
displayName	string	Nom complet du principal.
id	string (uuid)	ID du principal.
type	string: EntireTenant	Type du principal. Des types principaux supplémentaires peuvent être ajoutés au fil du temps.

ErrorParameter

Objet

Paramètre structuré fournissant un contexte lisible par l’ordinateur supplémentaire à propos d’une erreur.

Nom	Type	Description
message	string	Description lisible par l’homme de la signification du paramètre.
name	string	L’identifiant de paramètre.
value	string	Représente la valeur du paramètre.

ErrorRelatedResource

Objet

Objet de détails de ressource associé à l’erreur.

Nom	Type	Description
resourceId	string	ID de ressource impliqué dans l’erreur.
resourceType	string	Type de la ressource impliquée dans l’erreur.

ErrorResponse

Objet

Réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
isRetriable	boolean	Lorsque la valeur est true, la requête peut être retentée. Utilisez l’en-tête `Retry-After` de réponse pour déterminer le délai, le cas échéant.
message	string	Représentation lisible humaine de l’erreur.
moreDetails	ErrorResponseDetails[]	Liste des détails d’erreur supplémentaires.
parameters	ErrorParameter[]	Paramètres structurés fournissant un contexte lisible par l’ordinateur supplémentaire sur l’erreur.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.
requestId	string (uuid)	ID de la demande associée à l’erreur.

ErrorResponseDetails

Objet

Détails de la réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
parameters	ErrorParameter[]	Paramètres structurés fournissant un contexte lisible par l’ordinateur supplémentaire sur l’erreur.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.

GroupDetails

Objet

Détails spécifiques du groupe. Applicable lorsque le type principal est Group.

Nom	Type	Description
groupType	GroupType	Type du groupe. Des types de groupes supplémentaires peuvent être ajoutés au fil du temps.

GroupPrincipal

Objet

Représente un groupe de sécurité.

Nom	Type	Description
displayName	string	Nom complet du principal.
groupDetails	GroupDetails	Détails spécifiques du groupe. Applicable lorsque le type principal est `Group`.
id	string (uuid)	ID du principal.
type	string: Group	Type du principal. Des types principaux supplémentaires peuvent être ajoutés au fil du temps.

GroupType

Énumération

Type du groupe. Des types de groupes supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
Unknown	Le type de groupe principal est inconnu.
SecurityGroup	Principal est un groupe de sécurité.
DistributionList	Principal est une liste de distribution.

PrincipalType

Énumération

Type du principal. Des types principaux supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
User	Principal est un principal d’utilisateur Microsoft Entra.
ServicePrincipal	Le principal est un principal de service Microsoft Entra.
Group	Principal est un groupe de sécurité.
ServicePrincipalProfile	Le principal est un profil de principal de service.
EntireTenant	Le principal représente tous les utilisateurs du locataire.

ServicePrincipalDetails

Objet

Détails spécifiques au principal de service. Applicable lorsque le type principal est ServicePrincipal.

Nom	Type	Description
aadAppId	string (uuid)	AppId Microsoft Entra du principal de service.

ServicePrincipalPrincipal

Objet

Représente un principal de service Microsoft Entra.

Nom	Type	Description
displayName	string	Nom complet du principal.
id	string (uuid)	ID du principal.
servicePrincipalDetails	ServicePrincipalDetails	Détails spécifiques au principal de service. Applicable lorsque le type principal est `ServicePrincipal`.
type	string: ServicePrincipal	Type du principal. Des types principaux supplémentaires peuvent être ajoutés au fil du temps.

ServicePrincipalProfileDetails

Objet

Détails du profil du principal de service. Applicable lorsque le type principal est ServicePrincipalProfile.

Nom	Type	Description
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Principal parent du profil de principal de service.

ServicePrincipalProfilePrincipal

Objet

Représente un profil de principal de service.

Nom	Type	Description
displayName	string	Nom complet du principal.
id	string (uuid)	ID du principal.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Détails du profil du principal de service. Applicable lorsque le type principal est `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Type du principal. Des types principaux supplémentaires peuvent être ajoutés au fil du temps.

UpdateAdminConnectionRoleAssignmentRequest

Objet

Charge utile de demande d’attribution de rôle de connexion de mise à jour.

Nom	Type	Description
role	AssignableAdminConnectionRole	Rôle de connexion du principal.

UserDetails

Objet

Détails spécifiques au principal de l’utilisateur. Applicable lorsque le type principal est User.

Nom	Type	Description
userPrincipalName	string	Nom d’utilisateur principal.

UserPrincipal

Objet

Représente un principal d’utilisateur Microsoft Entra.

Nom	Type	Description
displayName	string	Nom complet du principal.
id	string (uuid)	ID du principal.
type	string: User	Type du principal. Des types principaux supplémentaires peuvent être ajoutés au fil du temps.
userDetails	UserDetails	Détails spécifiques au principal de l’utilisateur. Applicable lorsque le type principal est `User`.