Connections - List Connections

Référence

Service:: Core

Version d'API:: v1

Retourne une liste de connexions locales, de réseau virtuel et de cloud pour laquelle l’utilisateur a l’autorisation.

Autorisations

L’appelant doit disposer de l’autorisation pour la connexion.

Étendues déléguées requises

Connection.Read.All ou Connection.ReadWrite.All

Identités prises en charge par Microsoft Entra

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

Identité	Soutien
Utilisateur	Oui
principal de service et identités managées	Oui

Interface

GET https://api.fabric.microsoft.com/v1/connections

Avec des paramètres facultatifs:

GET https://api.fabric.microsoft.com/v1/connections?continuationToken={continuationToken}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
continuationToken	query		string	Jeton permettant de récupérer la page suivante des résultats.

Réponses

Nom	Type	Description
200 OK	ListConnectionsResponse	D’ACCORD. L’opération a réussi.
Other Status Codes	ErrorResponse	Codes d’erreur courants : UnknownError : une erreur s’est produite.

Nom

Type

Description

200 OK

ListConnectionsResponse

D’ACCORD. L’opération a réussi.

Other Status Codes

ErrorResponse

Codes d’erreur courants :

UnknownError : une erreur s’est produite.

Exemples

Example

Exemple de requête

HTTP

GET https://api.fabric.microsoft.com/v1/connections

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "id": "6952a7b2-aea3-414f-9d85-6c0fe5d34539",
      "displayName": "ContosoConnection1",
      "connectivityType": "ShareableCloud",
      "connectionDetails": {
        "type": "Web",
        "path": "https://www.contoso.com"
      },
      "privacyLevel": "Public",
      "credentialDetails": {
        "credentialType": "Anonymous",
        "singleSignOnType": "None",
        "connectionEncryption": "NotEncrypted",
        "skipTestConnection": false
      }
    },
    {
      "id": "f6a39b76-9816-4e4b-b93a-f42e405017b7",
      "displayName": "ContosoConnection2",
      "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": "Any",
        "skipTestConnection": false
      }
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/connections?continuationToken=LDEsMTAwMDAwLDA%3D"
}

Définitions

Nom	Description
Connection
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.
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.
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.
ListConnectionsResponse
ListCredentialDetails	Détails des informations d’identification retournés lors de l’extraction d’une connexion.
PrivacyLevel	Paramètre de niveau de confidentialité de la connexion. Des niveaux de confidentialité supplémentaires peuvent être ajoutés au fil du temps.
SingleSignOnType	Type d’authentification unique de la connexion. Des types d’authentification unique supplémentaires peuvent être ajoutés au fil du temps.

Connection

Object

Nom	Type	Description
connectionDetails	ListConnectionDetails	Détails de connexion de la connexion.
connectivityType	ConnectivityType	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.
privacyLevel	PrivacyLevel	Niveau de confidentialité de la connexion.

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
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.
Encrypted	La tentative de connexion est effectuée à l’aide d’une connexion chiffrée.
NotEncrypted	La tentative de connexion est effectuée à l’aide d’une connexion non chiffrée.

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
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
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.
PersonalCloud	La connexion se connecte via le cloud et ne peut pas être partagée avec d’autres personnes.
ShareableCloud	La connexion se connecte via le cloud et peut être partagée avec d’autres personnes.
VirtualNetworkGateway	La connexion se connecte via une passerelle de données de réseau virtuel.

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
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.
ServicePrincipal	La connexion utilise l’authentification du principal de service pour se connecter.
SharedAccessSignature	La connexion utilise l’authentification par signature d’accès partagé (SAP) pour se connecter.
Windows	La connexion utilise l’authentification Windows pour se connecter. Uniquement pris en charge pour les passerelles locales.
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).
WorkspaceIdentity	La connexion utilise l’authentification d’identité de l’espace de travail pour se connecter.

ErrorRelatedResource

Object

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

Object

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.
moreDetails	ErrorResponseDetails[]	Liste des détails d’erreur supplémentaires.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.
requestId	string	ID de la demande associée à l’erreur.

ErrorResponseDetails

Object

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.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.

ListConnectionDetails

Object

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.

ListConnectionsResponse

Object

Nom	Type	Description
continuationToken	string	Jeton du lot du jeu de résultats suivant. S’il n’y a plus d’enregistrements, il est supprimé de la réponse.
continuationUri	string	URI du lot du jeu de résultats suivant. S’il n’y a plus d’enregistrements, il est supprimé de la réponse.
value	Connection[]	Liste des connexions retournées.

ListCredentialDetails

Object

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.

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é.
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 approuvé.
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.
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.

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
Kerberos	La connexion utilise l’authentification unique Kerberos pour se connecter.
KerberosDirectQueryAndRefresh	La connexion utilise Kerberos DirectQuery et Actualiser l’authentification unique pour se connecter.
MicrosoftEntraID	La connexion utilise l’authentification unique Microsoft Entra ID pour se connecter.
None	La connexion n’utilise pas l’authentification unique pour se connecter.
SecurityAssertionMarkupLanguage	La connexion utilise l’authentification unique SAML (Security Assertion Markup Language) pour se connecter.

Partager via

Connections - List Connections

Autorisations

Étendues déléguées requises

Identités prises en charge par Microsoft Entra

Interface

Paramètres URI

Réponses

Exemples

Example

Exemple de requête

Exemple de réponse

Définitions

Connection

ConnectionEncryption

ConnectivityType

CredentialType

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ListConnectionDetails

ListConnectionsResponse

ListCredentialDetails

PrivacyLevel

SingleSignOnType