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 :
- Vérifiez que la connectivité réseau est configurée. Pour en savoir plus sur les modèles de réseau, consultez la section 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 compte Google spécial 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 la section 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 la page Activer des services.
Si ces services ou autorisations n'ont pas encore été activés pour votre projet, vous êtes invité à les activer lors de la configuration du connecteur.
Configurer le connecteur
Pour configurer le connecteur, vous devez créer une connexion à votre source de données (système backend). Une connexion est spécifique à 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 Integration Connectors > Connections (Connecteurs d'intégration > Connexions), puis sélectionnez ou créez un projet Google Cloud.
- Cliquez sur + Créer pour ouvrir la page Créer une connexion.
- Dans la section Emplacement, choisissez l'emplacement de la connexion.
- 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 la page Emplacements.
- Cliquez sur Next (Suivant).
- Région : sélectionnez un emplacement dans la liste déroulante.
- Dans la section Détails de connexion, procédez comme suit :
- Connecteur: sélectionnez Azure Synapse dans la liste déroulante des connecteurs disponibles.
- Version du connecteur : sélectionnez la version du connecteur dans la liste déroulante des versions disponibles.
- Dans le champ Nom de connexion, saisissez un nom pour l'instance de connexion.
Les noms de connexion doivent répondre aux critères suivants :
- Les noms de connexion peuvent contenir des lettres, des chiffres ou des traits d'union.
- Les lettres doivent être en minuscules.
- Les noms de connexion doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
- Les noms de connexion ne peuvent pas dépasser 49 caractères.
- Saisissez éventuellement une description pour l'instance de connexion.
- Compte de service : sélectionnez un compte de service disposant des rôles requis.
- Vous pouvez également configurer les paramètres du nœud 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 plus de transactions pour une connexion, plus de nœuds sont nécessaires. À l'inverse, moins de nœuds sont nécessaires pour traiter moins de transactions. Pour comprendre comment les nœuds affectent la tarification de votre connecteur, consultez la section 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 une meilleure disponibilité) et le nombre maximal sur 50.
- Azure Tenant: cette propriété spécifie le locataire Microsoft Azure utilisé pour accéder aux données.
- Database (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é .
- Sous "Destinations", saisissez les propriétés suivantes:
- Type de destination: sélectionnez "Adresse hôte" dans le menu déroulant.
- Hôte 1: saisissez le point de terminaison du pool de SQL
- Port 1: saisissez le port du point de terminaison SQL.
-
Vous pouvez également saisir les propriétés suivantes pour SSL :
- Enable SSL (Activer le service SSL) : cette propriété de case à cocher indique si le service SSL doit être activé.
- Trust Store (Magasin de confiance) : cette propriété spécifie le magasin de confiance. Vous pouvez sélectionner une case d'option pour choisir le magasin de confiance 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.
- Vous pouvez également cliquer sur + Ajouter un libellé pour ajouter un libellé à la connexion sous la forme d'une paire clé/valeur.
- Cliquez sur Suivant.
-
Dans la section Authentification, saisissez les informations d'authentification.
- 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
- Cliquez sur Next (Suivant).
Pour comprendre comment configurer ces types d'authentification, consultez la section Configurer l'authentification.
- Sélectionnez un type d'authentification, puis saisissez les informations appropriées.
- Vérifiez vos informations de connexion et d'authentification.
- Cliquez sur Créer.
Configurer l'authentification
Saisissez les détails 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 dans le portail Azure.
- Champ d'application:liste des champs d'application souhaités, séparés par une virgule.
- Code secret client: secret Secret Manager contenant la clé d'accès au compte.
- URL d'autorisation: URL d'autorisation générée lors de la création du client.
É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 suivantes 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 est 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 informations d'autorisation.
- Cliquez sur Autoriser.
Si l'autorisation aboutit, l'état de la connexion est défini sur Active sur la page Connexions.
Effectuer une nouvelle autorisation au 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 réautoriser une connexion, procédez comme suit:
- Cliquez sur la connexion requise sur la page Connexions.
La page des détails de la connexion s'ouvre.
- Cliquez sur Modifier pour modifier les détails de la connexion.
- Vérifiez les informations OAuth 2.0 – Code d'autorisation dans la section Authentification.
Si nécessaire, apportez les modifications nécessaires.
- Cliquez sur Enregistrer. Vous êtes redirigé vers la page d'informations sur la connexion.
- Cliquez sur Modifier l'autorisation dans la section Authentification. Le volet Authorize (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 via 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é. 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, dans un connecteur de serveur de fichiers, les dossiers sont les entités et, dans un connecteur de système de messagerie, les files d'attente sont les entités.
Toutefois, il est possible qu'un connecteur ne soit pas compatible 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é. Vous pouvez effectuer l'une des opérations suivantes sur une entité :
La sélection d'une entité dans la liste disponible 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 de connecteur. Toutefois, si un connecteur n'est pas compatible avec l'une des opérations d'entité, ces opérations non compatibles ne sont pas listées dans la liste
Operations
. - Action : une action est une fonction de première classe mise à la disposition de l'intégration via 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 ne prenne en charge aucune action, auquel cas la liste
Actions
est vide.
Limites du système
Le connecteur Azure Synapse peut traiter un maximum de quatre transactions par seconde et par nœud, et limite les transactions dépassant cette limite. Par défaut, les Integration Connectors allouent deux nœuds (pour une meilleure disponibilité) à une connexion.
Pour en savoir plus sur les limites applicables à Integration Connectors, consultez la section Limites.
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
- ENT
- ARGENT
- 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 au format compatible avec votre 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 enregistrée, procédez comme suit :
- Suivez les instructions détaillées pour ajouter une tâche de connecteurs.
- Lorsque vous configurez la tâche de connecteur, 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 :
- 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. - 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
- Pour mettre à jour la requête personnalisée, cliquez sur Modifier le script personnalisé. La boîte de dialogue Éditeur de script s'affiche.
- 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 colonneLastName
:SELECT * FROM Employees where LastName=?
- 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.
Pour ajouter des paramètres de requête, procédez comme suit :
- Dans la liste Type, sélectionnez le type de données du paramètre.
- Dans le champ Valeur, saisissez la valeur du paramètre.
- Pour ajouter plusieurs paramètres, cliquez sur + Ajouter un paramètre de requête.
- Dans le champ Délai d'inactivité après, saisissez le nombre de secondes d'attente jusqu'à l'exécution de la 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 surEntities
. - Sélectionnez
Users
dans la listeEntity
. - Sélectionnez l'opération
List
, puis cliquez sur OK. - Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (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'
, seuls les enregistrements dont le code employé est 5100 et la date de début est 2010-01-01 00:00:00 sont affichés.
Exemple : Obtenir un enregistrement unique à partir d'une entité
Cet exemple extrait un enregistrement de l'entité Users
.
- Dans la boîte de dialogue
Configure connector task
, cliquez surEntities
. - Sélectionnez
User
dans la listeEntity
. - Sélectionnez l'opération
Get
, puis cliquez sur OK. - Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur entityId, puis saisissez
103032
dans le champ Default Value (Valeur par défaut).Ici,
103032
est la valeur de 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 surEntities
. - Sélectionnez
Users
dans la listeEntity
. - Sélectionnez l'opération
Delete
, puis cliquez sur OK. - Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur entityId, puis saisissez
113132
dans le champ Default Value (Valeur par défaut).Si l'entité possède des clés primaires composites au lieu de spécifier l'entityId, vous pouvez également définir le filterClause. 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 surEntities
. - Sélectionnez
Users
dans la listeEntity
. - 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 champDefault 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 du connecteur contient 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 surEntities
. - Sélectionnez
Users
dans la listeEntity
. - 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 champDefault Value
:{ "country": "IN" }
- Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur entityId, puis saisissez
113132
dans le champ Default Value (Valeur par défaut).Si l'entité possède des clés primaires composites au lieu de spécifier l'entityId, vous pouvez également définir le filterClause. Par exemple,
employeeCode='5100' and startDate='2010-01-01 00:00:00'
.
Si l'intégration aboutit, le champ connectorOutputPayload
de la tâche du connecteur contient 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 à la fois dans Apigee Integration et Application Integration. Vous pouvez utiliser la connexion dans une intégration via la tâche Connecteurs.
- Pour découvrir comment créer et utiliser la tâche Connecteurs dans Apigee Integration, consultez la section Tâche Connecteurs.
- Pour savoir comment créer et utiliser la tâche Connecteurs dans Application Integration, consultez la section Tâche Connecteurs.
Obtenir de l'aide auprès de la communauté Google Cloud
Vous pouvez publier vos questions et discuter de ce connecteur sur les forums Cloud de la communauté Google Cloud.Étape suivante
- Découvrez comment suspendre et réactiver une connexion.
- Découvrez comment surveiller l'utilisation des connecteurs.
- Découvrez comment afficher les journaux des connecteurs.