Connections - Get Connection

Dienst:: Core

API-Version:: v1

Verbindung nach ID abrufen.

Permissions

Der Anrufer muss über die Berechtigung für die Verbindung oder administratorberechtigung für das Gateway der Verbindung verfügen.

Erforderliche delegierte Bereiche

Connection.Read.All oder Connection.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identity	Support
User	Yes
Dienstprinzipal und verwaltete Identitäten	Yes

Interface

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
connectionId	path	True	string (uuid)	Die ID der Verbindung.

Antworten

Name Typ Beschreibung

200 OK

Name	Typ	Beschreibung
200 OK	Connection: ShareableCloudConnection PersonalCloudConnection OnPremisesGatewayConnection OnPremisesGatewayPersonalConnection VirtualNetworkGatewayConnection	OK. Der Vorgang war erfolgreich.
429 Too Many Requests	ErrorResponse	Der Dienstratengrenzwert wurde überschritten. Der Server gibt einen `Retry-After` Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden. Header Retry-After: integer
Other Status Codes	ErrorResponse	Häufige Fehlercodes: EntityNotFound – Die angeforderte Ressource konnte nicht gefunden werden.

Connection:

ShareableCloudConnection
PersonalCloudConnection
OnPremisesGatewayConnection
OnPremisesGatewayPersonalConnection
VirtualNetworkGatewayConnection

OK. Der Vorgang war erfolgreich.

429 Too Many Requests

ErrorResponse

Der Dienstratengrenzwert wurde überschritten. Der Server gibt einen Retry-After Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden.

Header

Retry-After: integer

Other Status Codes

ErrorResponse

Häufige Fehlercodes:

EntityNotFound – Die angeforderte Ressource konnte nicht gefunden werden.

Beispiele

Example

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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
  }
}

Definitionen

Name	Beschreibung
ConnectionEncryption	Der Verbindungsverschlüsselungstyp der Verbindung. Zusätzliche Verbindungsverschlüsselungswerte können im Laufe der Zeit hinzugefügt werden.
ConnectivityType	Der Verbindungstyp der Verbindung. Zusätzliche Verbindungstypen können im Laufe der Zeit hinzugefügt werden.
CredentialType	Der Anmeldeinformationstyp der Verbindung. Zusätzliche Anmeldeinformationstypen können im Laufe der Zeit hinzugefügt werden.
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
ListConnectionDetails	Die Ausgabe der Verbindungsdetails für Listenvorgänge.
ListCredentialDetails	Die Beim Abrufen einer Verbindung zurückgegebenen Anmeldeinformationen.
OnPremisesGatewayConnection	Eine Verbindung, die über das lokale Datengateway eine Verbindung herstellt.
OnPremisesGatewayPersonalConnection	Eine Verbindung, die über ein persönliches lokales Datengateway eine Verbindung herstellt.
PersonalCloudConnection	Eine Verbindung, die eine Verbindung über die Cloud herstellt und nicht freigegeben werden kann.
PrivacyLevel	Die Einstellung der Datenschutzstufe der Verbindung. Zusätzliche Datenschutzstufen können im Laufe der Zeit hinzugefügt werden.
ShareableCloudConnection	Eine Verbindung, die über die Cloud verbunden ist.
SingleSignOnType	Der Single Sign-On-Typ der Verbindung. Zusätzliche Single Sign On-Typen können im Laufe der Zeit hinzugefügt werden.
VirtualNetworkGatewayConnection	Eine Verbindung, die über ein virtuelles Netzwerkdatengateway eine Verbindung herstellt.

ConnectionEncryption

Enumeration

Der Verbindungsverschlüsselungstyp der Verbindung. Zusätzliche Verbindungsverschlüsselungswerte können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Encrypted	Der Verbindungsversuch erfolgt mithilfe einer verschlüsselten Verbindung.
Any	Der Verbindungsversuch erfolgt zuerst mithilfe einer verschlüsselten Verbindung und greift dann bei Erfolg auf unverschlüsselte Verbindung zurück.
NotEncrypted	Der Verbindungsversuch erfolgt mithilfe einer unverschlüsselten Verbindung.

ConnectivityType

Enumeration

Der Verbindungstyp der Verbindung. Zusätzliche Verbindungstypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
ShareableCloud	Die Verbindung verbindet sich über die Cloud und kann für andere freigegeben werden.
PersonalCloud	Die Verbindung verbindet sich über die Cloud und kann nicht für andere freigegeben werden.
OnPremisesGateway	Die Verbindung wird über ein lokales Datengateway hergestellt.
OnPremisesGatewayPersonal	Die Verbindung wird über ein persönliches lokales Datengateway hergestellt.
VirtualNetworkGateway	Die Verbindung wird über ein virtuelles Netzwerkdatengateway hergestellt.
Automatic	Die Verbindung wird über die Cloud mithilfe einer impliziten Datenverbindung hergestellt. Diese Option ist nur für bestimmte Szenarien wie semantische Modelle verfügbar, die single Sign-On (SSO) verwenden".
None	Die Verbindung ist nicht gebunden.

CredentialType

Enumeration

Der Anmeldeinformationstyp der Verbindung. Zusätzliche Anmeldeinformationstypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Windows	Die Verbindung verwendet die Windows-Authentifizierung, um eine Verbindung herzustellen. Wird nur für lokale Gateways unterstützt.
Anonymous	Die Verbindung verwendet die anonyme Authentifizierung, um eine Verbindung herzustellen.
Basic	Die Verbindung verwendet die Standardauthentifizierung, um eine Verbindung herzustellen.
Key	Die Verbindung verwendet die Schlüsselauthentifizierung, um eine Verbindung herzustellen.
OAuth2	Die Verbindung verwendet die OAuth 2.0-Authentifizierung, um eine Verbindung herzustellen.
WindowsWithoutImpersonation	Die Verbindung verwendet die Windows-Authentifizierung (ohne die Option für identitätswechselbasierte Authentifizierung), um eine Verbindung herzustellen. Wird nur für lokale Gateways (persönlicher Modus) unterstützt.
SharedAccessSignature	Die Verbindung verwendet die SAS-Authentifizierung (Shared Access Signature), um eine Verbindung herzustellen.
ServicePrincipal	Die Verbindung verwendet die Dienstprinzipalauthentifizierung, um eine Verbindung herzustellen.
WorkspaceIdentity	Die Verbindung verwendet die Arbeitsbereichsidentitätsauthentifizierung, um eine Verbindung herzustellen.
KeyPair	Die Verbindung verwendet die Schlüsselpaarauthentifizierung, um eine Verbindung herzustellen.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name	Typ	Beschreibung
resourceId	string	Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType	string	Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
isRetriable	boolean	Wenn true, kann die Anforderung wiederholt werden. Verwenden Sie den `Retry-After` Antwortheader, um die Verzögerung zu ermitteln, falls verfügbar.
message	string	Eine lesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string (uuid)	ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.

ListConnectionDetails

Objekt

Die Ausgabe der Verbindungsdetails für Listenvorgänge.

Name	Typ	Beschreibung
path	string	Der Pfad der Verbindung.
type	string	Der Typ der Verbindung.

ListCredentialDetails

Objekt

Die Beim Abrufen einer Verbindung zurückgegebenen Anmeldeinformationen.

Name	Typ	Beschreibung
connectionEncryption	ConnectionEncryption	Die Verbindungsverschlüsselungseinstellung, die während der Testverbindung verwendet wird.
credentialType	CredentialType	Der Anmeldeinformationstyp der Verbindung.
singleSignOnType	SingleSignOnType	Der Single Sign-On-Typ der Verbindung.
skipTestConnection	boolean	Gibt an, ob die Verbindung die Testverbindung während der Erstellung und Aktualisierung überspringen soll. True – Überspringen Sie die Testverbindung, False – Überspringen Sie die Testverbindung nicht.

OnPremisesGatewayConnection

Objekt

Eine Verbindung, die über das lokale Datengateway eine Verbindung herstellt.

Name	Typ	Beschreibung
connectionDetails	ListConnectionDetails	Die Verbindungsdetails der Verbindung.
connectivityType	string: OnPremisesGateway	Der Verbindungstyp der Verbindung.
credentialDetails	ListCredentialDetails	Die Anmeldeinformationen der Verbindung.
displayName	string	Der Anzeigename der Verbindung.
gatewayId	string (uuid)	Die Gatewayobjekt-ID der Verbindung.
id	string (uuid)	Die Objekt-ID der Verbindung.
privacyLevel	PrivacyLevel	Die Datenschutzstufe der Verbindung.

OnPremisesGatewayPersonalConnection

Objekt

Eine Verbindung, die über ein persönliches lokales Datengateway eine Verbindung herstellt.

Name	Typ	Beschreibung
connectionDetails	ListConnectionDetails	Die Verbindungsdetails der Verbindung.
connectivityType	string: OnPremisesGatewayPersonal	Der Verbindungstyp der Verbindung.
credentialDetails	ListCredentialDetails	Die Anmeldeinformationen der Verbindung.
displayName	string	Der Anzeigename der Verbindung.
gatewayId	string (uuid)	Die Gatewayobjekt-ID der Verbindung.
id	string (uuid)	Die Objekt-ID der Verbindung.
privacyLevel	PrivacyLevel	Die Datenschutzstufe der Verbindung.

PersonalCloudConnection

Objekt

Eine Verbindung, die eine Verbindung über die Cloud herstellt und nicht freigegeben werden kann.

Name	Typ	Beschreibung
allowConnectionUsageInGateway	boolean	Zulassen, dass diese Verbindung entweder mit lokalen Datengateways oder VNet-Datengateways verwendet wird.
connectionDetails	ListConnectionDetails	Die Verbindungsdetails der Verbindung.
connectivityType	string: PersonalCloud	Der Verbindungstyp der Verbindung.
credentialDetails	ListCredentialDetails	Die Anmeldeinformationen der Verbindung.
displayName	string	Der Anzeigename der Verbindung.
id	string (uuid)	Die Objekt-ID der Verbindung.
privacyLevel	PrivacyLevel	Die Datenschutzstufe der Verbindung.

PrivacyLevel

Enumeration

Die Einstellung der Datenschutzstufe der Verbindung. Zusätzliche Datenschutzstufen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
None	Es ist keine Einstellung auf Datenschutzebene konfiguriert.
Private	Verbindungen, die auf "Privat" festgelegt sind, enthalten vertrauliche oder vertrauliche Informationen. Die Sichtbarkeit kann auf autorisierte Benutzer beschränkt werden. Daten aus einer privaten Verbindung werden nicht in andere Verbindungen eingefaltet, einschließlich anderer privater Verbindungen.
Organizational	Verbindungen, die auf Die Organisation festgelegt sind, können in private und andere Organisationsverbindungen gefaltet werden. Sie können nicht in öffentliche Verbindungen gefaltet werden. Die Sichtbarkeit ist auf eine vertrauenswürdige Gruppe festgelegt.
Public	Dateien, Internetverbindungen und Arbeitsmappendaten können auf "öffentlich" festgelegt werden. Daten können in andere Verbindungen gefaltet werden. Sichtbarkeit steht allen zur Verfügung.

ShareableCloudConnection

Objekt

Eine Verbindung, die über die Cloud verbunden ist.

Name	Typ	Beschreibung
allowConnectionUsageInGateway	boolean	Zulassen, dass diese Verbindung entweder mit lokalen Datengateways oder VNet-Datengateways verwendet wird.
allowUsageInUserControlledCode	boolean	Zulassen, dass diese Verbindung mit Elementen verwendet wird, die benutzerdefinierten Code wie Notizbuch zulassen.
connectionDetails	ListConnectionDetails	Die Verbindungsdetails der Verbindung.
connectivityType	string: ShareableCloud	Der Verbindungstyp der Verbindung.
credentialDetails	ListCredentialDetails	Die Anmeldeinformationen der Verbindung.
displayName	string	Der Anzeigename der Verbindung.
id	string (uuid)	Die Objekt-ID der Verbindung.
privacyLevel	PrivacyLevel	Die Datenschutzstufe der Verbindung.

SingleSignOnType

Enumeration

Der Single Sign-On-Typ der Verbindung. Zusätzliche Single Sign On-Typen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
None	Die Verbindung verwendet kein einmaliges Anmelden, um eine Verbindung herzustellen.
Kerberos	Die Verbindung verwendet einmaliges Kerberos-Anmelden, um eine Verbindung herzustellen.
MicrosoftEntraID	Die Verbindung verwendet das einmalige Anmelden der Microsoft Entra-ID, um eine Verbindung herzustellen.
SecurityAssertionMarkupLanguage	Connection verwendet einmaliges Anmelden (Security Assertion Markup Language, SAML), um eine Verbindung herzustellen.
KerberosDirectQueryAndRefresh	Die Verbindung verwendet Kerberos DirectQuery und einmaliges Anmelden aktualisieren, um eine Verbindung herzustellen.

VirtualNetworkGatewayConnection

Objekt

Eine Verbindung, die über ein virtuelles Netzwerkdatengateway eine Verbindung herstellt.

Name	Typ	Beschreibung
connectionDetails	ListConnectionDetails	Die Verbindungsdetails der Verbindung.
connectivityType	string: VirtualNetworkGateway	Der Verbindungstyp der Verbindung.
credentialDetails	ListCredentialDetails	Die Anmeldeinformationen der Verbindung.
displayName	string	Der Anzeigename der Verbindung.
gatewayId	string (uuid)	Die Gatewayobjekt-ID der Verbindung.
id	string (uuid)	Die Objekt-ID der Verbindung.
privacyLevel	PrivacyLevel	Die Datenschutzstufe der Verbindung.