SharePoint

Le connecteur SharePoint permet à SQL d'accéder aux services et aux serveurs SharePoint.

Versions compatibles

Ce connecteur est compatible avec Windows SharePoint Services 3.0, Microsoft Office SharePoint Server 2007 et versions ultérieures, et SharePoint Online.

Avant de commencer

Avant d'utiliser le connecteur SharePoint, 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 :

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

    Accéder à la page "Connexions"

  2. Cliquez sur + Créer pour ouvrir la page Créer une connexion.
  3. 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 la page Emplacements.

    2. Cliquez sur Next (Suivant).
  4. Dans la section Détails de connexion, procédez comme suit :
    1. Connecteur: sélectionnez SharePoint 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, 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.
    4. Saisissez éventuellement une Description pour l'instance de connexion.
    5. Vous pouvez également activer Cloud Logging, puis sélectionner un niveau de journalisation. Par défaut, le niveau de journalisation est défini sur Error.
    6. Compte de service : sélectionnez un compte de service disposant des rôles requis.
    7. 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.

    8. Vous pouvez également cliquer sur + Ajouter un libellé pour ajouter un libellé à la connexion sous la forme d'une paire clé/valeur.
    9. Cliquez sur Suivant.
  5. Dans la section Destinations, saisissez les informations concernant l'hôte distant (système backend) auquel vous souhaitez vous connecter.
    1. Type de destination : sélectionnez un type de destination. Par exemple, l'adresse hôte est https://xxxxx.sharepoint.com.
      • Sélectionnez Adresse hôte dans la liste pour spécifier le nom d'hôte ou l'adresse IP de la destination.
      • Si vous souhaitez établir une connexion privée à vos systèmes backend, sélectionnez Rattachement du point de terminaison dans la liste, puis sélectionnez le rattachement du point de terminaison requis dans la liste Rattachement du point de terminaison.

      Si vous souhaitez établir une connexion publique à vos systèmes backend avec une sécurité supplémentaire, vous pouvez envisager de configurer des adresses IP sortantes statiques pour vos connexions, puis de configurer vos règles de pare-feu pour ajouter à la liste d'autorisation uniquement les adresses IP statiques spécifiques.

      Pour saisir d'autres destinations, cliquez sur + Ajouter une destination.

    2. Cliquez sur Suivant.
  6. 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 SharePoint:

      • Identifiants Windows Sélectionnez cette option si vous utilisez l'édition sur site de SharePoint.
      • AzureAD. Sélectionnez cette option si vous utilisez l'édition en ligne de SharePoint.
      • Identifiants client OAuth 2.0 avec support JWT Sélectionnez cette option si vous utilisez des identifiants client OAuth 2.0 avec le support JWT pour l'authentification.
      • Identifiants client OAuth 2.0 avec code secret Sélectionnez cette option si vous utilisez des identifiants client OAuth 2.0 avec code secret du client pour l'authentification.

      2. Pour comprendre comment configurer ces types d'authentification, consultez la section Configurer l'authentification.

    2. Cliquez sur Next (Suivant).
  7. Vérifiez vos informations de connexion et d'authentification.
  8. Cliquez sur Créer.

Configurer l'authentification

Le connecteur SharePoint est compatible avec les types d'authentification suivants:

Type d'authentification des identifiants Windows

Pour activer le type d'authentification par identifiants Windows, procédez comme suit :
  1. Configurez le PSC et créez un rattachement de point de terminaison.
  2. Spécifiez les identifiants dans Google Cloud.

Configurer le PSC et créer un rattachement de point de terminaison

  1. Créez un groupe d'instances avec l'adresse IP de l'hôte SharePoint.
  2. Créez un équilibreur de charge réseau passthrough interne et utilisez le groupe d'instances que vous avez créé comme backend. L'accès mondial doit être activé pour l'équilibreur de charge TCP interne.
  3. Publiez l'équilibreur de charge dans Private Service Connect. Un rattachement de service est généré après la publication de l'équilibreur de charge.
  4. Publiez le service et spécifiez l'équilibreur de charge que vous avez créé.
  5. Utilisez le rattachement de service pour créer un rattachement de point de terminaison.
  6. Après avoir créé le rattachement du point de terminaison, créez une connexion SharePoint avec l'adresse IP du rattachement du point de terminaison.

    7. Pour en savoir plus sur la création d'une pièce jointe de point de terminaison, consultez Créer une pièce jointe de point de terminaison.

Spécifier les informations d'identification Windows dans Google Cloud

Lorsque vous créez la connexion dans les Integration Connectors , vous devez spécifier les informations suivantes:

Dans la section Authentication (Authentification), sélectionnez Windows credentials (Identifiants Windows) comme type d'authentification, puis saisissez les informations suivantes:

  • Nom d'utilisateur: saisissez le nom d'utilisateur.
  • Mot de passe: sélectionnez le mot de passe.
  • Version du secret: saisissez la version du secret.

Type de connexion avec les identifiants Windows

Le tableau suivant présente des exemples de valeurs de configuration pour le type de connexion des identifiants Windows.
Nom du champ Détails
Région us-central1
Connecteur SharePoint
Version du connecteur 1
Nom de connexion sharepoint-staging-psc
Compte de service SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Nombre minimal de nœuds 2
Nombre maximal de nœuds 50
Type de destination Adresse de l'hôte
hôte 1 http://192.0.2.0
port 1 24
Authentification Identifiants Windows
Nom d'utilisateur USER_NAME
Mot de passe MOT DE PASSE
Version de secret 1

Type d'authentification Azure AD

Pour activer le type d'authentification Azure AD, procédez comme suit :
  1. Enregistrez votre application et obtenez les valeurs OAuthClientId et OAuthClientSecret.
  2. Spécifiez les identifiants dans Google Cloud.
  3. Autorisez la connexion dans Google Cloud.
  4. Ajoutez l'URL de redirection à votre application.

Enregistrer votre application et obtenir les valeurs OAuthClientId et OAuthClientSecret

Pour enregistrer votre application et obtenir l'OAuthClientId et l'OAuthClientSecret, procédez comme suit :
  1. Connectez-vous au portail Azure.
  2. Dans Services Azure, sélectionnez Enregistrements d'applications, puis Nouvel enregistrement.
  3. Saisissez un nom d'application, puis sélectionnez Tout locataire Microsoft Entra ID – Multitenant. L'image suivante montre la page Enregistrer une application :
  4. Après avoir créé l'application, accédez à la section Certificats et secrets, créez un code secret du client pour l'application et enregistrez sa valeur. L'image suivante montre la page Certificats et secrets :
  5. Dans Autorisations des API, sélectionnez les autorisations d'application et les autorisations déléguées requises. Pour que la connexion soit active, vous devez accorder l'autorisation minimale suivante:AllSites.Manage

    Le tableau suivant répertorie les autorisations requises pour effectuer des opérations dans l'application.

    Autorisations déléguées Autorisations de l'application
    ConsentRequest.Read.All AllSites.FullControl
    ConsentRequest.ReadWrite.All AllSites.Manage
    DelegatedAdminRelationship.Read.All AllSites.Read
    DelegatedAdminRelationship.ReadWrite.All AllSites.Write
    DelegatedPermissionGrant.Read.All EnterpriseResource.Read
    DelegatedPermissionGrant.ReadWrite.All EnterpriseResource.Write
    Files.Read.All MyFiles.Read
    Files.ReadWrite.All MyFiles.Write
    Group.Create Project.Read
    Group.Read.All Project.Write
    Group.ReadWrite.All ProjectWebApp.FullControl
    Sites.FullControl.All ProjectWebAppReporting.Read
    Sites.FullControl.All Sites.FullControl.All
    Sites.Manage.All Sites.Manage.All
    Sites.Read.All Sites.Read.All
    Sites.ReadWrite.All Sites.ReadWrite.All
    Sites.Selected Sites.Search.All
    User.Export.All Sites.Selected
    User.Read TaskStatus.Submit
    User.Read.All TermStore.Read.All
    User.ReadWrite.All TermStore.Read.All
    TermStore.ReadWrite.All
    TermStore.ReadWrite.All
    User.Read.All
    User.Read.All
    User.ReadWrite.All
    User.ReadWrite.All
  6. Enregistrez les modifications.
  7. Si vous avez choisi d'utiliser des autorisations nécessitant le consentement de l'administrateur, vous pouvez les accorder depuis le locataire actuel sur la page Autorisations des API. L'image suivante montre la page des autorisations des API :
  8. Pour ajouter le champ d'application, accédez à la section Exposer une API, ajoutez des champs d'application AllSites.Manage, Sites.FullControl.All et sélectionnez les personnes autorisées à les contrôler (administrateurs et utilisateurs). L'image suivante montre la page "Présenter une API" :
  9. Cliquez sur Enregistrer.

Spécifiez les identifiants dans Google Cloud.

Lorsque vous créez la connexion dans les Integration Connectors , vous devez spécifier les informations suivantes:

Dans la section Authentication (Authentification), sélectionnez AzureAD comme type d'authentification, puis saisissez les informations suivantes:

  • ID client: saisissez l'ID client utilisé pour demander des jetons d'accès.
  • Champs d'application: saisissez une liste de champs d'application souhaités, séparés par une virgule. Par exemple, Sites.FullControl.All.
  • Code secret du client: saisissez le secret contenant le code secret client de l'application connectée que vous avez créée.
  • Version du secret: version du secret sélectionné ci-dessus.
  • URL d'autorisation: URL d'autorisation générée lors de la création du client. Saisissez l'URL au format suivant: https://login.microsoftonline.com/<tenant_identifier>/oauth2/v2.0/authorize. Par exemple, https://login.microsoftonline.com/9bxxxxxxxxx8112/oauth2/v2.0/authorize.

Autoriser la connexion dans Google Cloud

  1. Sur la page Connexions, recherchez la connexion que vous venez de créer.

    L'état du nouveau connecteur sera Autorisation requise.

  2. Cliquez sur Autorisation requise.

    Le volet Modifier l'autorisation s'affiche.

  3. Copiez la valeur de l'URI de redirection dans votre application externe. Pour en savoir plus, consultez Ajouter l'URL de redirection à votre application.
  4. Vérifiez les informations d'autorisation.
  5. Cliquez sur Autoriser.

    Si l'autorisation aboutit, l'état de la connexion est défini sur Active sur la page Connexions.

Ajouter l'URL de redirection à votre application

  1. Dans le portail Azure, cliquez sur Services Azure > Enregistrements d'applications.
  2. Cliquez sur le nom de votre application.
  3. Cliquez sur "Ajouter un URI de redirection".
  4. Cliquez sur Ajouter une plate-forme.
  5. Dans la boîte de dialogue Web, collez l'URI de redirection que vous avez copié lorsque vous avez autorisé la connexion dans Google Cloud.

Type de connexion Azure AD

Le tableau suivant présente des exemples de valeurs de configuration pour le type de connexion Azure AD:
Nom du champ Détails
Région us-central1
Connecteur SharePoint
Version du connecteur 1
Nom de connexion sharepoint-google-cloud-con
Compte de service SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Nombre minimal de nœuds 2
Nombre maximal de nœuds 50
Type de destination Adresse de l'hôte
hôte 1 http://z8**.sharepoint.com
Authentification AzureAD
ID client CLIENT_ID
Niveaux d'accès Sites.FullControl.All
Code secret du client CLIENT_SECRET
Version de secret 1
URL d'autorisation https://login.microsoftonline.com/{tenant-id}/oauth2/v2.0/authorize

OAuth 2.0 : identifiants client avec le type d'authentification par jeton porteur JWT

Pour activer OAuth 2.0 - identifiants client avec le type d'authentification du support JWT, procédez comme suit :
  1. Créez un certificat.
  2. Importez le certificat sur le portail Azure.
  3. Obtenez une clé privée.
  4. Terminez la configuration.
  5. Spécifiez les identifiants de porteur JWT OAuth 2.0 dans Google Cloud.

Pour activer le type d'authentification par porteur JWT, vous devez créer un certificat, l'importer dans le portail Azure, puis obtenir une clé privée.

Créer un certificat

  1. Créez un dossier vide sur votre ordinateur.
  2. Créez un fichier texte dans le dossier.
  3. Copiez le script PowerShell de la page Accorder l'accès via Azure AD "Application uniquement" , puis collez-le dans le fichier texte.
  4. Renommez le fichier texte en Create-SelfSignedCertificate.ps1.
  5. Exécutez Windows PowerShell dans le dossier.
  6. Accédez au répertoire contenant le fichier texte.
  7. Copiez la commande suivante : .\Create-SelfSignedCertificate.ps1 -CommonName "CERTIFICATE_NAME" -StartDate 2022-09-25 -EndDate 2023-10-25

    Saisissez un nom unique pour CERTIFICATE_NAME. Remplacez la valeur StartDate par la date actuelle et la valeur EndDate par une date de votre choix.

  8. Collez la commande copiée avec vos modifications dans Windows PowerShell, puis appuyez sur Entrée.

    Windows PowerShell vous invite à saisir le mot de passe pour protéger la clé privée. Veillez à enregistrer le mot de passe pour une utilisation ultérieure.

    Windows PowerShell crée deux fichiers: MyCertificate.pfx et MyCertificate.cer.

Importer le certificat dans le portail Azure

  1. Connectez-vous au portail Azure, puis enregistrez une application en spécifiant les informations suivantes :
    • Nom: saisissez un nom pour l'application.
    • Types de comptes compatibles: sélectionnez Comptes dans cet annuaire organisationnel uniquement (nom du compte uniquement - client unique).
  2. Accédez à Autorisations de l'API > Ajouter une autorisation > Demander des autorisations d'API > SharePoint.
  3. Sélectionnez Autorisations de l'application, puis ajoutez les autorisations requises.
  4. Sélectionnez Accorder l'autorisation de l'administrateur, puis Oui.
  5. Après avoir créé l'application, accédez à la section Certificats et secrets.
  6. Sélectionnez Importer un certificat, puis importez votre certificat CER depuis votre ordinateur. Une fois l'importation terminée, sélectionnez Ajouter.

    N'ajoutez pas de codes secrets client dans l'application, car ils interfèrent avec le flux d'authentification basé sur les certificats.

  7. Accédez à "Manifest" (Fichier manifeste), recherchez "KeyCredentials" (Identifiants de clé), puis copiez le customKeyIdentifier en tant qu'empreinte. Vous l'utiliserez plus tard. Vous avez maintenant enregistré l'application et associé le certificat.

Obtenir une clé privée

Vous pouvez obtenir une clé privée en convertissant le fichier PFX en fichier PEM à l'aide d'OpenSSL.

  1. Depuis l'invite de commande, accédez au dossier contenant votre fichier PFX, puis exécutez la commande suivante : openssl pkcs12 -in MyCertificate.pfx -out MyCertificate.pem -nodes
  2. Saisissez le mot de passe PFX que vous avez utilisé lors du processus de création du certificat.
  3. Ouvrez le fichier PEM dans un éditeur de texte et copiez la section suivante de la clé privée: 
    -----BEGIN PRIVATE KEY----- 

-----END PRIVATE KEY-----

Terminer la configuration

  1. Copiez l'ID client et l'ID de locataire de l'application nouvellement enregistrée dans le portail Azure.
  2. Connectez-vous à l'aide de l'authentification par compte de service principal de liste SharePoint avec les identifiants suivants:
    • ID client
    • ID du locataire
    • Clé privée
    • Empreinte (mot de passe de la clé privée)

Spécifier les identifiants de porteur JWT OAuth 2.0 dans Google Cloud

Lorsque vous créez la connexion dans les Integration Connectors , vous devez spécifier les informations suivantes:

Dans la section Authentification, sélectionnez Identifiants client OAuth 2.0 avec support JWT comme type d'authentification, puis saisissez les informations suivantes:

  • ID client: saisissez l'ID client utilisé pour demander des jetons d'accès. Il s'agit de la clé client générée lorsque vous avez enregistré l'application dans le portail Azure.
  • Clé privée: sélectionnez le secret Secret Manager contenant le contenu du fichier de clé privée au format PEM. La clé privée doit correspondre à la clé publique/au certificat fournis au connecteur.
  • Version du secret: version du secret sélectionné ci-dessus.
  • Mot de passe de la clé privée: sélectionnez le secret Secret Manager contenant le mot de passe (paraphrase) du fichier de clé privée.
  • Version du secret: version du secret sélectionné ci-dessus.
  • Locataire Azure: locataire Microsoft Online utilisé pour accéder aux données.

Type de connexion du certificat d'assistance JWT

Le tableau suivant présente des exemples de valeurs de configuration pour le type de connexion de certificat d'entité de soutien JWT OAuth 2.0.
Nom du champ Détails
Région europe-west1
Connecteur SharePoint
Version du connecteur 1
Nom de connexion sharepoint-jwt-certificate
Compte de service SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Nombre minimal de nœuds 2
Nombre maximal de nœuds 50
Type de destination Adresse de l'hôte
hôte 1 http://z8**.sharepoint.com
port 1 ****
Authentification Identifiants client OAuth 2.0 avec support JWT
ID client OAuth CLIENT_ID
Clé privée CLÉ
Version de secret 1
Mot de passe de la clé privée MOT DE PASSE
Version de secret 1
Locataire Azure AZURE_TENANT_ID

OAuth 2.0 : type de connexion code secret du client

Pour activer le type de connexion avec le code secret du client OAuth 2.0, procédez comme suit:

  1. Enregistrez le module complémentaire.
  2. Accordez des autorisations au module complémentaire.
  3. Spécifier les identifiants client OAuth 2.0 dans Google Cloud
  4. Effectuer une nouvelle autorisation au code d'autorisation

Enregistrer le module complémentaire

  1. Accédez à la page Register Add-In (Enregistrer le complément) à l'aide de l'URL suivante: https://<SITE_NAME>.SharePoint.com/_layouts/15/appregnew.aspx.
  2. Dans la section Informations sur l'application, générez l'ID client et le code secret du client.
  3. Spécifiez les valeurs pour le titre, le domaine de l'application et l'URI de redirection.
  4. Cliquez sur Créer.Le complément est enregistré, et l'application SharePoint affiche les informations créées.

Accorder des autorisations au complément

  1. Accédez au site SharePoint à l'aide de l'URL suivante : https://<SITE_NAME>-admin.sharepoint.com/_layouts/15/appinv.aspx. Vous êtes redirigé vers la page Accorder l'autorisation.
  2. Dans le champ App ID (ID de l'application), saisissez l'ID client que vous avez généré précédemment, puis cliquez sur Lookup (Rechercher). Les valeurs de "Titre", "Domaine de l'application" et "URL de redirection" sont renseignées.
  3. Saisissez la demande d'autorisation suivante au format XML: 
    <AppPermissionRequests AllowAppOnlyPolicy="true">
<AppPermissionRequest Scope="http://sharepoint/content/tenant" Right="FullControl"/>
</AppPermissionRequests>
  4. Cliquez sur Créer. L'application Sharepoint affiche une boîte de dialogue de consentement aux autorisations.
  5. Cliquez sur Approuver.

Spécifier les identifiants client OAuth 2.0 dans Google Cloud

Lorsque vous créez la connexion dans Integration Connectors , vous devez spécifier les informations suivantes:

Dans la section Authentification, sélectionnez Identifiants client OAuth 2.0 avec code secret comme type d'authentification, puis saisissez les informations suivantes:

  • ID client: saisissez l'ID client fourni par le connecteur pour l'application que vous avez créée.
  • Code secret du client: sélectionnez le secret Secret Manager contenant le code secret client pour l'application connectée que vous avez créée.
  • Version du secret: sélectionnez la version du code secret du client.

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 SharePoint, vous devez autoriser à nouveau votre connexion SharePoint. Pour réautoriser une connexion, procédez comme suit:

  1. Cliquez sur la connexion requise sur la page Connexions.

    La page des détails de la connexion s'ouvre.

  2. Cliquez sur Modifier pour modifier les détails de la connexion.
  3. Vérifiez les informations OAuth 2.0 – Code d'autorisation dans la section Authentification.

    Si nécessaire, apportez les modifications nécessaires.

  4. Cliquez sur Enregistrer. Vous êtes redirigé vers la page d'informations sur la connexion.
  5. Cliquez sur Modifier l'autorisation dans la section Authentification. Le volet Authorize (Autoriser) s'affiche.
  6. Cliquez sur Autoriser.

    Si l'autorisation aboutit, l'état de la connexion est défini sur Active sur la page Connexions.

Type de connexion des identifiants client

Le tableau suivant présente des exemples de valeurs de configuration pour le type de connexion par identifiants client OAuth 2.0.
Nom du champ Détails
Région europe-west1
Connecteur SharePoint
Version du connecteur 1
Nom de connexion sharepoint-client-credentials
Compte de service SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Nombre minimal de nœuds 2
Nombre maximal de nœuds 50
Type de destination Adresse de l'hôte
hôte 1 http://z8**.sharepoint.com
port 1 ****
Authentification Identifiants client OAuth 2.0 avec code secret du client
ID client CLIENT_ID
Code secret du client CLIENT_SECRET
Version de secret 1

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 répertorié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.

Actions

Cette section liste certaines des actions compatibles avec le connecteur. Pour savoir comment configurer les actions, consultez Exemples d'actions.

Action DeleteAttachment

Cette action supprime une pièce jointe.

Paramètres d'entrée de l'action DeleteAttachment

Nom du paramètre Type de données Requis Description
ListTitle Chaîne Oui Titre de l'élément de liste.
ItemId Chaîne Oui Identifiant de l'élément de liste.
Nom du fichier Chaîne Oui Nom du fichier à supprimer de la bibliothèque de documents.

Pour savoir comment configurer l'action DeleteAttachment, consultez la section Exemples d'actions.

Action CheckInDocument

Cette action vous permet de mettre en dépôt un document.

Paramètres d'entrée de l'action CheckInDocument

Nom du paramètre Type de données Requis Description
RelativeURL Chaîne Oui URL relative du dossier.
DocumentName Chaîne Oui Nom du fichier à enregistrer.
Commentaire Chaîne Non Message de check-in facultatif.

Pour savoir comment configurer l'action CheckInDocument, consultez la section Exemples d'actions.

Action CheckOutDocument

Cette action vous permet de consulter un fichier.

Paramètres d'entrée de l'action CheckOutDocument

Nom du paramètre Type de données Requis Description
RelativeURL Chaîne Oui URL relative du dossier.
DocumentName Chaîne Oui Nom du fichier à extraire.

Pour savoir comment configurer l'action CheckOutDocument, consultez la section Exemples d'actions.

Action DiscardCheckOutDocument

Cette action vous permet d'annuler le check-out d'un fichier.

Paramètres d'entrée de l'action DiscardCheckOutDocument

Nom du paramètre Type de données Requis Description
RelativeURL Chaîne Oui URL relative du dossier.
DocumentName Chaîne Oui Nom du fichier pour lequel le check-out doit être annulé.

Pour savoir comment configurer l'action DiscardCheckOutDocument, consultez la section Exemples d'actions.

Action CopyDocument

Cette action vous permet de copier un fichier d'un emplacement à un autre.

Paramètres d'entrée de l'action CopyDocument

Nom du paramètre Type de données Requis Description
SourceFileRelativeUrl Chaîne Oui URL relative du fichier source.
DestFileRelativeUrl Chaîne Oui URL relative du fichier de destination.

Pour savoir comment configurer l'action CopyDocument, consultez la section Exemples d'actions.

Action UploadDocument

Cette action vous permet d'importer un fichier.

Paramètres d'entrée de l'action UploadDocument

Nom du paramètre Type de données Requis Description
Nom du fichier Chaîne Oui Nom du fichier à importer.
RelativeUrl Chaîne Oui URL relative du dossier.
Contenu Chaîne Non Contenu à importer en tant que fichier.
ContentBytes Chaîne Non Contenu en octets (sous forme de chaîne Base64) à importer en tant que fichier. Utilisez-le pour importer des données binaires.
HasBytes Booléen Non Indique si le contenu à importer est binaire. La valeur par défaut est false.

Pour savoir comment configurer l'action UploadDocument, consultez la section Exemples d'actions.

Action DownloadDocument

Cette action vous permet de télécharger un fichier.

Paramètres d'entrée de l'action DownloadDocument

Nom du paramètre Type de données Requis Description
RemoteFile Chaîne Oui URL complète du fichier à télécharger.
Bibliothèque Chaîne Oui Nom de la bibliothèque sur le serveur SharePoint.
HasBytes Booléen Non Indique si le contenu doit être téléchargé sous forme d'octets. La valeur par défaut est false.

Pour savoir comment configurer l'action DownloadDocument, consultez la section Exemples d'actions.

Action MoveAttachmentOrDocument

Cette action vous permet de déplacer un fichier d'un dossier à un autre.

Paramètres d'entrée de l'action MoveAttachmentOrDocument

Nom du paramètre Type de données Requis Description
SourceFileURL Chaîne Oui URL du fichier source à déplacer.
DestinationFolderURL Chaîne Oui URL du dossier de destination.

Pour savoir comment configurer l'action MoveAttachmentOrDocument, consultez la section Exemples d'actions.

Action "CreateFolder" (Créer un dossier)

Cette action vous permet de créer un dossier.

Paramètres d'entrée de l'action CreateFolder

Nom du paramètre Type de données Requis Description
RelativeURL Chaîne Oui URL relative du dossier.
FolderName Chaîne Oui Nom du dossier à créer.

Pour savoir comment configurer l'action CreateFolder, consultez la section Exemples d'actions.

Action "AddAttachments" (Ajouter des pièces jointes)

Cette action vous permet d'ajouter une pièce jointe.

Paramètres d'entrée de l'action AddAttachments

Nom du paramètre Type de données Requis Description
ListTitle Chaîne Oui Nom de la liste des pièces jointes.
Nom du fichier Chaîne Oui Nom du fichier en pièce jointe.
ItemId Chaîne Oui ID de la pièce jointe à ajouter.
Contenu Chaîne Oui Contenu de la pièce jointe.
ContentBytes Chaîne Non Contenu en octets (sous forme de chaîne Base64) à importer en tant que pièce jointe. Utilisez-le pour importer des données binaires.
HasBytes Booléen Non Indique si le contenu à importer est binaire. La valeur par défaut est false.

Pour savoir comment configurer l'action AddAttachments, consultez la section Exemples d'actions.

Action DownloadAttachments

Cette action vous permet de télécharger les pièces jointes.

Paramètres d'entrée de l'action DownloadAttachments

Nom du paramètre Type de données Requis Description
RemoteFile Chaîne Oui URL relative du fichier.
HasBytes Booléen Non Indique si le contenu à télécharger est binaire. La valeur par défaut est false.

Pour savoir comment configurer l'action DownloadAttachments, consultez la section Exemples d'actions.

Exemples d'actions

Cette section explique comment effectuer certaines actions dans ce connecteur.

Exemple : Supprimer une pièce jointe

Cet exemple supprime le fichier spécifié.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action DeleteAttachment, puis cliquez sur OK.
  3. 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: 
    {
"ListTitle": "My lists",
"ItemId": "1",
"FileName": "sitepages.txt"
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche DeleteAttachment aura une valeur semblable à celle-ci:

    [{
"Status": "Success"
}]

Exemple : Enregistrer un document

Cet exemple vérifie un document.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action CheckInDocument, puis cliquez sur OK.
  3. 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: 
    {
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.txt",
"Comment": "Comment test"
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche CheckInDocument aura une valeur semblable à celle-ci:

    [{
"Status": "Success"
}]

Exemple : Extraire un fichier

Cet exemple extrait un fichier.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action CheckOutDocument, puis cliquez sur OK.
  3. 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: 
    {
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.txt"
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche CheckOutDocument aura une valeur semblable à celle-ci:

    [{
"Status": "Success"
}]

Exemple : Supprimer un check-out

Cet exemple annule un check-out de fichier.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action DiscardCheckOutDocument, puis cliquez sur OK.
  3. 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: 
    {
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.docx"
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche DiscardCheckOutDocument aura une valeur semblable à celle-ci:

    [{
"Status": "Success"
}]

Exemple : Copier un fichier

Cet exemple copie un fichier d'un emplacement à un autre.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action CopyDocument, puis cliquez sur OK.
  3. 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: 
    {
"SourceFileRelativeUrl": "/Shared Documents/Document.docx",
"DestFileRelativeUrl": "/Shared Documents/TestFolder/Document123.docx"
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche CopyDocument aura une valeur semblable à celle-ci:

    [{
"Status": "Success"
}]

Exemple : Importer un fichier texte

Cet exemple importe un fichier texte à l'emplacement spécifié.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action UploadDocument, puis cliquez sur OK.
  3. 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: 
    {
"FileName": "test.txt",
"RelativeUrl": "/Shared Documents/TestFolder",
"Content": "abcd"
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche UploadDocument aura une valeur semblable à celle-ci:

    [{
"Status": "Success"
}]

Exemple : Importer un fichier binaire

Cet exemple importe un fichier binaire à l'emplacement spécifié. Lorsque vous importez un fichier binaire, spécifiez le contenu à importer sous forme de chaîne encodée en base64.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action UploadDocument, puis cliquez sur OK.
  3. 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: 
    {
"FileName": "test.txt",
"RelativeUrl": "/Shared Documents/TestFolder",
"ContentBytes": "SGVsbG8gd29ybGQK",
"HasBytes": "true"
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche UploadDocument aura une valeur semblable à celle-ci:

    [{
"Status": "Success"
}]

Exemple : Télécharger un fichier

Cet exemple télécharge un fichier.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action DownloadDocument, puis cliquez sur OK.
  3. 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: 
    {
"RemoteFile": "/TestFolder/test.txt",
"Library": "Shared Documents"
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche DownloadDocument aura une valeur semblable à celle-ci:

    [{
"Success": "True",
"Content": "Test File",
}]

Exemple : Télécharger un fichier binaire

Cet exemple télécharge un fichier binaire.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action DownloadDocument, puis cliquez sur OK.
  3. 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: 
    {
"RemoteFile": "/TestFolder/test1.png",
"Library": "Shared Documents"
"HasBytes": "true"  
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche DownloadDocument aura une valeur semblable à celle-ci:

    [{
"Success": "True",
"ContentBytes": "VGVzdCBGaWxl",
}]

Exemple : Déplacer une pièce jointe

Cet exemple déplace une pièce jointe d'un emplacement à un autre.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action MoveAttachmentOrDocument, puis cliquez sur OK.
  3. 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: 
    {
"SourceFileURL": "/Shared Documents/test.txt",
"DestinationFolderURL": "/Shared Documents/TestFolder"
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche MoveAttachmentOrDocument aura une valeur semblable à celle-ci:

    [{
"Result": "Success"
}]

Exemple : Créer un dossier

Cet exemple crée un dossier à l'emplacement spécifié.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action CreateFolder, puis cliquez sur OK.
  3. 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: 
    {
"RelativeURL": "/Shared Documents/TestFolder",
"FolderName": "TestFolder123"
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche CreateFolder aura une valeur semblable à celle-ci:

    [{
"Id": "110842b7-2393-4f11-9391-3d75214e9fb8",
"Status": "Success"
}]

Exemple : Ajouter une pièce jointe

Cet exemple ajoute une pièce jointe à la liste spécifiée.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action AddAttachments, puis cliquez sur OK.
  3. 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: 
    {
"ListTitle": "My Lists",
"FileName": "TestAttachment2",
"Content": "abcd text",
"ItemId": "1"
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche AddAttachments aura une valeur semblable à celle-ci:

    [{
"RelativeUrl": "/Lists/My lists/Attachments/1/TestAttachment2",
"Status": "Success"
}]

Exemple : Ajouter une pièce jointe binaire

Cet exemple ajoute une pièce jointe binaire à la liste spécifiée.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action AddAttachments, puis cliquez sur OK.
  3. 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: 
    {
"ListTitle": "My Lists",
"FileName": "TestAttachment3",
"ContentBytes": "VGVzdCBGaWxl",
"HasBytes": "true",  
"ItemId": "1"
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche AddAttachments aura une valeur semblable à celle-ci:

    [{
"RelativeUrl": "/Lists/My lists/Attachments/1/TestAttachment3",
"Status": "Success"
}]

Exemple : Télécharger une pièce jointe

Cet exemple télécharge une pièce jointe.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action DownloadAttachments, puis cliquez sur OK.
  3. 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: 
    {
"RemoteFile": "/Shared Documents/Document.txt"
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche DownloadAttachments aura une valeur semblable à celle-ci:

    [{
"Success": "True",
"Content": "Test File",
}]

Exemple : Télécharger une pièce jointe binaire

Cet exemple télécharge une pièce jointe binaire.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action DownloadAttachments, puis cliquez sur OK.
  3. 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: 
    {
"RemoteFile": "/Shared Documents/Document.docx",
"HasBytes": "true"
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche DownloadAttachments aura une valeur semblable à celle-ci:

    [{
"Success": "True",
"ContentBytes": "VGVzdCBGaWxl",
}]

Exemples d'opérations d'entité

Cette section explique comment effectuer certaines opérations d'entité dans ce connecteur.

Exemple : Lister tous les fichiers

Cet exemple liste tous les fichiers de l'entité Files.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Files dans la liste Entity.
  3. Sélectionnez l'opération List, puis cliquez sur OK.
  4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), vous pouvez filtrer votre ensemble de résultats en spécifiant une clause de filtre. Vous pouvez également spécifier plusieurs conditions de filtre à l'aide des opérateurs logiques.

Exemple : Obtenir une liste

Cet exemple récupère une liste avec l'ID spécifié à partir de l'entité My Lists.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez My Lists dans la liste Entity.
  3. Sélectionnez l'opération Get, puis cliquez sur OK.
  4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur EntityId, puis saisissez 3 dans le champ Default Value (Valeur par défaut).

    Ici, 3 est une valeur de clé primaire dans l'entité My Lists.

Exemple : Créer un enregistrement

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

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez My Lists dans la liste Entity.
  3. Sélectionnez l'opération Create, puis cliquez sur OK.
  4. 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: 
    {
"AuthorId": 11.0, 
"BaseName": "3_",
"Attachments": false,
"Title": "Created List New"
}

    Si l'intégration aboutit, le champ connectorOutputPayload de votre tâche de connecteur aura une valeur semblable à celle-ci:

    [{
"ID": 3.0
}]

Exemple : Supprimer un enregistrement

Cet exemple supprime l'enregistrement associé à l'ID spécifié dans l'entité My Lists.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez My Lists dans la liste Entity.
  3. Sélectionnez l'opération Delete, puis cliquez sur OK.
  4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur entityId, puis saisissez 2 dans le champ Default Value (Valeur par défaut).

Utiliser la connexion SharePoint 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