Ultimate

Créez un Azure Event Hubs connexion source à l’aide de la fonction Flow Service API

Dernière mise à jour : 2023-10-26
  • Rubriques :
  • Sources
    Afficher plus sur ce sujet
  • Créé pour :
  • Developer
    User
    Admin
    Leader
IMPORTANT

La variable Azure Event Hubs source est disponible dans le catalogue des sources pour les utilisateurs qui ont acheté Real-time Customer Data Platform Ultimate.

Ce tutoriel décrit les étapes à suivre pour créer une Azure Event Hubs (ci-après dénommés "Event Hubs") à l’Experience Platform, à l’aide de la variable Flow Service API.

Prise en main

Ce guide nécessite une compréhension professionnelle des composants suivants d’Adobe Experience Platform :

  • Sources : Experience Platform permet d’ingérer des données provenant de diverses sources tout en vous offrant la possibilité de structurer, d’étiqueter et d’améliorer les données entrantes à l’aide des services Platform.
  • Sandbox : Experience Platform fournit des sandbox virtuels qui divisent une instance Platform unique en environnements virtuels distincts pour favoriser le développement et l’évolution d’applications d’expérience digitale.

Les sections suivantes contiennent des informations supplémentaires que vous devez connaître pour réussir à connecter Event Hubs à Platform à l’aide de l’API Flow Service.

Collecter les informations d’identification requises

Pour Flow Service pour vous connecter à Event Hubs , vous devez fournir des valeurs pour les propriétés de connexion suivantes :

Informations d’identification Description
sasKeyName Nom de la règle d’autorisation, également connu sous le nom de clé SAS.
sasKey La clé primaire de la variable Event Hubs espace de noms. La variable sasPolicy que la variable sasKey correspond à doit avoir manage les droits configurés pour Event Hubs liste à renseigner.
namespace L’espace de noms de la variable Event Hubs vous y accédez. Un Event Hubs L’espace de noms fournit un conteneur d’étendue unique, dans lequel vous pouvez créer un ou plusieurs Event Hubs.
connectionSpec.id La spécification de connexion renvoie les propriétés du connecteur d’une source, y compris les spécifications d’authentification liées à la création des connexions de base et source. L’identifiant de spécification de connexion Event Hubs est : bf9f5905-92b7-48bf-bf20-455bc6b60a4e.
Informations d’identification Description
sasKeyName Nom de la règle d’autorisation, également connu sous le nom de clé SAS.
sasKey La clé primaire de la variable Event Hubs espace de noms. La variable sasPolicy que la variable sasKey correspond à doit avoir manage les droits configurés pour Event Hubs liste à renseigner.
namespace L’espace de noms de la variable Event Hubs vous y accédez. Un Event Hubs L’espace de noms fournit un conteneur d’étendue unique, dans lequel vous pouvez créer un ou plusieurs Event Hubs.
eventHubName Le nom de votre Event Hubs source.
connectionSpec.id La spécification de connexion renvoie les propriétés du connecteur d’une source, y compris les spécifications d’authentification liées à la création des connexions de base et source. L’identifiant de spécification de connexion Event Hubs est : bf9f5905-92b7-48bf-bf20-455bc6b60a4e.

Pour plus d’informations sur ces valeurs, voir ce document Événements Hub.

Utiliser les API Platform

Pour plus d’informations sur la manière d’effectuer avec succès des appels vers les API Platform, consultez le guide sur la Prise en main des API Platform.

Créer une connexion de base

CONSEIL

Une fois créé, vous ne pouvez pas modifier le type d'authentification d'un Event Hubs connexion de base. Pour modifier le type d'authentification, vous devez créer une nouvelle connexion de base.

La première étape de création d’une connexion source consiste à authentifier votre source Event Hubs et à générer un identifiant de connexion de base. Un identifiant de connexion de base vous permet d’explorer et de parcourir les fichiers de votre source et d’identifier les éléments spécifiques à ingérer, y compris des informations concernant leurs types et formats de données.

Pour créer un identifiant de connexion de base, envoyez une requête POST au point d’entrée /connections lors de la fourniture des informations d’identification d’authentification Event Hubs dans le cadre des paramètres de requête.

Format d’API

POST /connections

Pour créer un compte à l’aide de l’authentification standard, envoyez une demande de POST à la fonction /connections point de terminaison tout en fournissant des valeurs pour votre sasKeyName, sasKey, et namespace.

 Requête
curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/connections' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
      "name": "Azure Event Hubs connection",
      "description": "Connector for Azure Event Hubs",
      "auth": {
          "specName": "Azure EventHub authentication credentials",
          "params": {
              "sasKeyName": "{SAS_KEY_NAME}",
              "sasKey": "{SAS_KEY}",
              "namespace": "{NAMESPACE}"
          }
      },
      "connectionSpec": {
          "id": "bf9f5905-92b7-48bf-bf20-455bc6b60a4e",
          "version": "1.0"
      }
  }'
Propriété Description
auth.params.sasKeyName Nom de la règle d’autorisation, également connu sous le nom de clé SAS.
auth.params.sasKey Signature d’accès partagé générée.
auth.params.namespace L’espace de noms de la variable Event Hubs vous y accédez.
connectionSpec.id La variable Event Hubs l’identifiant de spécification de connexion est : bf9f5905-92b7-48bf-bf20-455bc6b60a4e
 Réponse

Une réponse réussie renvoie les détails de la connexion de base que vous venez de créer, y compris son identifiant unique (id). Cet identifiant de connexion de est requis à l’étape suivante pour créer une connexion source.

{
    "id": "4cdbb15c-fb1e-46ee-8049-0f55b53378fe",
    "etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}

Pour créer un compte à l’aide de l’authentification SAS, envoyez une demande de POST à l’ /connections point de terminaison tout en fournissant des valeurs pour votre sasKeyName, sasKey,namespace, et eventHubName.

 Requête
curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/connections' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
      "name": "Azure Event Hubs connection",
      "description": "Connector for Azure Event Hubs",
      "auth": {
          "specName": "Azure EventHub authentication credentials",
          "params": {
              "sasKeyName": "{SAS_KEY_NAME}",
              "sasKey": "{SAS_KEY}",
              "namespace": "{NAMESPACE}",
              "eventHubName": "{EVENT_HUB_NAME}
          }
      },
      "connectionSpec": {
          "id": "bf9f5905-92b7-48bf-bf20-455bc6b60a4e",
          "version": "1.0"
      }
  }'
Propriété Description
auth.params.sasKeyName Nom de la règle d’autorisation, également connu sous le nom de clé SAS.
auth.params.sasKey Signature d’accès partagé générée.
auth.params.namespace L’espace de noms de la variable Event Hubs vous y accédez.
params.eventHubName Le nom de votre Event Hubs source.
connectionSpec.id La variable Event Hubs l’identifiant de spécification de connexion est : bf9f5905-92b7-48bf-bf20-455bc6b60a4e
 Réponse

Une réponse réussie renvoie les détails de la connexion de base que vous venez de créer, y compris son identifiant unique (id). Cet identifiant de connexion de est requis à l’étape suivante pour créer une connexion source.

{
    "id": "4cdbb15c-fb1e-46ee-8049-0f55b53378fe",
    "etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}

Créer une connexion source

CONSEIL

Un Event Hubs Le groupe de consommateurs ne peut être utilisé que pour un seul flux à la fois.

Une connexion source crée et gère la connexion à la source externe à partir de laquelle les données sont ingérées. Une connexion source se compose d’informations telles que la source de données, le format de données et un identifiant de connexion source nécessaires à la création d’un flux de données. Une instance de connexion source est spécifique à un client et à une organisation.

Pour créer une connexion source, envoyez une requête POST au point d’entrée /sourceConnections de l’API Flow Service.

Format d’API

POST /sourceConnections

Requête

curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
  -H 'authorization: Bearer {ACCESS_TOKEN}' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
      "name": "Azure Event Hubs source connection",
      "description": "A source connection for Azure Event Hubs",
      "baseConnectionId": "4cdbb15c-fb1e-46ee-8049-0f55b53378fe",
      "connectionSpec": {
          "id": "bf9f5905-92b7-48bf-bf20-455bc6b60a4e",
          "version": "1.0"
      },
      "data": {
          "format": "json"
      },
      "params": {
          "eventHubName": "{EVENT_HUB_NAME}",
          "dataType": "raw",
          "reset": "latest",
          "consumerGroup": "{CONSUMER_GROUP}"
      }
  }'
Propriété Description
name Nom de votre connexion source. Assurez-vous que le nom de votre connexion source est descriptif, car vous pouvez l’utiliser pour rechercher des informations sur votre connexion source.
description Valeur facultative que vous pouvez fournir pour inclure plus d’informations sur votre connexion source.
baseConnectionId Identifiant de connexion de de votre source Event Hubs générée à l’étape précédente.
connectionSpec.id Identifiant de spécification de connexion fixe pour Event Hubs. Cet ID est le suivant : bf9f5905-92b7-48bf-bf20-455bc6b60a4e
data.format Format des données Event Hubs que vous souhaitez ingérer. Actuellement, le format de données json est le seul à être pris en charge.
params.eventHubName Le nom de votre Event Hubs source.
params.dataType Ce paramètre définit le type des données ingérées. Les types de données pris en charge sont les suivants : raw et xdm.
params.reset Ce paramètre définit la manière dont les données seront lues. Utilisation latest pour commencer la lecture à partir des données les plus récentes et utiliser earliest pour commencer la lecture à partir des premières données disponibles dans le flux. Ce paramètre est facultatif et la valeur par défaut est earliest si non fourni.
params.consumerGroup Le mécanisme de publication ou d’abonnement à utiliser pour Event Hubs. Ce paramètre est facultatif et la valeur par défaut est $Default si non fourni. Consultez cette section Event Hubs guide sur les consommateurs d’événements pour plus d’informations. Remarque: Event Hubs Le groupe de consommateurs ne peut être utilisé que pour un seul flux à la fois.

Étapes suivantes

En suivant ce tutoriel, vous avez créé une Event Hubs connexion source à l’aide de la fonction Flow Service API. Vous pouvez utiliser cet ID de connexion source dans le tutoriel suivant pour créer un flux de données en continu à l’aide de l’API Flow Service .

Sur cette page