Connections - Get Connection

Service:: Admin

Version d’API:: v1

Retourne la connexion spécifiée.

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.Read.All ou Tenant.ReadWrite.All

Limitations

None.

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

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
connectionId	path	True	string (uuid)	ID de connexion.

Réponses

Nom Type Description

200 OK

Nom	Type	Description
200 OK	Connection: ShareableCloudConnection PersonalCloudConnection OnPremisesGatewayConnection OnPremisesGatewayPersonalConnection VirtualNetworkGatewayConnection StreamingVirtualNetworkGatewayConnection	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 : EntityNotFound : la ressource demandée est introuvable.

Connection:

ShareableCloudConnection
PersonalCloudConnection
OnPremisesGatewayConnection
OnPremisesGatewayPersonalConnection
VirtualNetworkGatewayConnection
StreamingVirtualNetworkGatewayConnection

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 :

EntityNotFound : la ressource demandée est introuvable.

Exemples

Get connection as admin example

Exemple de requête

HTTP

GET https://api.fabric.microsoft.com/v1/admin/connections/f6a39b76-9816-4e4b-b93a-f42e405017b7

Exemple de réponse

Code d’état:: 200

{
  "id": "f6a39b76-9816-4e4b-b93a-f42e405017b7",
  "displayName": "ContosoConnection",
  "gatewayId": "58376c10-5f61-4024-887e-748df4beae45",
  "connectivityType": "OnPremisesGateway",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;sales"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  }
}

Définitions

Nom	Description
ConnectionEncryption	Type de chiffrement de connexion de la connexion. Des valeurs de chiffrement de connexion supplémentaires peuvent être ajoutées au fil du temps.
ConnectionRecency	Représente les détails de la récurrence sur la connexion.
ConnectionRole	Rôle de connexion. Des rôles de connexion supplémentaires peuvent être ajoutés au fil du temps.
ConnectivityType	Type de connectivité de la connexion. Des types de connectivité supplémentaires peuvent être ajoutés au fil du temps.
CredentialType	Type d’informations d’identification de la connexion. Des types d’informations d’identification supplémentaires peuvent être ajoutés au fil du temps.
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.
ListConnectionDetails	Sortie des détails de connexion pour les opérations de liste.
ListCredentialDetails	Détails des informations d’identification retournés lors de l’extraction d’une connexion.
OnPremisesGatewayConnection	Connexion qui se connecte via une passerelle de données locale.
OnPremisesGatewayPersonalConnection	Connexion qui se connecte via une passerelle de données locale personnelle.
PersonalCloudConnection	Connexion qui se connecte via le cloud et ne peut pas être partagée.
PrivacyLevel	Paramètre de niveau de confidentialité de la connexion. Des niveaux de confidentialité supplémentaires peuvent être ajoutés au fil du temps.
ShareableCloudConnection	Connexion qui se connecte via le cloud.
SingleSignOnType	Type d’authentification unique de la connexion. Des types d’authentification unique supplémentaires peuvent être ajoutés au fil du temps.
StreamingVirtualNetworkGatewayConnection	Connexion qui se connecte via une passerelle de données de réseau virtuel de streaming.
VirtualNetworkGatewayConnection	Connexion qui se connecte via une passerelle de données de réseau virtuel.

ConnectionEncryption

Énumération

Type de chiffrement de connexion de la connexion. Des valeurs de chiffrement de connexion supplémentaires peuvent être ajoutées au fil du temps.

Valeur	Description
Encrypted	La tentative de connexion est effectuée à l’aide d’une connexion chiffrée.
Any	La tentative de connexion est d’abord effectuée à l’aide d’une connexion chiffrée, puis revient à une connexion non chiffrée en cas d’échec.
NotEncrypted	La tentative de connexion est effectuée à l’aide d’une connexion non chiffrée.

ConnectionRecency

Objet

Représente les détails de la récurrence sur la connexion.

Nom	Type	Description
createdDateTime	string (date-time)	Horodatage lorsque la connexion a été créée au format UTC, à l’aide du format AAAA-MM-DDTHH :mm :ssZ.
lastBoundDateTime	string (date-time)	Horodatage lorsque la connexion a été la plus récemment liée à n’importe quel élément au format UTC, à l’aide du format AAAA-MM-DDTHH :mm :ssZ.
lastCredentialUsedDateTime	string (date-time)	Horodatage lorsque les informations d’identification de connexion ont été utilisées récemment au format UTC, à l’aide du format AAAA-MM-DDTHH :mm :ssZ.
myLastBoundDateTime	string (date-time)	Horodatage lorsque la connexion était la plus récemment liée à n’importe quel élément par l’utilisateur appelant au format UTC, à l’aide du format AAAA-MM-DDTHH :mm :ssZ.
myLastCredentialUsedDateTime	string (date-time)	Horodatage lorsque les informations d’identification de connexion ont été utilisées récemment par l’utilisateur appelant au format UTC, à l’aide du format AAAA-MM-DDTHH :mm :ssZ.

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.

ConnectivityType

Énumération

Type de connectivité de la connexion. Des types de connectivité supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
ShareableCloud	La connexion se connecte via le cloud et peut être partagée avec d’autres personnes.
PersonalCloud	La connexion se connecte via le cloud et ne peut pas être partagée avec d’autres personnes.
OnPremisesGateway	La connexion se connecte via une passerelle de données locale.
OnPremisesGatewayPersonal	La connexion se connecte via une passerelle de données locale personnelle.
VirtualNetworkGateway	La connexion se connecte via une passerelle de données de réseau virtuel.
StreamingVirtualNetworkGateway	La connexion se connecte via une passerelle de données de réseau virtuel de streaming.
Automatic	La connexion se connecte via le cloud à l’aide d’une connexion de données implicite. Cette option est disponible uniquement pour des scénarios spécifiques tels que des modèles sémantiques qui utilisent l'Sign-On authentification unique (SSO). »
None	La connexion n’est pas liée

CredentialType

Énumération

Type d’informations d’identification de la connexion. Des types d’informations d’identification supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
Windows	La connexion utilise l’authentification Windows pour se connecter. Uniquement pris en charge pour les passerelles locales.
Anonymous	La connexion utilise l’authentification anonyme pour se connecter.
Basic	La connexion utilise l’authentification de base pour se connecter.
Key	La connexion utilise l’authentification par clé pour se connecter.
OAuth2	La connexion utilise l’authentification OAuth 2.0 pour se connecter.
WindowsWithoutImpersonation	La connexion utilise Windows (sans option pour l’authentification d’emprunt d’identité) pour se connecter. Uniquement pris en charge pour les passerelles locales (mode personnel).
SharedAccessSignature	La connexion utilise l’authentification par signature d’accès partagé (SAP) pour se connecter.
ServicePrincipal	La connexion utilise l’authentification du principal de service pour se connecter.
WorkspaceIdentity	La connexion utilise l’authentification d’identité de l’espace de travail pour se connecter.
KeyPair	La connexion utilise l’authentification par paire de clés pour se connecter.

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.

ListConnectionDetails

Objet

Sortie des détails de connexion pour les opérations de liste.

Nom	Type	Description
path	string	Chemin d’accès de la connexion.
type	string	Type de connexion.

ListCredentialDetails

Objet

Détails des informations d’identification retournés lors de l’extraction d’une connexion.

Nom	Type	Description
connectionEncryption	ConnectionEncryption	Paramètre de chiffrement de connexion utilisé pendant la connexion de test.
credentialType	CredentialType	Type d’informations d’identification de la connexion.
singleSignOnType	SingleSignOnType	Type d’authentification unique de la connexion.
skipTestConnection	boolean	Indique si la connexion doit ignorer la connexion de test pendant la création et la mise à jour. True : ignorez la connexion de test, False : ne pas ignorer la connexion de test.

OnPremisesGatewayConnection

Objet

Connexion qui se connecte via une passerelle de données locale.

Nom	Type	Description
connectionDetails	ListConnectionDetails	Détails de connexion de la connexion.
connectionRecency	ConnectionRecency	Détails de la récurrence sur la connexion.
connectivityType	string: OnPremisesGateway	Type de connectivité de la connexion.
credentialDetails	ListCredentialDetails	Détails des informations d’identification de la connexion.
displayName	string	Nom complet de la connexion.
gatewayId	string (uuid)	ID d’objet de passerelle via lequel la connexion est établie. Pour les connexions cloud, il s’agit de l’ID de passerelle virtuelle.
id	string (uuid)	ID d’objet de la connexion.
myRole	ConnectionRole	Rôle effectif du principal appelant sur la connexion. Lorsque le principal fait partie de plusieurs groupes de sécurité avec différents rôles, le rôle le plus élevé est retourné. Si le principal n’a aucun rôle sur la connexion, cette propriété n’est pas retournée.
privacyLevel	PrivacyLevel	Niveau de confidentialité de la connexion.

OnPremisesGatewayPersonalConnection

Objet

Connexion qui se connecte via une passerelle de données locale personnelle.

Nom	Type	Description
connectionDetails	ListConnectionDetails	Détails de connexion de la connexion.
connectionRecency	ConnectionRecency	Détails de la récurrence sur la connexion.
connectivityType	string: OnPremisesGatewayPersonal	Type de connectivité de la connexion.
credentialDetails	ListCredentialDetails	Détails des informations d’identification de la connexion.
displayName	string	Nom complet de la connexion.
gatewayId	string (uuid)	ID d’objet de passerelle via lequel la connexion est établie. Pour les connexions cloud, il s’agit de l’ID de passerelle virtuelle.
id	string (uuid)	ID d’objet de la connexion.
myRole	ConnectionRole	Rôle effectif du principal appelant sur la connexion. Lorsque le principal fait partie de plusieurs groupes de sécurité avec différents rôles, le rôle le plus élevé est retourné. Si le principal n’a aucun rôle sur la connexion, cette propriété n’est pas retournée.
privacyLevel	PrivacyLevel	Niveau de confidentialité de la connexion.

PersonalCloudConnection

Objet

Connexion qui se connecte via le cloud et ne peut pas être partagée.

Nom	Type	Description
allowConnectionUsageInGateway	boolean	Autorisez cette connexion à utiliser avec des passerelles de données locales ou des passerelles de données de réseau virtuel.
connectionDetails	ListConnectionDetails	Détails de connexion de la connexion.
connectionRecency	ConnectionRecency	Détails de la récurrence sur la connexion.
connectivityType	string: PersonalCloud	Type de connectivité de la connexion.
credentialDetails	ListCredentialDetails	Détails des informations d’identification de la connexion.
displayName	string	Nom complet de la connexion.
gatewayId	string (uuid)	ID d’objet de passerelle via lequel la connexion est établie. Pour les connexions cloud, il s’agit de l’ID de passerelle virtuelle.
id	string (uuid)	ID d’objet de la connexion.
myRole	ConnectionRole	Rôle effectif du principal appelant sur la connexion. Lorsque le principal fait partie de plusieurs groupes de sécurité avec différents rôles, le rôle le plus élevé est retourné. Si le principal n’a aucun rôle sur la connexion, cette propriété n’est pas retournée.
privacyLevel	PrivacyLevel	Niveau de confidentialité de la connexion.

PrivacyLevel

Énumération

Paramètre de niveau de confidentialité de la connexion. Des niveaux de confidentialité supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
None	Aucun paramètre de niveau de confidentialité n’est configuré.
Private	Les connexions définies sur privé contiennent des informations sensibles ou confidentielles. La visibilité peut être limitée aux utilisateurs autorisés. Les données d’une connexion privée ne se plient pas à d’autres connexions, y compris d’autres connexions privées.
Organizational	Les connexions définies pour l’organisation peuvent se plier à des connexions privées et d’autres connexions organisationnelles. Ils ne peuvent pas se plier aux connexions publiques. La visibilité est définie sur un groupe fiable.
Public	Les fichiers, les connexions Internet et les données de classeur peuvent être définis sur public. Les données peuvent être pliables vers d’autres connexions. La visibilité est disponible pour tout le monde.

ShareableCloudConnection

Objet

Connexion qui se connecte via le cloud.

Nom	Type	Description
allowConnectionUsageInGateway	boolean	Autorisez cette connexion à utiliser avec des passerelles de données locales ou des passerelles de données de réseau virtuel.
allowUsageInUserControlledCode	boolean	Autorisez cette connexion à utiliser avec des éléments qui autorisent le code contrôlé par l’utilisateur, tel que Notebook.
connectionDetails	ListConnectionDetails	Détails de connexion de la connexion.
connectionRecency	ConnectionRecency	Détails de la récurrence sur la connexion.
connectivityType	string: ShareableCloud	Type de connectivité de la connexion.
credentialDetails	ListCredentialDetails	Détails des informations d’identification de la connexion.
displayName	string	Nom complet de la connexion.
gatewayId	string (uuid)	ID d’objet de passerelle via lequel la connexion est établie. Pour les connexions cloud, il s’agit de l’ID de passerelle virtuelle.
id	string (uuid)	ID d’objet de la connexion.
myRole	ConnectionRole	Rôle effectif du principal appelant sur la connexion. Lorsque le principal fait partie de plusieurs groupes de sécurité avec différents rôles, le rôle le plus élevé est retourné. Si le principal n’a aucun rôle sur la connexion, cette propriété n’est pas retournée.
privacyLevel	PrivacyLevel	Niveau de confidentialité de la connexion.

SingleSignOnType

Énumération

Type d’authentification unique de la connexion. Des types d’authentification unique supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
None	La connexion n’utilise pas l’authentification unique pour se connecter.
Kerberos	La connexion utilise l’authentification unique Kerberos pour se connecter.
MicrosoftEntraID	La connexion utilise l’authentification unique Microsoft Entra ID pour se connecter.
SecurityAssertionMarkupLanguage	La connexion utilise l’authentification unique SAML (Security Assertion Markup Language) pour se connecter.
KerberosDirectQueryAndRefresh	La connexion utilise Kerberos DirectQuery et Actualiser l’authentification unique pour se connecter.

StreamingVirtualNetworkGatewayConnection

Objet

Connexion qui se connecte via une passerelle de données de réseau virtuel de streaming.

Nom	Type	Description
connectionDetails	ListConnectionDetails	Détails de connexion de la connexion.
connectionRecency	ConnectionRecency	Détails de la récurrence sur la connexion.
connectivityType	string: StreamingVirtualNetworkGateway	Type de connectivité de la connexion.
credentialDetails	ListCredentialDetails	Détails des informations d’identification de la connexion.
displayName	string	Nom complet de la connexion.
gatewayId	string (uuid)	ID d’objet de passerelle de la connexion.
id	string (uuid)	ID d’objet de la connexion.
myRole	ConnectionRole	Rôle effectif du principal appelant sur la connexion. Lorsque le principal fait partie de plusieurs groupes de sécurité avec différents rôles, le rôle le plus élevé est retourné. Si le principal n’a aucun rôle sur la connexion, cette propriété n’est pas retournée.
privacyLevel	PrivacyLevel	Niveau de confidentialité de la connexion.

VirtualNetworkGatewayConnection

Objet

Connexion qui se connecte via une passerelle de données de réseau virtuel.

Nom	Type	Description
connectionDetails	ListConnectionDetails	Détails de connexion de la connexion.
connectionRecency	ConnectionRecency	Détails de la récurrence sur la connexion.
connectivityType	string: VirtualNetworkGateway	Type de connectivité de la connexion.
credentialDetails	ListCredentialDetails	Détails des informations d’identification de la connexion.
displayName	string	Nom complet de la connexion.
gatewayId	string (uuid)	ID d’objet de passerelle via lequel la connexion est établie. Pour les connexions cloud, il s’agit de l’ID de passerelle virtuelle.
id	string (uuid)	ID d’objet de la connexion.
myRole	ConnectionRole	Rôle effectif du principal appelant sur la connexion. Lorsque le principal fait partie de plusieurs groupes de sécurité avec différents rôles, le rôle le plus élevé est retourné. Si le principal n’a aucun rôle sur la connexion, cette propriété n’est pas retournée.
privacyLevel	PrivacyLevel	Niveau de confidentialité de la connexion.