Connections - Update Connection
Met à jour la connexion par ID.
Pour chiffrer les informations d’identification, consultez Configurer les informations d’identification par programmation.
Permissions
L’appelant doit avoir l’autorisation de connexion ou d’administrateur pour la passerelle de la connexion.
É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
PATCH https://api.fabric.microsoft.com/v1/connections/{connectionId}
Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
connection
|
path | True |
string (uuid) |
ID de la connexion. |
Corps de la demande
Le corps de la requête peut être l’un des suivants :
| Nom | Description |
|---|---|
|
Update |
|
|
Update |
|
|
Update |
|
|
Update |
|
|
Update |
Met à jour une connexion qui se connecte via une passerelle de données de réseau virtuel de streaming. |
|
Update |
UpdateOnPremisesGatewayConnectionRequest
| Nom | Obligatoire | Type | Description |
|---|---|---|---|
| connectivityType | True |
string:
On |
Type de connectivité de la connexion. |
| credentialDetails |
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 |
Niveau de confidentialité de la connexion. |
UpdateOnPremisesGatewayPersonalConnectionRequest
| Nom | Obligatoire | Type | Description |
|---|---|---|---|
| connectivityType | True |
string:
On |
Type de connectivité de la connexion. |
| credentialDetails |
Détails des informations d’identification de la connexion. |
||
| privacyLevel |
Niveau de confidentialité de la connexion. |
UpdatePersonalCloudConnectionRequest
| Nom | Obligatoire | Type | Description |
|---|---|---|---|
| connectivityType | True |
string:
Personal |
Type de connectivité de la connexion. |
| allowConnectionUsageInGateway |
boolean |
Autorisez cette connexion à utiliser avec des passerelles de données locales ou des passerelles de données de réseau virtuel. |
|
| credentialDetails |
Détails des informations d’identification de la connexion. |
||
| privacyLevel |
Niveau de confidentialité de la connexion. |
UpdateShareableCloudConnectionRequest
| Nom | Obligatoire | Type | Description |
|---|---|---|---|
| connectivityType | True |
string:
Shareable |
Type de connectivité de la connexion. |
| allowConnectionUsageInGateway |
boolean |
Autorisez cette connexion à utiliser avec des passerelles de données locales ou des passerelles de données de réseau virtuel. |
|
| credentialDetails |
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 |
Niveau de confidentialité de la connexion. |
UpdateStreamingVirtualNetworkGatewayConnectionRequest
Met à jour une connexion qui se connecte via une passerelle de données de réseau virtuel de streaming.
| Nom | Obligatoire | Type | Description |
|---|---|---|---|
| connectivityType | True |
string:
Streaming |
Type de connectivité de la connexion. |
| credentialDetails |
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 |
Niveau de confidentialité de la connexion. |
UpdateVirtualNetworkGatewayConnectionRequest
| Nom | Obligatoire | Type | Description |
|---|---|---|---|
| connectivityType | True |
string:
Virtual |
Type de connectivité de la connexion. |
| credentialDetails |
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 |
Niveau de confidentialité de la connexion. |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK | Connection: |
OK. L’opération a réussi. |
| 429 Too Many Requests |
La limite de débit de service a été dépassée. Le serveur retourne un En-têtes Retry-After: integer |
|
| Other Status Codes |
Codes d’erreur courants :
|
Exemples
| On-premises gateway (personal mode) example |
| On-premises gateway example |
| Personal cloud example |
| Shareable cloud example |
| Streaming virtual network gateway example |
| Virtual network gateway example |
On-premises gateway (personal mode) example
Exemple de requête
PATCH https://api.fabric.microsoft.com/v1/connections/ef8f408d-2ab7-4a18-b662-9251febda49c
{
"connectivityType": "OnPremisesGatewayPersonal",
"credentialDetails": {
"credentials": {
"credentialType": "WindowsWithoutImpersonation",
"encryptedCredentials": "************************************"
}
}
}
Exemple de réponse
{
"id": "ef8f408d-2ab7-4a18-b662-9251febda49c",
"gatewayId": "429a773e-5633-45ee-8584-a192bd79c16a",
"connectivityType": "OnPremisesGatewayPersonal",
"connectionDetails": {
"type": "SQL",
"path": "contoso.database.windows.net;reporting"
},
"privacyLevel": "Private",
"credentialDetails": {
"credentialType": "WindowsWithoutImpersonation",
"singleSignOnType": "None",
"connectionEncryption": "NotEncrypted",
"skipTestConnection": false
},
"connectionRecency": {
"createdDateTime": "2023-05-23T16:22:20Z",
"lastBoundDateTime": "2023-05-26T16:22:20Z",
"lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
"myLastBoundDateTime": "2023-05-24T16:22:20Z",
"myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
},
"myRole": "Owner"
}
On-premises gateway example
Exemple de requête
PATCH https://api.fabric.microsoft.com/v1/connections/70b17680-48f1-4729-9df6-02576647dc3a
{
"connectivityType": "OnPremisesGateway",
"displayName": "ContosoSalesOnPremisesConnection",
"credentialDetails": {
"skipTestConnection": false,
"credentials": {
"credentialType": "Windows",
"values": [
{
"gatewayId": "4f8b5d6e-8e99-4817-8b9e-6b6a613be707",
"encryptedCredentials": "************************************"
},
{
"gatewayId": "c6961028-1309-4183-9799-a0b0fa28a235",
"encryptedCredentials": "************************************"
}
]
}
}
}
Exemple de réponse
{
"id": "70b17680-48f1-4729-9df6-02576647dc3a",
"displayName": "ContosoSalesOnPremisesConnection",
"gatewayId": "4f8b5d6e-8e99-4817-8b9e-6b6a613be707",
"connectivityType": "OnPremisesGateway",
"connectionDetails": {
"type": "SQL",
"path": "contoso.database.windows.net;sales"
},
"privacyLevel": "Organizational",
"credentialDetails": {
"credentialType": "Windows",
"singleSignOnType": "None",
"connectionEncryption": "NotEncrypted",
"skipTestConnection": false
},
"connectionRecency": {
"createdDateTime": "2023-05-23T16:22:20Z",
"lastBoundDateTime": "2023-05-26T16:22:20Z",
"lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
"myLastBoundDateTime": "2023-05-24T16:22:20Z",
"myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
},
"myRole": "Owner"
}
Personal cloud example
Exemple de requête
PATCH https://api.fabric.microsoft.com/v1/connections/7a0369b2-58c4-4b67-b3f3-92156a95f1cd
{
"connectivityType": "PersonalCloud",
"privacyLevel": "Organizational"
}
Exemple de réponse
{
"id": "7a0369b2-58c4-4b67-b3f3-92156a95f1cd",
"gatewayId": "8f72eea3-d989-4a5a-aeed-02b3aaa2ddd0",
"connectivityType": "PersonalCloud",
"connectionDetails": {
"type": "SQL",
"path": "contoso.database.windows.net;finances"
},
"privacyLevel": "Organizational",
"credentialDetails": {
"credentialType": "OAuth2",
"singleSignOnType": "None",
"connectionEncryption": "NotEncrypted",
"skipTestConnection": false
},
"connectionRecency": {
"createdDateTime": "2023-05-23T16:22:20Z",
"lastBoundDateTime": "2023-05-26T16:22:20Z",
"lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
"myLastBoundDateTime": "2023-05-24T16:22:20Z",
"myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
},
"myRole": "Owner"
}
Shareable cloud example
Exemple de requête
PATCH https://api.fabric.microsoft.com/v1/connections/fa968eee-8075-48f6-8c6d-41260ee1396d
{
"connectivityType": "ShareableCloud",
"displayName": "ContosoCloudConnection"
}
Exemple de réponse
{
"id": "fa968eee-8075-48f6-8c6d-41260ee1396d",
"displayName": "ContosoCloudConnection",
"gatewayId": "8f72eea3-d989-4a5a-aeed-02b3aaa2ddd0",
"connectivityType": "ShareableCloud",
"connectionDetails": {
"type": "SQL",
"path": "contoso.database.windows.net;networks"
},
"privacyLevel": "Public",
"credentialDetails": {
"credentialType": "Basic",
"singleSignOnType": "None",
"connectionEncryption": "NotEncrypted",
"skipTestConnection": true
},
"connectionRecency": {
"createdDateTime": "2023-05-23T16:22:20Z",
"lastBoundDateTime": "2023-05-26T16:22:20Z",
"lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
"myLastBoundDateTime": "2023-05-24T16:22:20Z",
"myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
},
"myRole": "Owner"
}
Streaming virtual network gateway example
Exemple de requête
PATCH https://api.fabric.microsoft.com/v1/connections/6b571614-2e98-4bfd-b9ed-1cb8d3ffc396
{
"connectivityType": "StreamingVirtualNetworkGateway",
"displayName": "ContosoMarketingStreamingVirtualNetworkGatewayConnection",
"credentialDetails": {
"singleSignOnType": "None"
}
}
Exemple de réponse
{
"id": "6b571614-2e98-4bfd-b9ed-1cb8d3ffc396",
"displayName": "ContosoMarketingStreamingVirtualNetworkGatewayConnection",
"gatewayId": "befccff4-3ee6-40d7-b8f1-a0a9fd684a85",
"connectivityType": "StreamingVirtualNetworkGateway",
"connectionDetails": {
"type": "SQL",
"path": "contoso.database.windows.net;marketing"
},
"privacyLevel": "Organizational",
"credentialDetails": {
"credentialType": "Basic",
"singleSignOnType": "None",
"connectionEncryption": "Encrypted",
"skipTestConnection": false
},
"myRole": "Owner"
}
Virtual network gateway example
Exemple de requête
PATCH https://api.fabric.microsoft.com/v1/connections/6b571614-2e98-4bfd-b9ed-1cb8d3ffc396
{
"connectivityType": "VirtualNetworkGateway",
"displayName": "ContosoMarketingVirtualNetworkGatewayConnection",
"privacyLevel": "Organizational",
"credentialDetails": {
"singleSignOnType": "None"
}
}
Exemple de réponse
{
"id": "6b571614-2e98-4bfd-b9ed-1cb8d3ffc396",
"displayName": "ContosoMarketingVirtualNetworkGatewayConnection",
"gatewayId": "befccff4-3ee6-40d7-b8f1-a0a9fd684a85",
"connectivityType": "VirtualNetworkGateway",
"connectionDetails": {
"type": "SQL",
"path": "contoso.database.windows.net;marketing"
},
"privacyLevel": "Organizational",
"credentialDetails": {
"credentialType": "Basic",
"singleSignOnType": "None",
"connectionEncryption": "NotEncrypted",
"skipTestConnection": false
},
"connectionRecency": {
"createdDateTime": "2023-05-23T16:22:20Z",
"lastBoundDateTime": "2023-05-26T16:22:20Z",
"lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
"myLastBoundDateTime": "2023-05-24T16:22:20Z",
"myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
},
"myRole": "Owner"
}
Définitions
| Nom | Description |
|---|---|
|
Anonymous |
Informations d’identification pour CredentialType anonyme. |
|
Basic |
Informations d’identification pour CredentialType de base. |
|
Connection |
Type de chiffrement de connexion de la connexion. Des valeurs de chiffrement de connexion supplémentaires peuvent être ajoutées au fil du temps. |
|
Connection |
Représente les détails de la récurrence sur la connexion. |
|
Connection |
Rôle de connexion. Des rôles de connexion supplémentaires peuvent être ajoutés au fil du temps. |
|
Connectivity |
Type de connectivité de la connexion. Des types de connectivité supplémentaires peuvent être ajoutés au fil du temps. |
|
Credential |
Type d’informations d’identification de la connexion. Des types d’informations d’identification supplémentaires peuvent être ajoutés au fil du temps. |
|
Error |
Paramètre structuré fournissant un contexte lisible par l’ordinateur supplémentaire à propos d’une erreur. |
|
Error |
Objet de détails de ressource associé à l’erreur. |
|
Error |
Réponse d’erreur. |
|
Error |
Détails de la réponse d’erreur. |
|
Key |
Informations d’identification pour Key CredentialType. |
|
Key |
Informations d’identification pour KeyPair CredentialType. |
|
Key |
Référence à un secret stocké dans Azure Key Vault. |
|
List |
Sortie des détails de connexion pour les opérations de liste. |
|
List |
Détails des informations d’identification retournés lors de l’extraction d’une connexion. |
|
On |
ID de passerelle et ses informations d’identification sérialisées chiffrées. |
|
On |
Connexion qui se connecte via une passerelle de données locale. |
|
On |
Informations d’identification pour l’authentification via une passerelle locale. |
|
On |
Connexion qui se connecte via une passerelle de données locale personnelle. |
|
On |
Informations d’identification pour l’authentification via une passerelle locale (mode personnel). |
|
Personal |
Connexion qui se connecte via le cloud et ne peut pas être partagée. |
|
Privacy |
Paramètre de niveau de confidentialité de la connexion. Des niveaux de confidentialité supplémentaires peuvent être ajoutés au fil du temps. |
|
Service |
Informations d’identification pour ServicePrincipal CredentialType. |
|
Shareable |
Connexion qui se connecte via le cloud. |
|
Shared |
Informations d’identification pour SharedAccessSignature CredentialType. |
|
Single |
Type d’authentification unique de la connexion. Des types d’authentification unique supplémentaires peuvent être ajoutés au fil du temps. |
|
Streaming |
Connexion qui se connecte via une passerelle de données de réseau virtuel de streaming. |
|
Update |
Entrée des informations d’identification pour la mise à jour d’une connexion. |
|
Update |
|
|
Update |
Entrée des informations d’identification pour la mise à jour d’une connexion de passerelle locale. |
|
Update |
|
|
Update |
Entrée des informations d’identification pour la mise à jour d’une connexion de passerelle locale. |
|
Update |
|
|
Update |
|
|
Update |
Met à jour une connexion qui se connecte via une passerelle de données de réseau virtuel de streaming. |
|
Update |
|
|
Virtual |
Connexion qui se connecte via une passerelle de données de réseau virtuel. |
|
Windows |
Informations d’identification pour Windows CredentialType. |
|
Windows |
Informations d’identification pour WindowsWithoutImpersonation CredentialType. |
|
Workspace |
Informations d’identification pour WorkspaceIdentity CredentialType. |
AnonymousCredentials
Informations d’identification pour CredentialType anonyme.
| Nom | Type | Description |
|---|---|---|
| credentialType |
string:
Anonymous |
Type d’informations d’identification de la connexion. |
BasicCredentials
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 |
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. |
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.
| Valeur | Description |
|---|---|
| Encrypted |
La tentative de connexion est effectuée à l’aide d’une connexion chiffrée. |
| Any |
La tentative de connexion est d’abord effectuée à l’aide d’une connexion chiffrée, puis revient à une connexion non chiffrée en cas d’échec. |
| NotEncrypted |
La tentative de connexion est effectuée à l’aide d’une connexion non chiffrée. |
ConnectionRecency
Représente les détails de la récurrence sur la connexion.
| Nom | Type | Description |
|---|---|---|
| createdDateTime |
string (date-time) |
Horodatage lorsque la connexion a été créée au format UTC, à l’aide du format AAAA-MM-DDTHH :mm :ssZ. |
| lastBoundDateTime |
string (date-time) |
Horodatage lorsque la connexion a été la plus récemment liée à n’importe quel élément au format UTC, à l’aide du format AAAA-MM-DDTHH :mm :ssZ. |
| lastCredentialUsedDateTime |
string (date-time) |
Horodatage lorsque les informations d’identification de connexion ont été utilisées récemment au format UTC, à l’aide du format AAAA-MM-DDTHH :mm :ssZ. |
| myLastBoundDateTime |
string (date-time) |
Horodatage lorsque la connexion était la plus récemment liée à n’importe quel élément par l’utilisateur appelant au format UTC, à l’aide du format AAAA-MM-DDTHH :mm :ssZ. |
| myLastCredentialUsedDateTime |
string (date-time) |
Horodatage lorsque les informations d’identification de connexion ont été utilisées récemment par l’utilisateur appelant au format UTC, à l’aide du format AAAA-MM-DDTHH :mm :ssZ. |
ConnectionRole
Rôle de connexion. Des rôles de connexion supplémentaires peuvent être ajoutés au fil du temps.
| Valeur | Description |
|---|---|
| User |
Permet à l’utilisateur d’accéder à la connexion. |
| UserWithReshare |
Permet à l’utilisateur d’accéder à nouveau pour la connexion. |
| Owner |
Active l’accès à la propriété pour la connexion. |
| PendingOwner |
La propriété de la connexion n’est pas encore effective ; le principal doit mettre à jour les informations d’identification de connexion (à l’aide de l’API Mettre à jour la connexion) pour qu’elle soit effective. |
ConnectivityType
Type de connectivité de la connexion. Des types de connectivité supplémentaires peuvent être ajoutés au fil du temps.
| Valeur | Description |
|---|---|
| ShareableCloud |
La connexion se connecte via le cloud et peut être partagée avec d’autres personnes. |
| PersonalCloud |
La connexion se connecte via le cloud et ne peut pas être partagée avec d’autres personnes. |
| OnPremisesGateway |
La connexion se connecte via une passerelle de données locale. |
| OnPremisesGatewayPersonal |
La connexion se connecte via une passerelle de données locale personnelle. |
| VirtualNetworkGateway |
La connexion se connecte via une passerelle de données de réseau virtuel. |
| StreamingVirtualNetworkGateway |
La connexion se connecte via une passerelle de données de réseau virtuel de streaming. |
| Automatic |
La connexion se connecte via le cloud à l’aide d’une connexion de données implicite. Cette option est disponible uniquement pour des scénarios spécifiques tels que des modèles sémantiques qui utilisent l'Sign-On authentification unique (SSO). » |
| None |
La connexion n’est pas liée |
CredentialType
Type d’informations d’identification de la connexion. Des types d’informations d’identification supplémentaires peuvent être ajoutés au fil du temps.
| Valeur | Description |
|---|---|
| Windows |
La connexion utilise l’authentification Windows pour se connecter. Uniquement pris en charge pour les passerelles locales. |
| Anonymous |
La connexion utilise l’authentification anonyme pour se connecter. |
| Basic |
La connexion utilise l’authentification de base pour se connecter. |
| Key |
La connexion utilise l’authentification par clé pour se connecter. |
| OAuth2 |
La connexion utilise l’authentification OAuth 2.0 pour se connecter. |
| WindowsWithoutImpersonation |
La connexion utilise Windows (sans option pour l’authentification d’emprunt d’identité) pour se connecter. Uniquement pris en charge pour les passerelles locales (mode personnel). |
| SharedAccessSignature |
La connexion utilise l’authentification par signature d’accès partagé (SAP) pour se connecter. |
| ServicePrincipal |
La connexion utilise l’authentification du principal de service pour se connecter. |
| WorkspaceIdentity |
La connexion utilise l’authentification d’identité de l’espace de travail pour se connecter. |
| KeyPair |
La connexion utilise l’authentification par paire de clés pour se connecter. |
ErrorParameter
Paramètre structuré fournissant un contexte lisible par l’ordinateur supplémentaire à propos d’une erreur.
| Nom | Type | Description |
|---|---|---|
| message |
string |
Description lisible par l’homme de la signification du paramètre. |
| name |
string |
L’identifiant de paramètre. |
| value |
string |
Représente la valeur du paramètre. |
ErrorRelatedResource
Objet 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
Réponse d’erreur.
| Nom | Type | Description |
|---|---|---|
| errorCode |
string |
Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs. |
| isRetriable |
boolean |
Lorsque la valeur est true, la requête peut être retentée. Utilisez l’en-tête |
| message |
string |
Représentation lisible humaine de l’erreur. |
| moreDetails |
Liste des détails d’erreur supplémentaires. |
|
| parameters |
Paramètres structurés fournissant un contexte lisible par l’ordinateur supplémentaire sur l’erreur. |
|
| relatedResource |
Détails de la ressource associée à l’erreur. |
|
| requestId |
string (uuid) |
ID de la demande associée à l’erreur. |
ErrorResponseDetails
Détails de la réponse d’erreur.
| Nom | Type | Description |
|---|---|---|
| errorCode |
string |
Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs. |
| message |
string |
Représentation lisible humaine de l’erreur. |
| parameters |
Paramètres structurés fournissant un contexte lisible par l’ordinateur supplémentaire sur l’erreur. |
|
| relatedResource |
Détails de la ressource associée à l’erreur. |
KeyCredentials
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 |
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
Informations d’identification pour KeyPair CredentialType.
| Nom | Type | Description |
|---|---|---|
| credentialType |
string:
Key |
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
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
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
Détails des informations d’identification retournés lors de l’extraction d’une connexion.
| Nom | Type | Description |
|---|---|---|
| connectionEncryption |
Paramètre de chiffrement de connexion utilisé pendant la connexion de test. |
|
| credentialType |
Type d’informations d’identification de la connexion. |
|
| 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
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
Connexion qui se connecte via une passerelle de données locale.
| Nom | Type | Description |
|---|---|---|
| connectionDetails |
Détails de connexion de la connexion. |
|
| connectionRecency |
Détails de la récurrence sur la connexion. |
|
| connectivityType |
string:
On |
Type de connectivité de la connexion. |
| credentialDetails |
Détails des informations d’identification de la connexion. |
|
| displayName |
string |
Nom complet de la connexion. |
| gatewayId |
string (uuid) |
ID d’objet de passerelle via lequel la connexion est établie. Pour les connexions cloud, il s’agit de l’ID de passerelle virtuelle. |
| id |
string (uuid) |
ID d’objet de la connexion. |
| myRole |
Rôle effectif du principal appelant sur la connexion. Lorsque le principal fait partie de plusieurs groupes de sécurité avec différents rôles, le rôle le plus élevé est retourné. Si le principal n’a aucun rôle sur la connexion, cette propriété n’est pas retournée. |
|
| privacyLevel |
Niveau de confidentialité de la connexion. |
OnPremisesGatewayCredentials
Informations d’identification pour l’authentification via une passerelle locale.
| Nom | Type | Description |
|---|---|---|
| credentialType |
Type d’informations d’identification de la connexion. |
|
| values |
Charge utile des informations d’identification à envoyer à la passerelle locale. |
OnPremisesGatewayPersonalConnection
Connexion qui se connecte via une passerelle de données locale personnelle.
| Nom | Type | Description |
|---|---|---|
| connectionDetails |
Détails de connexion de la connexion. |
|
| connectionRecency |
Détails de la récurrence sur la connexion. |
|
| connectivityType |
string:
On |
Type de connectivité de la connexion. |
| credentialDetails |
Détails des informations d’identification de la connexion. |
|
| displayName |
string |
Nom complet de la connexion. |
| gatewayId |
string (uuid) |
ID d’objet de passerelle via lequel la connexion est établie. Pour les connexions cloud, il s’agit de l’ID de passerelle virtuelle. |
| id |
string (uuid) |
ID d’objet de la connexion. |
| myRole |
Rôle effectif du principal appelant sur la connexion. Lorsque le principal fait partie de plusieurs groupes de sécurité avec différents rôles, le rôle le plus élevé est retourné. Si le principal n’a aucun rôle sur la connexion, cette propriété n’est pas retournée. |
|
| privacyLevel |
Niveau de confidentialité de la connexion. |
OnPremisesGatewayPersonalCredentials
Informations d’identification pour l’authentification via une passerelle locale (mode personnel).
| Nom | Type | Description |
|---|---|---|
| credentialType |
Type d’informations d’identification de la connexion. |
|
| 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 de la passerelle locale. |
PersonalCloudConnection
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 |
Détails de connexion de la connexion. |
|
| connectionRecency |
Détails de la récurrence sur la connexion. |
|
| connectivityType |
string:
Personal |
Type de connectivité de la connexion. |
| credentialDetails |
Détails des informations d’identification de la connexion. |
|
| displayName |
string |
Nom complet de la connexion. |
| gatewayId |
string (uuid) |
ID d’objet de passerelle via lequel la connexion est établie. Pour les connexions cloud, il s’agit de l’ID de passerelle virtuelle. |
| id |
string (uuid) |
ID d’objet de la connexion. |
| myRole |
Rôle effectif du principal appelant sur la connexion. Lorsque le principal fait partie de plusieurs groupes de sécurité avec différents rôles, le rôle le plus élevé est retourné. Si le principal n’a aucun rôle sur la connexion, cette propriété n’est pas retournée. |
|
| privacyLevel |
Niveau de confidentialité de la 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.
| 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
Informations d’identification pour ServicePrincipal CredentialType.
| Nom | Type | Description |
|---|---|---|
| credentialType |
string:
Service |
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 |
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
Connexion qui se connecte via le cloud.
| Nom | Type | Description |
|---|---|---|
| allowConnectionUsageInGateway |
boolean |
Autorisez cette connexion à utiliser avec des passerelles de données locales ou des passerelles de données de réseau virtuel. |
| allowUsageInUserControlledCode |
boolean |
Autorisez cette connexion à utiliser avec des éléments qui autorisent le code contrôlé par l’utilisateur, tel que Notebook. |
| connectionDetails |
Détails de connexion de la connexion. |
|
| connectionRecency |
Détails de la récurrence sur la connexion. |
|
| connectivityType |
string:
Shareable |
Type de connectivité de la connexion. |
| credentialDetails |
Détails des informations d’identification de la connexion. |
|
| displayName |
string |
Nom complet de la connexion. |
| gatewayId |
string (uuid) |
ID d’objet de passerelle via lequel la connexion est établie. Pour les connexions cloud, il s’agit de l’ID de passerelle virtuelle. |
| id |
string (uuid) |
ID d’objet de la connexion. |
| myRole |
Rôle effectif du principal appelant sur la connexion. Lorsque le principal fait partie de plusieurs groupes de sécurité avec différents rôles, le rôle le plus élevé est retourné. Si le principal n’a aucun rôle sur la connexion, cette propriété n’est pas retournée. |
|
| privacyLevel |
Niveau de confidentialité de la connexion. |
SharedAccessSignatureCredentials
Informations d’identification pour SharedAccessSignature CredentialType.
| Nom | Type | Description |
|---|---|---|
| credentialType |
string:
Shared |
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 |
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
Type d’authentification unique de la connexion. Des types d’authentification unique supplémentaires peuvent être ajoutés au fil du temps.
| Valeur | Description |
|---|---|
| None |
La connexion n’utilise pas l’authentification unique pour se connecter. |
| Kerberos |
La connexion utilise l’authentification unique Kerberos pour se connecter. |
| MicrosoftEntraID |
La connexion utilise l’authentification unique Microsoft Entra ID pour se connecter. |
| SecurityAssertionMarkupLanguage |
La connexion utilise l’authentification unique SAML (Security Assertion Markup Language) pour se connecter. |
| KerberosDirectQueryAndRefresh |
La connexion utilise Kerberos DirectQuery et Actualiser l’authentification unique pour se connecter. |
StreamingVirtualNetworkGatewayConnection
Connexion qui se connecte via une passerelle de données de réseau virtuel de streaming.
| Nom | Type | Description |
|---|---|---|
| connectionDetails |
Détails de connexion de la connexion. |
|
| connectionRecency |
Détails de la récurrence sur la connexion. |
|
| connectivityType |
string:
Streaming |
Type de connectivité de la connexion. |
| credentialDetails |
Détails des informations d’identification de la connexion. |
|
| displayName |
string |
Nom complet de la connexion. |
| gatewayId |
string (uuid) |
ID d’objet de passerelle de la connexion. |
| id |
string (uuid) |
ID d’objet de la connexion. |
| myRole |
Rôle effectif du principal appelant sur la connexion. Lorsque le principal fait partie de plusieurs groupes de sécurité avec différents rôles, le rôle le plus élevé est retourné. Si le principal n’a aucun rôle sur la connexion, cette propriété n’est pas retournée. |
|
| privacyLevel |
Niveau de confidentialité de la connexion. |
UpdateCredentialDetails
Entrée des informations d’identification pour la mise à jour d’une connexion.
| Nom | Type | Description |
|---|---|---|
| connectionEncryption |
Paramètre de chiffrement de connexion utilisé pendant la connexion de test. |
|
| credentials | Credentials: |
Informations d’identification de la connexion. |
| 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. |
UpdateOnPremisesGatewayConnectionRequest
| Nom | Type | Description |
|---|---|---|
| connectivityType |
string:
On |
Type de connectivité de la connexion. |
| credentialDetails |
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 |
Niveau de confidentialité de la connexion. |
UpdateOnPremisesGatewayCredentialDetails
Entrée des informations d’identification pour la mise à jour d’une connexion de passerelle locale.
| Nom | Type | Description |
|---|---|---|
| connectionEncryption |
Paramètre de chiffrement de connexion utilisé pendant la connexion de test. |
|
| credentials |
Informations d’identification de la connexion. |
|
| 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. |
UpdateOnPremisesGatewayPersonalConnectionRequest
| Nom | Type | Description |
|---|---|---|
| connectivityType |
string:
On |
Type de connectivité de la connexion. |
| credentialDetails |
Détails des informations d’identification de la connexion. |
|
| privacyLevel |
Niveau de confidentialité de la connexion. |
UpdateOnPremisesGatewayPersonalCredentialDetails
Entrée des informations d’identification pour la mise à jour d’une connexion de passerelle locale.
| Nom | Type | Description |
|---|---|---|
| connectionEncryption |
Paramètre de chiffrement de connexion utilisé pendant la connexion de test. |
|
| credentials |
Informations d’identification de la connexion. |
|
| 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. |
UpdatePersonalCloudConnectionRequest
| 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. |
| connectivityType |
string:
Personal |
Type de connectivité de la connexion. |
| credentialDetails |
Détails des informations d’identification de la connexion. |
|
| privacyLevel |
Niveau de confidentialité de la connexion. |
UpdateShareableCloudConnectionRequest
| 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. |
| connectivityType |
string:
Shareable |
Type de connectivité de la connexion. |
| credentialDetails |
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 |
Niveau de confidentialité de la connexion. |
UpdateStreamingVirtualNetworkGatewayConnectionRequest
Met à jour une connexion qui se connecte via une passerelle de données de réseau virtuel de streaming.
| Nom | Type | Description |
|---|---|---|
| connectivityType |
string:
Streaming |
Type de connectivité de la connexion. |
| credentialDetails |
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 |
Niveau de confidentialité de la connexion. |
UpdateVirtualNetworkGatewayConnectionRequest
| Nom | Type | Description |
|---|---|---|
| connectivityType |
string:
Virtual |
Type de connectivité de la connexion. |
| credentialDetails |
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 |
Niveau de confidentialité de la connexion. |
VirtualNetworkGatewayConnection
Connexion qui se connecte via une passerelle de données de réseau virtuel.
| Nom | Type | Description |
|---|---|---|
| connectionDetails |
Détails de connexion de la connexion. |
|
| connectionRecency |
Détails de la récurrence sur la connexion. |
|
| connectivityType |
string:
Virtual |
Type de connectivité de la connexion. |
| credentialDetails |
Détails des informations d’identification de la connexion. |
|
| displayName |
string |
Nom complet de la connexion. |
| gatewayId |
string (uuid) |
ID d’objet de passerelle via lequel la connexion est établie. Pour les connexions cloud, il s’agit de l’ID de passerelle virtuelle. |
| id |
string (uuid) |
ID d’objet de la connexion. |
| myRole |
Rôle effectif du principal appelant sur la connexion. Lorsque le principal fait partie de plusieurs groupes de sécurité avec différents rôles, le rôle le plus élevé est retourné. Si le principal n’a aucun rôle sur la connexion, cette propriété n’est pas retournée. |
|
| privacyLevel |
Niveau de confidentialité de la connexion. |
WindowsCredentials
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
Informations d’identification pour WindowsWithoutImpersonation CredentialType.
| Nom | Type | Description |
|---|---|---|
| credentialType |
string:
Windows |
Type d’informations d’identification de la connexion. |
WorkspaceIdentityCredentials
Informations d’identification pour WorkspaceIdentity CredentialType.
| Nom | Type | Description |
|---|---|---|
| credentialType |
string:
Workspace |
Type d’informations d’identification de la connexion. |