Connections - Create Connection

Dienst:: Core

API-Version:: v1

Erstellt eine Verbindung.
Informationen zum Verschlüsseln von Anmeldeinformationen finden Sie unter Programmgesteuertes Konfigurieren von Anmeldeinformationen.

Permissions

Wenn Sie eine Gatewayverbindung erstellen, muss der Aufrufer über Berechtigungen für das Gateway verfügen.
Dienstprinzipale müssen über die Berechtigung des Fabric-Administrators verfügen. Weitere Informationen finden Sie unter: Dienstprinzipale können Arbeitsbereiche, Verbindungen und Bereitstellungspipelinen erstellen.

Erforderliche delegierte Bereiche

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

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

Anforderungstext

Beim Anforderungstext kann es sich um eines der folgenden Elemente handeln:

Name	Beschreibung
CreateCloudConnectionRequest
CreateOnPremisesConnectionRequest
CreateVirtualNetworkGatewayConnectionRequest

CreateCloudConnectionRequest

Name	Erforderlich	Typ	Beschreibung
connectionDetails	True	CreateConnectionDetails	Die Verbindungsdetails der Verbindung.
connectivityType	True	string: ShareableCloud	Der Verbindungstyp der Verbindung.
credentialDetails	True	CreateCredentialDetails	Die Anmeldeinformationen der Verbindung.
displayName	True	string	Der Anzeigename der Verbindung. Die maximale Länge beträgt 200 Zeichen.
allowConnectionUsageInGateway		boolean	Zulassen, dass diese Verbindung entweder mit lokalen Datengateways oder VNet-Datengateways verwendet wird.
privacyLevel		PrivacyLevel	(Optional) Die Datenschutzstufe der Verbindung. Wenn kein Wert übergeben wird, wird dieser wert auf "Organizational" festgelegt.

CreateOnPremisesConnectionRequest

Name	Erforderlich	Typ	Beschreibung
connectionDetails	True	CreateConnectionDetails	Die Verbindungsdetails der Verbindung.
connectivityType	True	string: OnPremisesGateway	Der Verbindungstyp der Verbindung.
credentialDetails	True	CreateOnPremisesCredentialDetails	Die Anmeldeinformationen der Verbindung.
displayName	True	string	Der Anzeigename der Verbindung. Die maximale Länge beträgt 200 Zeichen.
gatewayId	True	string (uuid)	Die Objekt-ID des primären Gateways des lokalen Gateways, unter dem die Verbindung erstellt wird.
privacyLevel		PrivacyLevel	(Optional) Die Datenschutzstufe der Verbindung. Wenn kein Wert übergeben wird, wird dieser wert auf "Organizational" festgelegt.

CreateVirtualNetworkGatewayConnectionRequest

Name	Erforderlich	Typ	Beschreibung
connectionDetails	True	CreateConnectionDetails	Die Verbindungsdetails der Verbindung.
connectivityType	True	string: VirtualNetworkGateway	Der Verbindungstyp der Verbindung.
credentialDetails	True	CreateCredentialDetails	Die Anmeldeinformationen der Verbindung.
displayName	True	string	Der Anzeigename der Verbindung. Die maximale Länge beträgt 200 Zeichen.
gatewayId	True	string (uuid)	Die Objekt-ID des virtuellen Netzwerkgateways, unter dem die Verbindung erstellt wird.
privacyLevel		PrivacyLevel	(Optional) Die Datenschutzstufe der Verbindung. Wenn kein Wert übergeben wird, wird dieser wert auf "Organizational" festgelegt.

Antworten

Name	Typ	Beschreibung
201 Created	Connection: ShareableCloudConnection PersonalCloudConnection OnPremisesGatewayConnection OnPremisesGatewayPersonalConnection VirtualNetworkGatewayConnection	Created. Der Vorgang war erfolgreich.
Other Status Codes	ErrorResponse	Häufige Fehlercodes: DuplicateConnectionName – Der Verbindungsname wird bereits verwendet. InvalidConnectionDetails – Die bereitgestellte ConnectionDetails-Eingabe ist ungültig. InvalidCredentialDetails – Die bereitgestellte CredentialDetails-Eingabe ist ungültig. Falsche Anmeldeinformationen – Fehler beim Herstellen der Verbindung mithilfe der Anmeldeinformationeneingabe. CreateGatewayConnectionFailed – Fehler beim Erstellen der Gatewayverbindung.

Name

Typ

Beschreibung

201 Created

Connection:

ShareableCloudConnection
PersonalCloudConnection
OnPremisesGatewayConnection
OnPremisesGatewayPersonalConnection
VirtualNetworkGatewayConnection

Created. Der Vorgang war erfolgreich.

Other Status Codes

ErrorResponse

Häufige Fehlercodes:

DuplicateConnectionName – Der Verbindungsname wird bereits verwendet.
InvalidConnectionDetails – Die bereitgestellte ConnectionDetails-Eingabe ist ungültig.
InvalidCredentialDetails – Die bereitgestellte CredentialDetails-Eingabe ist ungültig.
Falsche Anmeldeinformationen – Fehler beim Herstellen der Verbindung mithilfe der Anmeldeinformationeneingabe.
CreateGatewayConnectionFailed – Fehler beim Erstellen der Gatewayverbindung.

Beispiele

Cloud example

On-premises gateway example

Virtual network gateway example

Cloud example

Beispielanforderung

HTTP

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

{
  "connectivityType": "ShareableCloud",
  "displayName": "ContosoCloudConnection",
  "connectionDetails": {
    "type": "SQL",
    "creationMethod": "SQL",
    "parameters": [
      {
        "dataType": "Text",
        "name": "server",
        "value": "contoso.database.windows.net"
      },
      {
        "dataType": "Text",
        "name": "database",
        "value": "sales"
      }
    ]
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false,
    "credentials": {
      "credentialType": "Basic",
      "username": "admin",
      "password": "********"
    }
  }
}

Beispiel für eine Antwort

Statuscode:: 201

{
  "id": "eeec9a3a-6ef5-4e2b-bb6a-0060bd2f0172",
  "displayName": "ContosoCloudConnection",
  "connectivityType": "ShareableCloud",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;sales"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  }
}

On-premises gateway example

Beispielanforderung

HTTP

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

{
  "connectivityType": "OnPremisesGateway",
  "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
  "displayName": "ContosoOnPremisesConnection",
  "connectionDetails": {
    "type": "SQL",
    "creationMethod": "SQL",
    "parameters": [
      {
        "dataType": "Text",
        "name": "server",
        "value": "contoso.database.windows.net"
      },
      {
        "dataType": "Text",
        "name": "database",
        "value": "sales"
      }
    ]
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false,
    "credentials": {
      "credentialType": "Windows",
      "values": [
        {
          "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
          "encryptedCredentials": "************************************"
        },
        {
          "gatewayId": "55226bab-5024-4b72-9716-6dc8ef3a97fe",
          "encryptedCredentials": "************************************"
        }
      ]
    }
  }
}

Beispiel für eine Antwort

Statuscode:: 201

{
  "id": "eeec9a3a-6ef5-4e2b-bb6a-0060bd2f0172",
  "displayName": "ContosoOnPremisesConnection",
  "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
  "connectivityType": "OnPremisesGateway",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;sales"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  }
}

Virtual network gateway example

Beispielanforderung

HTTP

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

{
  "connectivityType": "VirtualNetworkGateway",
  "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
  "displayName": "ContosoVirtualNetworkGatewayConnection",
  "connectionDetails": {
    "type": "SQL",
    "creationMethod": "SQL",
    "parameters": [
      {
        "dataType": "Text",
        "name": "server",
        "value": "contoso.database.windows.net"
      },
      {
        "dataType": "Text",
        "name": "database",
        "value": "sales"
      }
    ]
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "singleSignOnType": "None",
    "connectionEncryption": "Encrypted",
    "skipTestConnection": false,
    "credentials": {
      "credentialType": "Basic",
      "username": "admin",
      "password": "*********"
    }
  }
}

Beispiel für eine Antwort

Statuscode:: 201

{
  "id": "eeec9a3a-6ef5-4e2b-bb6a-0060bd2f0172",
  "displayName": "ContosoVirtualNetworkGatewayConnection",
  "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
  "connectivityType": "VirtualNetworkGateway",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;sales"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "Encrypted",
    "skipTestConnection": false
  }
}

Definitionen

Name	Beschreibung
AnonymousCredentials	Anmeldeinformationen für anonymen Anmeldeinformationstyp.
BasicCredentials	Anmeldeinformationen für Basic CredentialType.
ConnectionDetailsBooleanParameter	ConnectionDetailsParameter für booleschen DataType.
ConnectionDetailsDateParameter	ConnectionDetailsParameter für date dataType.
ConnectionDetailsDateTimeParameter	ConnectionDetailsParameter für dateTime dataType.
ConnectionDetailsDateTimeZoneParameter	ConnectionDetailsParameter für dateTimeZone dataType.
ConnectionDetailsDurationParameter	ConnectionDetailsParameter für duration dataType.
ConnectionDetailsNumberParameter	ConnectionDetailsParameter für Zahlendatentyp.
ConnectionDetailsTextParameter	ConnectionDetailsParameter für Text dataType.
ConnectionDetailsTimeParameter	ConnectionDetailsParameter für time dataType.
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.
CreateCloudConnectionRequest
CreateConnectionDetails	Die Verbindungsdetails-Eingabe für Erstellungsvorgänge.
CreateCredentialDetails	Die Eingabe der Anmeldeinformationen zum Erstellen einer Verbindung.
CreateOnPremisesConnectionRequest
CreateOnPremisesCredentialDetails	Die Eingabe der Anmeldeinformationen zum Erstellen einer lokalen Gatewayverbindung.
CreateVirtualNetworkGatewayConnectionRequest
CredentialType	Der Anmeldeinformationstyp der Verbindung. Zusätzliche Anmeldeinformationstypen können im Laufe der Zeit hinzugefügt werden.
DataType	Der Datentyp des Parameterwerts für die Verbindungserstellung. Zusätzliche Datentypwerte können im Laufe der Zeit hinzugefügt werden.
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
KeyCredentials	Anmeldeinformationen für Key CredentialType.
ListConnectionDetails	Die Ausgabe der Verbindungsdetails für Listenvorgänge.
ListCredentialDetails	Die Beim Abrufen einer Verbindung zurückgegebenen Anmeldeinformationen.
OnPremisesCredentialEntry	Eine Gateway-ID und ihre verschlüsselten serialisierten Anmeldeinformationen.
OnPremisesGatewayConnection	Eine Verbindung, die über das lokale Datengateway eine Verbindung herstellt.
OnPremisesGatewayCredentials	Anmeldeinformationen für die Authentifizierung über ein lokales Gateway.
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.
ServicePrincipalCredentials	Anmeldeinformationen für ServicePrincipal CredentialType.
ShareableCloudConnection	Eine Verbindung, die über die Cloud verbunden ist.
SharedAccessSignatureCredentials	Anmeldeinformationen für SharedAccessSignature CredentialType.
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.
WindowsCredentials	Anmeldeinformationen für Windows CredentialType.
WindowsWithoutImpersonationCredentials	Anmeldeinformationen für WindowsWithoutImpersonation CredentialType.
WorkspaceIdentityCredentials	Anmeldeinformationen für WorkspaceIdentity CredentialType.

AnonymousCredentials

Objekt

Anmeldeinformationen für anonymen Anmeldeinformationstyp.

Name	Typ	Beschreibung
credentialType	string: Anonymous	Der Anmeldeinformationstyp der Verbindung.

BasicCredentials

Objekt

Anmeldeinformationen für Basic CredentialType.

Name	Typ	Beschreibung
credentialType	string: Basic	Der Anmeldeinformationstyp der Verbindung.
password	string	Das Kennwort.
username	string	Benutzername

ConnectionDetailsBooleanParameter

Objekt

ConnectionDetailsParameter für booleschen DataType.

Name	Typ	Beschreibung
dataType	string: Boolean	Der Datentyp des Parameters.
name	string	Der Name des Parameters.
value	boolean	Der boolesche Wert.

ConnectionDetailsDateParameter

Objekt

ConnectionDetailsParameter für date dataType.

Name	Typ	Beschreibung
dataType	string: Date	Der Datentyp des Parameters.
name	string	Der Name des Parameters.
value	string (date)	Der Datumswert mit dem Format JJJJ-MM-DD.

ConnectionDetailsDateTimeParameter

Objekt

ConnectionDetailsParameter für dateTime dataType.

Name	Typ	Beschreibung
dataType	string: DateTime	Der Datentyp des Parameters.
name	string	Der Name des Parameters.
value	string (date-time)	Der Datumszeitwert mit JJJJ-MM-DDTHH:mm:ss. FFFZ-Format.

ConnectionDetailsDateTimeZoneParameter

Objekt

ConnectionDetailsParameter für dateTimeZone dataType.

Name	Typ	Beschreibung
dataType	string: DateTimeZone	Der Datentyp des Parameters.
name	string	Der Name des Parameters.
value	string (date-time-offset)	Der Datums-Zeitzonenwert mit JJJJ-MM-DDTHH:mm:ss. FFF±h:mm-Format.

ConnectionDetailsDurationParameter

Objekt

ConnectionDetailsParameter für duration dataType.

Name	Typ	Beschreibung
dataType	string: Duration	Der Datentyp des Parameters.
name	string	Der Name des Parameters.
value	string (time-span)	Der Dauerwert mit dem Format %P(n)DT(n)H(n)M(n)S. Beispiel: P3DT4H30M10S (3 Tage, 4 Stunden, 30 Minuten und 10 Sekunden).

ConnectionDetailsNumberParameter

Objekt

ConnectionDetailsParameter für Zahlendatentyp.

Name	Typ	Beschreibung
dataType	string: Number	Der Datentyp des Parameters.
name	string	Der Name des Parameters.
value	number	Der Zahlenwert.

ConnectionDetailsTextParameter

Objekt

ConnectionDetailsParameter für Text dataType.

Name	Typ	Beschreibung
dataType	string: Text	Der Datentyp des Parameters.
name	string	Der Name des Parameters.
value	string	Der Textwert.

ConnectionDetailsTimeParameter

Objekt

ConnectionDetailsParameter für time dataType.

Name	Typ	Beschreibung
dataType	string: Time	Der Datentyp des Parameters.
name	string	Der Name des Parameters.
value	string (time)	Der Zeitwert mit HH:mm:ss. FFFZ-Format.

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.

CreateCloudConnectionRequest

Objekt

Name	Typ	Beschreibung
allowConnectionUsageInGateway	boolean	Zulassen, dass diese Verbindung entweder mit lokalen Datengateways oder VNet-Datengateways verwendet wird.
connectionDetails	CreateConnectionDetails	Die Verbindungsdetails der Verbindung.
connectivityType	string: ShareableCloud	Der Verbindungstyp der Verbindung.
credentialDetails	CreateCredentialDetails	Die Anmeldeinformationen der Verbindung.
displayName	string	Der Anzeigename der Verbindung. Die maximale Länge beträgt 200 Zeichen.
privacyLevel	PrivacyLevel	(Optional) Die Datenschutzstufe der Verbindung. Wenn kein Wert übergeben wird, wird dieser wert auf "Organizational" festgelegt.

CreateConnectionDetails

Objekt

Die Verbindungsdetails-Eingabe für Erstellungsvorgänge.

Name	Typ	Beschreibung
creationMethod	string	Die Erstellungsmethode, die zum Erstellen der Verbindung verwendet wird. Verwenden Sie für eine Liste der Erstellungsmethoden die ListSupportedConnectionTypes-API .
parameters	ConnectionDetailsParameter[]: ConnectionDetailsBooleanParameter[] ConnectionDetailsDateParameter[] ConnectionDetailsDateTimeParameter[] ConnectionDetailsDateTimeZoneParameter[] ConnectionDetailsDurationParameter[] ConnectionDetailsNumberParameter[] ConnectionDetailsTextParameter[] ConnectionDetailsTimeParameter[]	Die Liste der Verbindungsparameter. Verwenden Sie für eine Liste der Parameter für jede Erstellungsmethode die ListSupportedConnectionTypes-API .
type	string	Der Typ der Verbindung.

CreateCredentialDetails

Objekt

Die Eingabe der Anmeldeinformationen zum Erstellen einer Verbindung.

Name	Typ	Beschreibung
connectionEncryption	ConnectionEncryption	(Optional) Die Verbindungsverschlüsselungseinstellung, die während der Testverbindung verwendet wird. Wenn kein Wert übergeben wird, wird die Verbindung nicht verschlüsselt.
credentials	Credentials: AnonymousCredentials BasicCredentials KeyCredentials ServicePrincipalCredentials SharedAccessSignatureCredentials WindowsCredentials WindowsWithoutImpersonationCredentials WorkspaceIdentityCredentials	Die Anmeldeinformationen der Verbindung.
singleSignOnType	SingleSignOnType	(Optional) Der Single Sign-On-Typ der Verbindung. Wenn kein Wert übergeben wird, verwendet die Verbindung kein einmaliges Anmelden.
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. Wenn kein Wert übergeben wird, wird dies auf "False" festgelegt.

CreateOnPremisesConnectionRequest

Objekt

Name	Typ	Beschreibung
connectionDetails	CreateConnectionDetails	Die Verbindungsdetails der Verbindung.
connectivityType	string: OnPremisesGateway	Der Verbindungstyp der Verbindung.
credentialDetails	CreateOnPremisesCredentialDetails	Die Anmeldeinformationen der Verbindung.
displayName	string	Der Anzeigename der Verbindung. Die maximale Länge beträgt 200 Zeichen.
gatewayId	string (uuid)	Die Objekt-ID des primären Gateways des lokalen Gateways, unter dem die Verbindung erstellt wird.
privacyLevel	PrivacyLevel	(Optional) Die Datenschutzstufe der Verbindung. Wenn kein Wert übergeben wird, wird dieser wert auf "Organizational" festgelegt.

CreateOnPremisesCredentialDetails

Objekt

Die Eingabe der Anmeldeinformationen zum Erstellen einer lokalen Gatewayverbindung.

Name	Typ	Beschreibung
connectionEncryption	ConnectionEncryption	(Optional) Die Verbindungsverschlüsselungseinstellung, die während der Testverbindung verwendet wird. Wenn kein Wert übergeben wird, wird die Verbindung nicht verschlüsselt.
credentials	OnPremisesGatewayCredentials	Die Anmeldeinformationen der Verbindung.
singleSignOnType	SingleSignOnType	(Optional) Der Single Sign-On-Typ der Verbindung. Wenn kein Wert übergeben wird, verwendet die Verbindung kein einmaliges Anmelden.
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. Wenn kein Wert übergeben wird, wird dies auf "False" festgelegt.

CreateVirtualNetworkGatewayConnectionRequest

Objekt

Name	Typ	Beschreibung
connectionDetails	CreateConnectionDetails	Die Verbindungsdetails der Verbindung.
connectivityType	string: VirtualNetworkGateway	Der Verbindungstyp der Verbindung.
credentialDetails	CreateCredentialDetails	Die Anmeldeinformationen der Verbindung.
displayName	string	Der Anzeigename der Verbindung. Die maximale Länge beträgt 200 Zeichen.
gatewayId	string (uuid)	Die Objekt-ID des virtuellen Netzwerkgateways, unter dem die Verbindung erstellt wird.
privacyLevel	PrivacyLevel	(Optional) Die Datenschutzstufe der Verbindung. Wenn kein Wert übergeben wird, wird dieser wert auf "Organizational" festgelegt.

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.

DataType

Enumeration

Der Datentyp des Parameterwerts für die Verbindungserstellung. Zusätzliche Datentypwerte können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Text	Verwenden Sie Text als Parametereingabewert.
Number	Verwenden Sie die Zahl als Parametereingabewert (ganze Zahl oder Gleitkomma).
Boolean	Verwenden Sie boolescher Wert als Parametereingabewert. False - der Wert ist false, True - der Wert ist wahr.
Duration	Verwenden Sie die Dauer als Parametereingabewert unter Verwendung des Formats %%amp;quot;P(n)DT(n)H(n)M(n)S%%amp;quot;. Beispiel: P3DT4H30M10S (3 Tage, 4 Stunden, 30 Minuten und 10 Sekunden).
Date	Verwenden Sie das Datum als Eingabewert des Parameters, indem Sie das Format JJJJ-MM-DD verwenden.
DateTime	Verwenden Sie Datumszeit als Eingabewert des Parameters, wobei JJJJ-MM-DDTHH:mm:ss verwendet wird. FFFZ-Format.
DateTimeZone	Verwenden Sie die Datumstimezone als Parametereingabewert unter Verwendung von JJJJ-MM-DDTHH:mm:ss. FFF±h:mm-Format.
Time	Verwenden Sie die Zeit als Parametereingabewert unter Verwendung von HH:mm:ss. FFFZ-Format.

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.
message	string	Eine lesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string	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.

KeyCredentials

Objekt

Anmeldeinformationen für Key CredentialType.

Name	Typ	Beschreibung
credentialType	string: Key	Der Anmeldeinformationstyp der Verbindung.
key	string	Der Schlüssel.

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.

OnPremisesCredentialEntry

Objekt

Eine Gateway-ID und ihre verschlüsselten serialisierten Anmeldeinformationen.

Name	Typ	Beschreibung
encryptedCredentials	string	Die verschlüsselte serialisierte .json der Liste der Namenswertpaare. Der Name ist ein Anmeldeinformationsname und -wert ist ein Anmeldeinformationswert. Verschlüsselung wird mit dem Rsa-Verschlüsselungsalgorithmus (Rivest-Shamir-Adleman) mit dem öffentlichen Schlüssel des lokalen Gatewaymitglieds durchgeführt.
gatewayId	string (uuid)	Die Objekt-ID des Gateways.

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.

OnPremisesGatewayCredentials

Objekt

Anmeldeinformationen für die Authentifizierung über ein lokales Gateway.

Name	Typ	Beschreibung
credentialType	CredentialType	Der Anmeldeinformationstyp der Verbindung.
values	OnPremisesCredentialEntry[]	Die Nutzlast der Anmeldeinformationen, die an das lokale Gateway gesendet werden sollen.

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.

ServicePrincipalCredentials

Objekt

Anmeldeinformationen für ServicePrincipal CredentialType.

Name	Typ	Beschreibung
credentialType	string: ServicePrincipal	Der Anmeldeinformationstyp der Verbindung.
servicePrincipalClientId	string (uuid)	Die Client-ID des Dienstprinzipals.
servicePrincipalSecret	string	Der geheime Schlüssel des Dienstprinzipals.
tenantId	string (uuid)	Die Mandanten-ID des Dienstprinzipals.

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

SharedAccessSignatureCredentials

Objekt

Anmeldeinformationen für SharedAccessSignature CredentialType.

Name	Typ	Beschreibung
credentialType	string: SharedAccessSignature	Der Anmeldeinformationstyp der Verbindung.
token	string	Das Token.

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.

WindowsCredentials

Objekt

Anmeldeinformationen für Windows CredentialType.

Name	Typ	Beschreibung
credentialType	string: Windows	Der Anmeldeinformationstyp der Verbindung.
password	string	Das Kennwort.
username	string	Benutzername

WindowsWithoutImpersonationCredentials

Objekt

Anmeldeinformationen für WindowsWithoutImpersonation CredentialType.

Name	Typ	Beschreibung
credentialType	string: WindowsWithoutImpersonation	Der Anmeldeinformationstyp der Verbindung.

WorkspaceIdentityCredentials

Objekt

Anmeldeinformationen für WorkspaceIdentity CredentialType.

Name	Typ	Beschreibung
credentialType	string: WorkspaceIdentity	Der Anmeldeinformationstyp der Verbindung.

Freigeben über

Connections - Create Connection

Permissions

Erforderliche delegierte Bereiche

Von Microsoft Entra unterstützte Identitäten

Interface

Anforderungstext

CreateCloudConnectionRequest

CreateOnPremisesConnectionRequest

CreateVirtualNetworkGatewayConnectionRequest

Antworten

Beispiele

Cloud example

Beispielanforderung

Beispiel für eine Antwort

On-premises gateway example

Beispielanforderung

Beispiel für eine Antwort

Virtual network gateway example

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AnonymousCredentials

BasicCredentials

ConnectionDetailsBooleanParameter

ConnectionDetailsDateParameter

ConnectionDetailsDateTimeParameter

ConnectionDetailsDateTimeZoneParameter

ConnectionDetailsDurationParameter

ConnectionDetailsNumberParameter

ConnectionDetailsTextParameter

ConnectionDetailsTimeParameter

ConnectionEncryption

ConnectivityType

CreateCloudConnectionRequest

CreateConnectionDetails

CreateCredentialDetails

CreateOnPremisesConnectionRequest

CreateOnPremisesCredentialDetails

CreateVirtualNetworkGatewayConnectionRequest

CredentialType

DataType

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

KeyCredentials

ListConnectionDetails

ListCredentialDetails

OnPremisesCredentialEntry

OnPremisesGatewayConnection

OnPremisesGatewayCredentials

OnPremisesGatewayPersonalConnection

PersonalCloudConnection

PrivacyLevel

ServicePrincipalCredentials

ShareableCloudConnection

SharedAccessSignatureCredentials

SingleSignOnType

VirtualNetworkGatewayConnection

WindowsCredentials

WindowsWithoutImpersonationCredentials

WorkspaceIdentityCredentials