Azure Synapse

Le connecteur Azure Synapse vous permet de vous connecter à un pool SQL Azure Synapse et d'utiliser SQL pour récupérer et mettre à jour les données Azure Synapse.

Avant de commencer

Avant d'utiliser le connecteur Azure Synapse, effectuez les tâches suivantes :

Dans votre projet Google Cloud :
- Assurez-vous que la connectivité réseau est configurée. Pour en savoir plus sur les schémas de réseau, consultez Connectivité réseau.
- Attribuez le rôle IAM roles/connectors.admin à l'utilisateur qui configure le connecteur.
- Attribuez les rôles IAM suivants au compte de service que vous souhaitez utiliser pour le connecteur :
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  Un compte de service est un type spécial de compte Google destiné à représenter un utilisateur non humain qui doit s'authentifier et obtenir les autorisations permettant d'accéder aux données des API Google. Si vous ne possédez pas de compte de service, vous devez en créer un. Pour plus d'informations, consultez Créer un compte de service.
- Activez les services suivants :
  - secretmanager.googleapis.com (API Secret Manager)
  - connectors.googleapis.com (API Connectors)
  Pour savoir comment activer des services, consultez Activer des services.
Si ces services ou autorisations n'ont pas encore été activés pour votre projet, vous êtes invité à les activer au moment de configurer le connecteur.

Configurer le connecteur

Une connexion est propre à une source de données. Cela signifie que si vous disposez de nombreuses sources de données, vous devez créer une connexion distincte pour chacune d'elles. Pour créer une connexion, procédez comme suit :

Dans la console Cloud, accédez à la page Connecteurs d'intégration > Connexions, puis sélectionnez ou créez un projet Google Cloud.
Accéder à la page "Connexions"
Cliquez sur + Créer pour ouvrir la page Créer une connexion.
Dans la section Emplacement, choisissez l'emplacement de la connexion.
1. Région : sélectionnez un emplacement dans la liste déroulante.
  Les régions disponibles pour les connecteurs sont les suivantes :
  Pour obtenir la liste de toutes les régions disponibles, consultez Emplacements.
2. Cliquez sur Suivant.
Dans la section Détails de connexion, procédez comme suit :
1. Connecteur : sélectionnez Azure Synapse dans la liste déroulante des connecteurs disponibles.
2. Version du connecteur : sélectionnez la version du connecteur dans la liste déroulante des versions disponibles.
3. Dans le champ Nom de connexion, indiquez le nom de l'instance de connexion.
  Les noms de connexion doivent répondre aux critères suivants :
  - Ils peuvent contenir des lettres, des chiffres ou des traits d'union.
  - Les lettres doivent être en minuscules.
  - Ils doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
  - Ils ne peuvent pas dépasser 49 caractères.
4. (Facultatif) Saisissez une description de l'instance de connexion.
5. Compte de service : sélectionnez un compte de service disposant des rôles requis.
6. (Facultatif) Configurez les paramètres de nœuds de connexion :
  - Nombre minimal de nœuds : saisissez le nombre minimal de nœuds de connexion.
  - Nombre maximal de nœuds : saisissez le nombre maximal de nœuds de connexion.
  Un nœud est une unité (ou instance répliquée) de connexion qui traite des transactions. Pour traiter davantage de transactions pour une connexion, vous devez disposer de plus de nœuds. À l'inverse, moins de nœuds sont nécessaires si une connexion traite moins de transactions. Pour comprendre comment les nœuds affectent la tarification de votre connecteur, consultez Tarifs des nœuds de connexion. Si vous ne saisissez aucune valeur, le nombre minimal de nœuds est défini par défaut sur 2 (pour améliorer la disponibilité) et le nombre maximal de nœuds sur 50.
7. Locataire Azure : cette propriété spécifie le locataire Microsoft Azure utilisé pour accéder aux données.
8. Base de données : cette propriété spécifie le nom de la base de données Synapse dans le pool SQL sans serveur ou le pool SQL dédié.
9. Sous "Destinations", saisissez les propriétés suivantes :
10. (Facultatif) Saisissez les propriétés suivantes pour SSL :
  - Activer SSL : cette propriété de case à cocher indique si SSL doit être activé.
  - Truststore : cette propriété spécifie le truststore. Vous pouvez sélectionner une case d'option pour choisir le truststore parmi "Public", "Privé" ou "Connexion non sécurisée".
  - Truststore personnalisé : cette propriété permet de sélectionner un secret contenant le truststore personnalisé au format PEM.
  - Certificat client SSL : cette propriété spécifie le certificat client SSL.
  - Clé privée du client SSL : cette propriété spécifie la clé privée du client SSL au format PEM.
  - Phrase secrète de la clé du certificat client SSL : cette propriété spécifie la phrase secrète de la clé privée du client SSL.
11. (Facultatif) Cliquez sur + Ajouter une étiquette pour ajouter une étiquette à la connexion sous la forme d'une paire clé/valeur.
12. Cliquez sur Suivant.
Dans la section Authentification, saisissez les informations d'authentification.
1. Sélectionnez un type d'authentification, puis saisissez les informations appropriées.
  Les types d'authentification suivants sont compatibles avec la connexion Azure Synapse :
  - Mot de passe utilisateur
  - Azure AD
2. Cliquez sur Suivant.
Vérifier : vérifiez vos informations de connexion et d'authentification.
Cliquez sur Créer.

Configurer l'authentification

Saisissez les informations en fonction de l'authentification que vous souhaitez utiliser.

Mot de passe utilisateur
- Nom d'utilisateur : saisissez le nom d'utilisateur de la base de données.
- Mot de passe : secret Secret Manager contenant le mot de passe associé au nom d'utilisateur.

Azure AD
- ID client : ID client utilisé pour demander des jetons d'accès. Vous le trouverez dans la présentation de l'application connectée créée sur le portail Azure.
- Niveau d'accès : liste des niveaux d'accès souhaités, séparés par une virgule.
- Code secret du client : secret Secret Manager contenant la clé d'accès au compte.
- URL d'autorisation : URL d'autorisation que vous générez lorsque vous créez un client OAuth. Saisissez l'URL au format suivant : https://login.microsoftonline.com/TENANT_IDENTIFIER/oauth2/v2.0/authorize?prompt=consent. Par exemple, https://login.microsoftonline.com/9bxxxxxxxxx8112/oauth2/v2.0/authorize?prompt=consent.

Étapes supplémentaires après la création de la connexion

Si vous avez sélectionné OAuth 2.0 - Authorization code pour l'authentification, vous devez effectuer les étapes supplémentaires ci-dessous après avoir créé la connexion :

Sur la page Connexions, recherchez la connexion que vous venez de créer.
Notez que l'état du nouveau connecteur sera Autorisation requise.
Cliquez sur Autorisation requise.
Le volet Modifier l'autorisation s'affiche.
Copiez la valeur de l'URI de redirection dans votre application externe.
Vérifiez les détails de l'autorisation.
Cliquez sur Autoriser.
Si l'autorisation aboutit, l'état de la connexion est défini sur Active sur la page Connexions.

Accorder une nouvelle autorisation pour le code d'autorisation

Si vous utilisez le type d'authentification Authorization code et que vous avez modifié la configuration de votre application Azure Synapse, vous devez autoriser à nouveau votre connexion Azure Synapse. Pour autoriser à nouveau une connexion, procédez comme suit :

Sur la page Connexions, cliquez sur la connexion requise.
La page de détails de la connexion s'ouvre.
Cliquez sur Modifier pour modifier les détails de la connexion.
Dans la section Authentification, vérifiez les détails du code d'autorisation OAuth 2.0.
Apportez des modifications, si besoin.
Cliquez sur Enregistrer. La page de détails de la connexion s'affiche.
Dans la section Authentification, cliquez sur Modifier l'autorisation. Le volet Autoriser s'affiche.
Cliquez sur Autoriser.
Si l'autorisation aboutit, l'état de la connexion est défini sur Active sur la page Connexions.

Entités, opérations et actions

Tous les connecteurs Integration Connectors fournissent une couche d'abstraction pour les objets de l'application connectée. Vous ne pouvez accéder aux objets d'une application que par le biais de cette abstraction. L'abstraction vous est présentée en tant qu'entités, opérations et actions.

Entité : une entité peut être considérée comme un objet ou un ensemble de propriétés dans l'application ou le service connectés. La définition d'une entité diffère d'un connecteur à l'autre. Par exemple, dans un connecteur de base de données, les tables sont les entités, alors que dans un connecteur de serveur de fichiers, ce sont les dossiers, et dans un connecteur de système de messagerie, ce sont les files d'attente.
Toutefois, il est possible qu'un connecteur n'accepte ou ne possède aucune entité. Dans ce cas, la liste Entities est vide.
Opération : une opération est l'activité que vous pouvez effectuer sur une entité. Voici les opérations possibles :
- List
- Get
- Create
- Update
- Delete
Lorsque vous sélectionnez une entité dans la liste proposée, cela génère une liste d'opérations disponibles pour l'entité. Pour obtenir une description détaillée des opérations, consultez les opérations d'entité de la tâche "Connecteurs". Cependant, si un connecteur n'accepte pas l'une des opérations d'entité, cette opération non compatible ne figure pas dans la liste Operations.
Action : une action est une fonction de première classe mise à la disposition de l'intégration par le biais de l'interface du connecteur. Une action vous permet de modifier une ou plusieurs entités, et varie d'un connecteur à l'autre. Normalement, une action comporte des paramètres d'entrée et un paramètre de sortie. Toutefois, il est possible qu'un connecteur n'accepte aucune action, auquel cas la liste Actions est vide.

Limites du système

Le connecteur Azure Synapse peut traiter au maximum quatre transactions par seconde et par nœud, et limite les transactions au-delà de ce seuil. Par défaut, Integration Connectors alloue deux nœuds (pour améliorer la disponibilité) à une connexion.

Pour en savoir plus sur les limites applicables à Integration Connectors, consultez Limites.

Remarque : L'autoscaling du nombre de nœuds Integration Connectors s'effectue de manière dynamique en fonction de votre utilisation. Toutefois, si vous souhaitez réserver de la capacité pour de gros volumes sans attendre l'autoscaling, vous pouvez ajuster le nombre minimal de nœuds pour une connexion. Pour traiter davantage de transactions pour une connexion, vous devez disposer de plus de nœuds. À l'inverse, moins de nœuds sont nécessaires si une connexion traite moins de transactions. Pour configurer les valeurs de nœuds, procédez comme suit :

Si vous avez opté pour le paiement à l'usage, configurez le nombre minimal et le nombre maximal de nœuds sur la page "Modifier la connexion".
Si vous avez souscrit un abonnement, contactez l'assistance.

Le nombre maximal de transactions qu'un nœud peut traiter dépend de plusieurs facteurs. Par conséquent, avant que vous ajustiez le nombre minimal de nœuds pour améliorer le débit, nous vous recommandons de vérifier si vos systèmes backend sont configurés de manière optimale pour gérer le trafic requis.

Types de données acceptés

Voici les types de données acceptés pour ce connecteur :

BIGINT
BINARY
BIT
CHAR
DATE
DATETIME
DATETIME2
DATETIMEOFFSET
DECIMAL
FLOAT
DECIMAL
FLOAT
INT
MONEY
NCHAR
NVARCHAR
REAL
LSEG
SMALLDATETIME
SMALLINT
SMALLMONEY
TINYINT
UNIQUEIDENTIFIER
VARBINARY
VARCHAR

Actions

Le connecteur Azure Synapse vous permet d'exécuter vos procédures stockées et vos requêtes SQL personnalisées dans le format accepté par Azure Synapse. Pour exécuter des requêtes SQL personnalisées, le connecteur fournit l'action Exécuter une requête personnalisée.

Pour créer une requête personnalisée, procédez comme suit :

Suivez les instructions détaillées pour ajouter une tâche "Connecteurs".
Lorsque vous configurez la tâche "Connecteurs", sélectionnez Actions dans le type d'action à effectuer.
Dans la liste Action, sélectionnez Exécuter une requête personnalisée, puis cliquez sur OK.
Développez la section Entrée de la tâche, puis procédez comme suit :
1. Dans le champ Délai d'inactivité après, saisissez le nombre de secondes d'attente jusqu'à l'exécution de la requête.
  Valeur par défaut : 180 secondes
2. Dans le champ Nombre maximal de lignes, saisissez le nombre maximal de lignes à renvoyer à partir de la base de données.
  Valeur par défaut : 25
3. Pour mettre à jour la requête personnalisée, cliquez sur Modifier le script personnalisé. La boîte de dialogue Éditeur de script s'ouvre.
4. Dans la boîte de dialogue Éditeur de script, saisissez la requête SQL, puis cliquez sur Enregistrer.
  Vous pouvez utiliser un point d'interrogation (?) dans une instruction SQL pour représenter un seul paramètre devant être spécifié dans la liste des paramètres de requête. Par exemple, la requête SQL suivante sélectionne toutes les lignes de la table Employees correspondant aux valeurs spécifiées pour la colonne LastName :
```
SELECT * FROM Employees where LastName=?
```
  Remarque : Les instructions LMD (langage de manipulation de données) et LDD (langage de définition de données) sont acceptées.
5. Si vous avez utilisé des points d'interrogation dans votre requête SQL, vous devez ajouter le paramètre en cliquant sur + Ajouter un nom de paramètre pour chaque point d'interrogation. Lors de l'exécution de l'intégration, ces paramètres remplacent les points d'interrogation (?) de la requête SQL de manière séquentielle. Par exemple, si vous avez ajouté trois points d'interrogation (?), vous devez ajouter trois paramètres dans l'ordre de séquence.
  
  Pour ajouter des paramètres de requête, procédez comme suit :
  1. Dans la liste Type, sélectionnez le type de données du paramètre.
  2. Dans le champ Valeur, saisissez la valeur du paramètre.
  3. Pour ajouter plusieurs paramètres, cliquez sur + Ajouter un paramètre de requête.

Exemples d'opérations d'entité

Exemple : Lister les enregistrements d'une entité

Cet exemple liste les enregistrements de l'entité Users.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez Users dans la liste Entity.
Sélectionnez l'opération List, puis cliquez sur OK.
Dans la section Entrée de la tâche de la tâche Connecteurs, vous pouvez définir la filterClause selon vos besoins.

Par exemple, si vous définissez la clause de filtre sur employeeCode='5100' and startDate='2010-01-01 00:00:00', vous ne voyez que les enregistrements dont l'employeeCode est 5100 et la startDate est 2010-01-01 00:00:00.

Exemple : Récupérer un seul enregistrement à partir d'une entité

Cet exemple extrait un enregistrement de l'entité Users.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez User dans la liste Entity.
Sélectionnez l'opération Get, puis cliquez sur OK.
Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur entityId, puis saisissez 103032 dans le champ Valeur par défaut.
Ici, 103032 est la valeur de la clé primaire de l'entité Users.

Exemple : Supprimer un enregistrement d'une entité

Cet exemple supprime un enregistrement de l'entité Users.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez Users dans la liste Entity.
Sélectionnez l'opération Delete, puis cliquez sur OK.
Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur entityId, puis saisissez 113132 dans le champ Valeur par défaut.
Si l'entité comporte des clés primaires composites, vous pouvez définir la filterClause au lieu de spécifier l'entityId. Par exemple, employeeCode='5100' and startDate='2010-01-01 00:00:00'.

Exemple : Créer un enregistrement dans une entité

Cet exemple crée un enregistrement dans l'entité Users.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez Users dans la liste Entity.
Sélectionnez l'opération Create, puis cliquez sur OK.
Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
```
{
"employeeCode": "5100",
"startDate": "2010-01-01 00:00:00.0",
"country": "US"
}
```

Si l'intégration aboutit, le champ connectorOutputPayload de la tâche "Connecteurs" contiendra la réponse de l'opération de création.

Exemple : Mettre à jour un enregistrement dans une entité

Cet exemple met à jour un enregistrement dans l'entité Users.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez Users dans la liste Entity.
Sélectionnez l'opération Update, puis cliquez sur OK.
Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
```
{
"country": "IN"
}
```
Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur entityId, puis saisissez 113132 dans le champ Valeur par défaut.
Si l'entité comporte des clés primaires composites, vous pouvez définir la filterClause au lieu de spécifier l'entityId. Par exemple, employeeCode='5100' and startDate='2010-01-01 00:00:00'.

Si l'intégration aboutit, le champ connectorOutputPayload de la tâche "Connecteurs" contiendra la réponse de l'opération de mise à jour.

Utiliser la connexion Azure Synapse dans une intégration

Une fois la connexion créée, elle devient disponible dans Apigee Integration et Application Integration. Vous pouvez utiliser la connexion dans une intégration au moyen de la tâche "Connecteurs".

Pour savoir comment créer et utiliser la tâche "Connecteurs" dans Apigee Integration, consultez Tâche "Connecteurs".
Pour savoir comment créer et utiliser la tâche "Connecteurs" dans Application Integration, consultez Tâche "Connecteurs".

Demander de l'aide à la communauté Google Cloud

Vous pouvez publier vos questions et discuter de ce connecteur sur les forums Cloud de la communauté Google Cloud.

Étapes suivantes

Découvrez comment suspendre et reprendre une connexion.
Découvrez comment surveiller l'utilisation des connecteurs.
Découvrez comment afficher les journaux des connecteurs.