Connections - Create Connection

Service:: Core

Version d'API:: v1

Crée une connexion.
Pour chiffrer les informations d’identification, consultez Configurer les informations d’identification par programmation.

Permissions

Si vous créez une connexion de passerelle, l’appelant doit disposer d’autorisations pour la passerelle.
Les principaux de service doivent disposer d’autorisations accordées par l’administrateur Fabric. Pour plus d’informations, consultez : les principaux de service peuvent créer des espaces de travail, des connexions et des pipelines de déploiement.

Étendues déléguées requises

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.

Identity	Support
User	Yes
principal de service et identités managées	Yes

Interface

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

Corps de la demande

Le corps de la requête peut être l’un des suivants :

Nom	Description
CreateCloudConnectionRequest
CreateOnPremisesConnectionRequest
CreateVirtualNetworkGatewayConnectionRequest

CreateCloudConnectionRequest

Nom	Obligatoire	Type	Description
connectionDetails	True	CreateConnectionDetails	Détails de connexion de la connexion.
connectivityType	True	string: ShareableCloud	Type de connectivité de la connexion.
credentialDetails	True	CreateCredentialDetails	Détails des informations d’identification de la connexion.
displayName	True	string	Nom complet de la connexion. La longueur maximale est de 200 caractères.
allowConnectionUsageInGateway		boolean	Autorisez cette connexion à utiliser avec des passerelles de données locales ou des passerelles de données de réseau virtuel.
privacyLevel		PrivacyLevel	(Facultatif) Niveau de confidentialité de la connexion. Lorsqu’aucune valeur n’est passée, elle est définie sur « Organisation ».

CreateOnPremisesConnectionRequest

Nom	Obligatoire	Type	Description
connectionDetails	True	CreateConnectionDetails	Détails de connexion de la connexion.
connectivityType	True	string: OnPremisesGateway	Type de connectivité de la connexion.
credentialDetails	True	CreateOnPremisesCredentialDetails	Détails des informations d’identification de la connexion.
displayName	True	string	Nom complet de la connexion. La longueur maximale est de 200 caractères.
gatewayId	True	string (uuid)	ID d’objet de la passerelle principale de la passerelle locale sous laquelle la connexion est créée.
privacyLevel		PrivacyLevel	(Facultatif) Niveau de confidentialité de la connexion. Lorsqu’aucune valeur n’est passée, elle est définie sur « Organisation ».

CreateVirtualNetworkGatewayConnectionRequest

Nom	Obligatoire	Type	Description
connectionDetails	True	CreateConnectionDetails	Détails de connexion de la connexion.
connectivityType	True	string: VirtualNetworkGateway	Type de connectivité de la connexion.
credentialDetails	True	CreateCredentialDetails	Détails des informations d’identification de la connexion.
displayName	True	string	Nom complet de la connexion. La longueur maximale est de 200 caractères.
gatewayId	True	string (uuid)	ID d’objet de la passerelle de réseau virtuel sous laquelle la connexion est créée.
privacyLevel		PrivacyLevel	(Facultatif) Niveau de confidentialité de la connexion. Lorsqu’aucune valeur n’est passée, elle est définie sur « Organisation ».

Réponses

Nom	Type	Description
201 Created	Connection: ShareableCloudConnection PersonalCloudConnection OnPremisesGatewayConnection OnPremisesGatewayPersonalConnection VirtualNetworkGatewayConnection	Created. L’opération a réussi.
Other Status Codes	ErrorResponse	Codes d’erreur courants : DuplicateConnectionName : le nom de connexion est déjà utilisé. InvalidConnectionDetails : l’entrée ConnectionDetails fournie n’est pas valide. InvalidCredentialDetails : l’entrée CredentialDetails fournie n’est pas valide. IncorrectCredentials : échec de l’établissement d’une connexion à l’aide de l’entrée Credentials. CreateGatewayConnectionFailed : échec de la création d’une connexion de passerelle.

Nom

Type

Description

201 Created

Connection:

ShareableCloudConnection
PersonalCloudConnection
OnPremisesGatewayConnection
OnPremisesGatewayPersonalConnection
VirtualNetworkGatewayConnection

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

Other Status Codes

ErrorResponse

Codes d’erreur courants :

DuplicateConnectionName : le nom de connexion est déjà utilisé.
InvalidConnectionDetails : l’entrée ConnectionDetails fournie n’est pas valide.
InvalidCredentialDetails : l’entrée CredentialDetails fournie n’est pas valide.
IncorrectCredentials : échec de l’établissement d’une connexion à l’aide de l’entrée Credentials.
CreateGatewayConnectionFailed : échec de la création d’une connexion de passerelle.

Exemples

Cloud example

Cloud example with KeyPair credentials

On-premises gateway example

Virtual network gateway example

Cloud example

Exemple de requête

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",
      "passwordReference": {
        "connectionId": "4399ab2c-7551-4c0e-8aa7-18fc2f217626",
        "secretName": "some-secret"
      }
    }
  }
}

Exemple de réponse

Code d’état:: 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
  }
}

Cloud example with KeyPair credentials

Exemple de requête

HTTP

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

{
  "connectivityType": "ShareableCloud",
  "displayName": "SnowflakeCloudConnection",
  "connectionDetails": {
    "type": "SQL",
    "creationMethod": "SQL",
    "parameters": [
      {
        "dataType": "Text",
        "name": "server",
        "value": "contoso.database.windows.net"
      },
      {
        "dataType": "Text",
        "name": "warehouse",
        "value": "snowflake-warehouse"
      }
    ]
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false,
    "credentials": {
      "credentialType": "KeyPair",
      "identifier": "admin",
      "privateKey": "-----BEGIN ENCRYPTED PRIVATE KEY-----\\nMIIEvQIBADANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQ...\\n-----END ENCRYPTED PRIVATE KEY-----",
      "passphrase": "********"
    }
  }
}

Exemple de réponse

Code d’état:: 201

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

On-premises gateway example

Exemple de requête

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": "************************************"
        }
      ]
    }
  }
}

Exemple de réponse

Code d’état:: 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

Exemple de requête

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": "*********"
    }
  }
}

Exemple de réponse

Code d’état:: 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
  }
}

Définitions

Nom	Description
AnonymousCredentials	Informations d’identification pour CredentialType anonyme.
BasicCredentials	Informations d’identification pour CredentialType de base.
ConnectionDetailsBooleanParameter	ConnectionDetailsParameter pour dataType booléen.
ConnectionDetailsDateParameter	ConnectionDetailsParameter pour date dataType.
ConnectionDetailsDateTimeParameter	ConnectionDetailsParameter pour dateTime dataType.
ConnectionDetailsDateTimeZoneParameter	ConnectionDetailsParameter pour dateTimeZone dataType.
ConnectionDetailsDurationParameter	ConnectionDetailsParameter pour la durée dataType.
ConnectionDetailsNumberParameter	ConnectionDetailsParameter pour number dataType.
ConnectionDetailsTextParameter	ConnectionDetailsParameter pour text dataType.
ConnectionDetailsTimeParameter	ConnectionDetailsParameter pour time dataType.
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.
CreateCloudConnectionRequest
CreateConnectionDetails	Entrée des détails de connexion pour les opérations de création.
CreateCredentialDetails	Entrée des informations d’identification pour la création d’une connexion.
CreateOnPremisesConnectionRequest
CreateOnPremisesCredentialDetails	Entrée des informations d’identification pour la création d’une connexion de passerelle locale.
CreateVirtualNetworkGatewayConnectionRequest
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.
DataType	Type de données de la valeur du paramètre de création de connexion. Des valeurs de type de données supplémentaires peuvent être ajoutées 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.
KeyCredentials	Informations d’identification pour Key CredentialType.
KeyPairCredentials	Informations d’identification pour KeyPair CredentialType.
KeyVaultSecretReference	Référence à un secret stocké dans Azure Key Vault.
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.
OnPremisesCredentialEntry	ID de passerelle et ses informations d’identification sérialisées chiffrées.
OnPremisesGatewayConnection	Connexion qui se connecte via une passerelle de données locale.
OnPremisesGatewayCredentials	Informations d’identification pour l’authentification via une passerelle 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.
ServicePrincipalCredentials	Informations d’identification pour ServicePrincipal CredentialType.
ShareableCloudConnection	Connexion qui se connecte via le cloud.
SharedAccessSignatureCredentials	Informations d’identification pour SharedAccessSignature CredentialType.
SingleSignOnType	Type d’authentification unique de la connexion. Des types d’authentification unique supplémentaires peuvent être ajoutés au fil du temps.
VirtualNetworkGatewayConnection	Connexion qui se connecte via une passerelle de données de réseau virtuel.
WindowsCredentials	Informations d’identification pour Windows CredentialType.
WindowsWithoutImpersonationCredentials	Informations d’identification pour WindowsWithoutImpersonation CredentialType.
WorkspaceIdentityCredentials	Informations d’identification pour WorkspaceIdentity CredentialType.

AnonymousCredentials

Objet

Informations d’identification pour CredentialType anonyme.

Nom	Type	Description
credentialType	string: Anonymous	Type d’informations d’identification de la connexion.

BasicCredentials

Objet

Informations d’identification pour CredentialType de base.

Nom	Type	Description
credentialType	string: Basic	Type d’informations d’identification de la connexion.
password	string	Mot de passe. Utilisez le mot de passe ou passwordReference. Vous ne pouvez pas utiliser les deux en même temps
passwordReference	KeyVaultSecretReference	Référence à un mot de passe stocké dans Azure Key Vault. Utilisez le mot de passe ou passwordReference. Vous ne pouvez pas utiliser les deux en même temps.
username	string	Le nom d’utilisateur.

ConnectionDetailsBooleanParameter

Objet

ConnectionDetailsParameter pour dataType booléen.

Nom	Type	Description
dataType	string: Boolean	Type de données du paramètre.
name	string	Nom du paramètre.
value	boolean	Valeur booléenne.

ConnectionDetailsDateParameter

Objet

ConnectionDetailsParameter pour date dataType.

Nom	Type	Description
dataType	string: Date	Type de données du paramètre.
name	string	Nom du paramètre.
value	string (date)	Valeur de date utilisant le format aaaa-MM-DD.

ConnectionDetailsDateTimeParameter

Objet

ConnectionDetailsParameter pour dateTime dataType.

Nom	Type	Description
dataType	string: DateTime	Type de données du paramètre.
name	string	Nom du paramètre.
value	string (date-time)	Valeur d’heure de date à l’aide de AAAA-MM-DDTHH :mm :ss. Format FFFZ.

ConnectionDetailsDateTimeZoneParameter

Objet

ConnectionDetailsParameter pour dateTimeZone dataType.

Nom	Type	Description
dataType	string: DateTimeZone	Type de données du paramètre.
name	string	Nom du paramètre.
value	string (date-time-offset)	Valeur du fuseau horaire de date à l’aide de AAAA-MM-DDTHH :mm :ss. Format FFF±hh :mm.

ConnectionDetailsDurationParameter

Objet

ConnectionDetailsParameter pour la durée dataType.

Nom	Type	Description
dataType	string: Duration	Type de données du paramètre.
name	string	Nom du paramètre.
value	string (time-span)	Valeur de durée utilisant le format [-]P(n)DT(n)H(n)M(n)S. Par exemple : P3DT4H30M10S (pendant 3 jours, 4 heures, 30 minutes et 10 secondes).

ConnectionDetailsNumberParameter

Objet

ConnectionDetailsParameter pour number dataType.

Nom	Type	Description
dataType	string: Number	Type de données du paramètre.
name	string	Nom du paramètre.
value	number	Valeur numérique.

ConnectionDetailsTextParameter

Objet

ConnectionDetailsParameter pour text dataType.

Nom	Type	Description
dataType	string: Text	Type de données du paramètre.
name	string	Nom du paramètre.
value	string	Valeur du texte.

ConnectionDetailsTimeParameter

Objet

ConnectionDetailsParameter pour time dataType.

Nom	Type	Description
dataType	string: Time	Type de données du paramètre.
name	string	Nom du paramètre.
value	string (time)	Valeur de temps à l’aide de HH :mm :ss. Format FFFZ.

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.

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

CreateCloudConnectionRequest

Objet

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	CreateConnectionDetails	Détails de connexion de la connexion.
connectivityType	string: ShareableCloud	Type de connectivité de la connexion.
credentialDetails	CreateCredentialDetails	Détails des informations d’identification de la connexion.
displayName	string	Nom complet de la connexion. La longueur maximale est de 200 caractères.
privacyLevel	PrivacyLevel	(Facultatif) Niveau de confidentialité de la connexion. Lorsqu’aucune valeur n’est passée, elle est définie sur « Organisation ».

CreateConnectionDetails

Objet

Entrée des détails de connexion pour les opérations de création.

Nom	Type	Description
creationMethod	string	Méthode de création utilisée pour créer la connexion. Pour obtenir la liste des méthodes de création, utilisez l’API ListSupportedConnectionTypes .
parameters	ConnectionDetailsParameter[]: ConnectionDetailsBooleanParameter[] ConnectionDetailsDateParameter[] ConnectionDetailsDateTimeParameter[] ConnectionDetailsDateTimeZoneParameter[] ConnectionDetailsDurationParameter[] ConnectionDetailsNumberParameter[] ConnectionDetailsTextParameter[] ConnectionDetailsTimeParameter[]	Liste des paramètres de connexion. Pour obtenir la liste des paramètres de chaque méthode de création, utilisez l’API ListSupportedConnectionTypes .
type	string	Type de connexion.

CreateCredentialDetails

Objet

Entrée des informations d’identification pour la création d’une connexion.

Nom	Type	Description
connectionEncryption	ConnectionEncryption	(Facultatif) Paramètre de chiffrement de connexion utilisé pendant la connexion de test. Lorsqu’aucune valeur n’est passée, la connexion n’est pas chiffrée.
credentials	Credentials: AnonymousCredentials BasicCredentials KeyCredentials KeyPairCredentials ServicePrincipalCredentials SharedAccessSignatureCredentials WindowsCredentials WindowsWithoutImpersonationCredentials WorkspaceIdentityCredentials	Informations d’identification de la connexion.
singleSignOnType	SingleSignOnType	(Facultatif) Type d’authentification unique de la connexion. Quand aucune valeur n’est passée, la connexion n’utilise pas l’authentification unique.
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. Lorsqu’aucune valeur n’est passée, cette valeur est définie sur « False ».

CreateOnPremisesConnectionRequest

Objet

Nom	Type	Description
connectionDetails	CreateConnectionDetails	Détails de connexion de la connexion.
connectivityType	string: OnPremisesGateway	Type de connectivité de la connexion.
credentialDetails	CreateOnPremisesCredentialDetails	Détails des informations d’identification de la connexion.
displayName	string	Nom complet de la connexion. La longueur maximale est de 200 caractères.
gatewayId	string (uuid)	ID d’objet de la passerelle principale de la passerelle locale sous laquelle la connexion est créée.
privacyLevel	PrivacyLevel	(Facultatif) Niveau de confidentialité de la connexion. Lorsqu’aucune valeur n’est passée, elle est définie sur « Organisation ».

CreateOnPremisesCredentialDetails

Objet

Entrée des informations d’identification pour la création d’une connexion de passerelle locale.

Nom	Type	Description
connectionEncryption	ConnectionEncryption	(Facultatif) Paramètre de chiffrement de connexion utilisé pendant la connexion de test. Lorsqu’aucune valeur n’est passée, la connexion n’est pas chiffrée.
credentials	OnPremisesGatewayCredentials	Informations d’identification de la connexion.
singleSignOnType	SingleSignOnType	(Facultatif) Type d’authentification unique de la connexion. Quand aucune valeur n’est passée, la connexion n’utilise pas l’authentification unique.
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. Lorsqu’aucune valeur n’est passée, cette valeur est définie sur « False ».

CreateVirtualNetworkGatewayConnectionRequest

Objet

Nom	Type	Description
connectionDetails	CreateConnectionDetails	Détails de connexion de la connexion.
connectivityType	string: VirtualNetworkGateway	Type de connectivité de la connexion.
credentialDetails	CreateCredentialDetails	Détails des informations d’identification de la connexion.
displayName	string	Nom complet de la connexion. La longueur maximale est de 200 caractères.
gatewayId	string (uuid)	ID d’objet de la passerelle de réseau virtuel sous laquelle la connexion est créée.
privacyLevel	PrivacyLevel	(Facultatif) Niveau de confidentialité de la connexion. Lorsqu’aucune valeur n’est passée, elle est définie sur « Organisation ».

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.

DataType

Énumération

Type de données de la valeur du paramètre de création de connexion. Des valeurs de type de données supplémentaires peuvent être ajoutées au fil du temps.

Valeur	Description
Text	Utilisez du texte comme valeur d’entrée de paramètre.
Number	Utilisez le nombre comme valeur d’entrée de paramètre (entier ou virgule flottante).
Boolean	Utilisez booléen comme valeur d’entrée de paramètre. False : la valeur est false, True : la valeur est true.
Duration	Utilisez la durée comme valeur d’entrée de paramètre, en utilisant le format [-]P(n)DT(n)H(n)M(n)S. Par exemple : P3DT4H30M10S (pendant 3 jours, 4 heures, 30 minutes et 10 secondes).
Date	Utilisez la date comme valeur d’entrée de paramètre, à l’aide du format aaaa-MM-DD.
DateTime	Utilisez l’heure de date comme valeur d’entrée de paramètre, à l’aide de AAAA-MM-DDTHH :mm :ss. Format FFFZ.
DateTimeZone	Utilisez le fuseau horaire de date comme valeur d’entrée de paramètre, à l’aide de AAAA-MM-DDTHH :mm :ss. Format FFF±hh :mm.
Time	Utilisez l’heure comme valeur d’entrée de paramètre, à l’aide de HH :mm :ss. Format FFFZ.

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

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

KeyCredentials

Objet

Informations d’identification pour Key CredentialType.

Nom	Type	Description
credentialType	string: Key	Type d’informations d’identification de la connexion.
key	string	La clé. Utilisez la clé ou keyReference. Vous ne pouvez pas utiliser les deux en même temps.
keyReference	KeyVaultSecretReference	Référence à une clé stockée dans Azure Key Vault. Utilisez la clé ou keyReference. Vous ne pouvez pas utiliser les deux en même temps.

KeyPairCredentials

Objet

Informations d’identification pour KeyPair CredentialType.

Nom	Type	Description
credentialType	string: KeyPair	Type d’informations d’identification de la connexion.
identifier	string	Identificateur de la clé.
passphrase	string	Phrase secrète pour la clé privée si la clé privée est chiffrée.
privateKey	string	Clé privée basée sur la norme PKCS #8.

KeyVaultSecretReference

Objet

Référence à un secret stocké dans Azure Key Vault.

Nom	Type	Description
connectionId	string (uuid)	ID de connexion de la connexion Key Vault.
secretName	string	Nom du secret dans Key Vault.
version	string	Version du secret dans Key Vault.

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.

OnPremisesCredentialEntry

Objet

ID de passerelle et ses informations d’identification sérialisées chiffrées.

Nom	Type	Description
encryptedCredentials	string	Le .json sérialisé chiffré de la liste des paires valeur de nom. Le nom est un nom d’informations d’identification et la valeur est une valeur d’informations d’identification. Le chiffrement est effectué à l’aide de l’algorithme de chiffrement Rivest-Shamir-Adleman (RSA) avec la clé publique du membre de passerelle local.
gatewayId	string (uuid)	ID d’objet de la passerelle.

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.
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 de la connexion.
id	string (uuid)	ID d’objet de la connexion.
privacyLevel	PrivacyLevel	Niveau de confidentialité de la connexion.

OnPremisesGatewayCredentials

Objet

Informations d’identification pour l’authentification via une passerelle locale.

Nom	Type	Description
credentialType	CredentialType	Type d’informations d’identification de la connexion.
values	OnPremisesCredentialEntry[]	Charge utile des informations d’identification à envoyer à la passerelle locale.

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.
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 de la connexion.
id	string (uuid)	ID d’objet de la connexion.
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.
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.
id	string (uuid)	ID d’objet de la connexion.
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 approuvé.
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.

ServicePrincipalCredentials

Objet

Informations d’identification pour ServicePrincipal CredentialType.

Nom	Type	Description
credentialType	string: ServicePrincipal	Type d’informations d’identification de la connexion.
servicePrincipalClientId	string (uuid)	ID client du principal de service.
servicePrincipalSecret	string	Secret du principal de service. Utilisez servicePrincipalSecret ou servicePrincipalSecretReference. Vous ne pouvez pas utiliser les deux en même temps.
servicePrincipalSecretReference	KeyVaultSecretReference	Référence à un secret de principal de service stocké dans Azure Key Vault. Utilisez servicePrincipalSecret ou servicePrincipalSecretReference. Vous ne pouvez pas utiliser les deux en même temps.
tenantId	string (uuid)	ID de locataire du principal de service.

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.
connectionDetails	ListConnectionDetails	Détails de connexion de 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.
id	string (uuid)	ID d’objet de la connexion.
privacyLevel	PrivacyLevel	Niveau de confidentialité de la connexion.

SharedAccessSignatureCredentials

Objet

Informations d’identification pour SharedAccessSignature CredentialType.

Nom	Type	Description
credentialType	string: SharedAccessSignature	Type d’informations d’identification de la connexion.
token	string	Jeton. Utilisez le jeton ou tokenReference. Vous ne pouvez pas utiliser les deux en même temps.
tokenReference	KeyVaultSecretReference	Référence à un jeton stocké dans Azure Key Vault. Utilisez le jeton ou tokenReference. Vous ne pouvez pas utiliser les deux en même temps.

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.

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.
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 de la connexion.
id	string (uuid)	ID d’objet de la connexion.
privacyLevel	PrivacyLevel	Niveau de confidentialité de la connexion.

WindowsCredentials

Objet

Informations d’identification pour Windows CredentialType.

Nom	Type	Description
credentialType	string: Windows	Type d’informations d’identification de la connexion.
password	string	Mot de passe.
username	string	Le nom d’utilisateur.

WindowsWithoutImpersonationCredentials

Objet

Informations d’identification pour WindowsWithoutImpersonation CredentialType.

Nom	Type	Description
credentialType	string: WindowsWithoutImpersonation	Type d’informations d’identification de la connexion.

WorkspaceIdentityCredentials

Objet

Informations d’identification pour WorkspaceIdentity CredentialType.

Nom	Type	Description
credentialType	string: WorkspaceIdentity	Type d’informations d’identification de la connexion.

Partager via

Connections - Create Connection

Permissions

Étendues déléguées requises

Identités prises en charge par Microsoft Entra

Interface

Corps de la demande

CreateCloudConnectionRequest

CreateOnPremisesConnectionRequest

CreateVirtualNetworkGatewayConnectionRequest

Réponses

Exemples

Cloud example

Exemple de requête

Exemple de réponse

Cloud example with KeyPair credentials

Exemple de requête

Exemple de réponse

On-premises gateway example

Exemple de requête

Exemple de réponse

Virtual network gateway example

Exemple de requête

Exemple de réponse

Définitions

AnonymousCredentials

BasicCredentials

ConnectionDetailsBooleanParameter

ConnectionDetailsDateParameter

ConnectionDetailsDateTimeParameter

ConnectionDetailsDateTimeZoneParameter

ConnectionDetailsDurationParameter

ConnectionDetailsNumberParameter

ConnectionDetailsTextParameter

ConnectionDetailsTimeParameter

ConnectionEncryption

ConnectivityType

CreateCloudConnectionRequest

CreateConnectionDetails

CreateCredentialDetails

CreateOnPremisesConnectionRequest

CreateOnPremisesCredentialDetails

CreateVirtualNetworkGatewayConnectionRequest

CredentialType

DataType

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

KeyCredentials

KeyPairCredentials

KeyVaultSecretReference

ListConnectionDetails

ListCredentialDetails

OnPremisesCredentialEntry

OnPremisesGatewayConnection

OnPremisesGatewayCredentials

OnPremisesGatewayPersonalConnection

PersonalCloudConnection

PrivacyLevel

ServicePrincipalCredentials

ShareableCloudConnection

SharedAccessSignatureCredentials

SingleSignOnType

VirtualNetworkGatewayConnection

WindowsCredentials

WindowsWithoutImpersonationCredentials

WorkspaceIdentityCredentials