[Ultimate]{class="badge positive"}

Creare un Azure Event Hubs connessione sorgente tramite Flow Service API

IMPORTANT
Il Azure Event Hubs è disponibile nel catalogo delle origini per gli utenti che hanno acquistato Real-time Customer Data Platform Ultimate.

Leggi questo tutorial per scoprire come connetterti Azure Event Hubs (in seguito denominati "Event Hubs") per l'Experience Platform, utilizzando Flow Service API.

Introduzione

Questa guida richiede una buona conoscenza dei seguenti componenti di Adobe Experience Platform:

  • Sorgenti: Experience Platform consente di acquisire dati da varie origini e allo stesso tempo di strutturare, etichettare e migliorare i dati in arrivo tramite Platform servizi.
  • Sandbox: Experience Platform fornisce sandbox virtuali che permettono di suddividere un singolo Platform in ambienti virtuali separati, per facilitare lo sviluppo e l’evoluzione delle applicazioni di esperienza digitale.

Le sezioni seguenti forniscono informazioni aggiuntive che è necessario conoscere per connettersi correttamente Event Hubs alla piattaforma utilizzando Flow Service API.

Raccogli le credenziali richieste

Per ottenere Flow Service per connettersi con Event Hubs account, è necessario fornire valori per le seguenti proprietà di connessione:

Autenticazione standard
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
Credenziali Descrizione
sasKeyName Il nome della regola di autorizzazione, noto anche come nome della chiave SAS.
sasKey La chiave primaria della Event Hubs spazio dei nomi. Il sasPolicy che il sasKey corrisponde a deve avere manage diritti configurati per il Event Hubs elenco da compilare.
namespace Lo spazio dei nomi del Event Hubs si sta effettuando l'accesso. Un Event Hubs namespace fornisce un contenitore di ambito univoco, nel quale è possibile creare uno o più Event Hubs.
connectionSpec.id La specifica di connessione restituisce le proprietà del connettore di un'origine, incluse le specifiche di autenticazione relative alla creazione delle connessioni di base e di origine. Il Event Hubs ID specifica di connessione: bf9f5905-92b7-48bf-bf20-455bc6b60a4e.
Autenticazione SAS
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
Credenziali Descrizione
sasKeyName Il nome della regola di autorizzazione, noto anche come nome della chiave SAS.
sasKey La chiave primaria della Event Hubs spazio dei nomi. Il sasPolicy che il sasKey corrisponde a deve avere manage diritti configurati per il Event Hubs elenco da compilare.
namespace Lo spazio dei nomi del Event Hubs si sta effettuando l'accesso. Un Event Hubs namespace fornisce un contenitore di ambito univoco, nel quale è possibile creare uno o più Event Hubs.
eventHubName Il nome per il Event Hubs sorgente.
connectionSpec.id La specifica di connessione restituisce le proprietà del connettore di un'origine, incluse le specifiche di autenticazione relative alla creazione delle connessioni di base e di origine. Il Event Hubs ID specifica di connessione: bf9f5905-92b7-48bf-bf20-455bc6b60a4e.

Per ulteriori informazioni sull'autenticazione delle firme di accesso condiviso (SAS) per Event Hubs, leggi Azure guida all'utilizzo di SAS.

Hub eventi Azure Active Directory Auth
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
Credenziali Descrizione
tenantId ID tenant a cui desideri richiedere l’autorizzazione. L’ID tenant può essere formattato come GUID o come nome descrittivo. Nota: l’ID tenant è indicato come "ID directory" nella sezione Microsoft Azure di rete.
clientId L'ID applicazione assegnato alla tua app. Puoi recuperare questo ID da Microsoft Entra ID portale in cui è stata effettuata la registrazione Azure Active Directory.
clientSecretValue Segreto client utilizzato insieme all’ID client per autenticare l’app. Puoi recuperare il segreto del client da Microsoft Entra ID portale in cui è stata effettuata la registrazione Azure Active Directory.
namespace Lo spazio dei nomi del Event Hubs si sta effettuando l'accesso. Un Event Hubs namespace fornisce un contenitore di ambito univoco, nel quale è possibile creare uno o più Event Hubs.

Per ulteriori informazioni su Azure Active Directory, leggi Guida di Azure sull’utilizzo di Microsoft Entra ID.

Autenticazione Azure Active Directory con ambito hub eventi
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
Credenziali Descrizione
tenantId ID tenant a cui desideri richiedere l’autorizzazione. L’ID tenant può essere formattato come GUID o come nome descrittivo. Nota: l’ID tenant è indicato come "ID directory" nella sezione Microsoft Azure di rete.
clientId L'ID applicazione assegnato alla tua app. Puoi recuperare questo ID da Microsoft Entra ID portale in cui è stata effettuata la registrazione Azure Active Directory.
clientSecretValue Segreto client utilizzato insieme all’ID client per autenticare l’app. Puoi recuperare il segreto del client da Microsoft Entra ID portale in cui è stata effettuata la registrazione Azure Active Directory.
namespace Lo spazio dei nomi del Event Hubs si sta effettuando l'accesso. Un Event Hubs namespace fornisce un contenitore di ambito univoco, nel quale è possibile creare uno o più Event Hubs.
eventHubName Il nome per il Event Hubs sorgente.

Per ulteriori informazioni su questi valori, consulta questo documento Hub eventi.

Utilizzo delle API di Platform

Per informazioni su come effettuare correttamente chiamate alle API di Platform, consulta la guida su introduzione alle API di Platform.

Creare una connessione di base

TIP
Una volta creato, non è possibile modificare il tipo di autenticazione di un Event Hubs connessione di base. Per modificare il tipo di autenticazione, è necessario creare una nuova connessione di base.

Il primo passaggio nella creazione di una connessione sorgente consiste nell’autenticare Event Hubs e generare un ID di connessione di base. Un ID di connessione di base consente di esplorare e navigare tra i file dall’interno dell’origine e identificare elementi specifici da acquisire, incluse informazioni relative ai tipi di dati e ai formati.

Per creare un ID di connessione di base, effettua una richiesta POST al /connections endpoint durante la fornitura del Event Hubs credenziali di autenticazione come parte dei parametri della richiesta.

Formato API

POST /connections
Autenticazione standard

Per creare un account utilizzando l’autenticazione standard, effettua una richiesta POST al /connections mentre si forniscono valori per il sasKeyName, sasKey, e namespace.

accordion
Richiesta
code language-shell
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"
      }
  }'
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
Proprietà Descrizione
auth.params.sasKeyName Il nome della regola di autorizzazione, noto anche come nome della chiave SAS.
auth.params.sasKey Firma di accesso condiviso generata.
auth.params.namespace Lo spazio dei nomi del Event Hubs si sta effettuando l'accesso.
connectionSpec.id Il Event Hubs ID specifica di connessione: bf9f5905-92b7-48bf-bf20-455bc6b60a4e
accordion
Risposta

In caso di esito positivo, la risposta restituisce i dettagli della connessione di base appena creata, incluso il relativo identificatore univoco (id). Questo ID connessione è richiesto nel passaggio successivo per creare una connessione sorgente.

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

Per creare un account utilizzando l’autenticazione SAS, effettua una richiesta POST al /connections mentre si forniscono valori per il sasKeyName, sasKey,namespace, e eventHubName.

accordion
Richiesta
code language-shell
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"
      }
  }'
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
Proprietà Descrizione
auth.params.sasKeyName Il nome della regola di autorizzazione, noto anche come nome della chiave SAS.
auth.params.sasKey Firma di accesso condiviso generata.
auth.params.namespace Lo spazio dei nomi del Event Hubs si sta effettuando l'accesso.
params.eventHubName Il nome per il Event Hubs sorgente.
connectionSpec.id Il Event Hubs ID specifica di connessione: bf9f5905-92b7-48bf-bf20-455bc6b60a4e
accordion
Risposta

In caso di esito positivo, la risposta restituisce i dettagli della connessione di base appena creata, incluso il relativo identificatore univoco (id). Questo ID connessione è richiesto nel passaggio successivo per creare una connessione sorgente.

code language-json
{
    "id": "4cdbb15c-fb1e-46ee-8049-0f55b53378fe",
    "etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}
Hub eventi Azure Active Directory Auth

Per creare un account utilizzando Azure Active Directory Auth, effettuare una richiesta POST al /connections mentre si forniscono valori per il tenantId, clientId,clientSecretValue, e namespace.

accordion
Richiesta
code language-shell
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": "Event Hub Azure Active Directory Auth",
          "params": {
              "tenantId": "{TENANT_ID}",
              "clientId": "{CLIENT_ID}",
              "clientSecretValue": "{CLIENT_SECRET_VALUE}",
              "namespace": "{NAMESPACE}"
          }
      },
      "connectionSpec": {
          "id": "bf9f5905-92b7-48bf-bf20-455bc6b60a4e",
          "version": "1.0"
      }
  }'
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
Proprietà Descrizione
auth.params.tenantId ID tenant dell’applicazione. Nota: l’ID tenant è indicato come "ID directory" nella sezione Microsoft Azure di rete.
auth.params.clientId L’ID cliente dell’organizzazione.
auth.params.clientSecretValue Il valore segreto client dell’organizzazione.
auth.params.namespace Lo spazio dei nomi del Event Hubs si sta effettuando l'accesso.
connectionSpec.id Il Event Hubs ID specifica di connessione: bf9f5905-92b7-48bf-bf20-455bc6b60a4e
accordion
Risposta

In caso di esito positivo, la risposta restituisce i dettagli della connessione di base appena creata, incluso il relativo identificatore univoco (id). Questo ID connessione è richiesto nel passaggio successivo per creare una connessione sorgente.

code language-json
{
    "id": "4cdbb15c-fb1e-46ee-8049-0f55b53378fe",
    "etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}
Autenticazione Azure Active Directory con ambito hub eventi

Per creare un account utilizzando Azure Active Directory Auth, effettuare una richiesta POST al /connections mentre si forniscono valori per il tenantId, clientId,clientSecretValue, namespace, e eventHubName.

accordion
Richiesta
code language-shell
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": "Event Hub Scoped Azure Active Directory Auth",
          "params": {
              "tenantId": "{TENANT_ID}",
              "clientId": "{CLIENT_ID}",
              "clientSecretValue": "{CLIENT_SECRET_VALUE}",
              "namespace": "{NAMESPACE}",
              "eventHubName": "{EVENT_HUB_NAME}"
          }
      },
      "connectionSpec": {
          "id": "bf9f5905-92b7-48bf-bf20-455bc6b60a4e",
          "version": "1.0"
      }
  }'
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2
Proprietà Descrizione
auth.params.tenantId ID tenant dell’applicazione. Nota: l’ID tenant è indicato come "ID directory" nella sezione Microsoft Azure di rete.
auth.params.clientId L’ID cliente dell’organizzazione.
auth.params.clientSecretValue Il valore segreto client dell’organizzazione.
auth.params.namespace Lo spazio dei nomi del Event Hubs si sta effettuando l'accesso.
auth.params.eventHubName Il nome per il Event Hubs sorgente.
connectionSpec.id Il Event Hubs ID specifica di connessione: bf9f5905-92b7-48bf-bf20-455bc6b60a4e
accordion
Risposta

In caso di esito positivo, la risposta restituisce i dettagli della connessione di base appena creata, incluso il relativo identificatore univoco (id). Questo ID connessione è richiesto nel passaggio successivo per creare una connessione sorgente.

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

Creare una connessione sorgente

TIP
Un Event Hubs gruppo di consumer può essere utilizzato solo per un singolo flusso in un determinato momento.

Una connessione di origine crea e gestisce la connessione all’origine esterna da cui vengono acquisiti i dati. Una connessione di origine è costituita da informazioni quali origine dati, formato dati e un ID di connessione di origine necessari per creare un flusso di dati. Un'istanza della connessione di origine è specifica di un tenant e di un'organizzazione.

Per creare una connessione sorgente, effettua una richiesta POST al /sourceConnections endpoint del Flow Service API.

Formato API

POST /sourceConnections

Richiesta

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}"
      }
  }'
Proprietà
Descrizione
name
Nome della connessione di origine. Assicurati che il nome della connessione sorgente sia descrittivo, in quanto può essere utilizzato per cercare informazioni sulla connessione sorgente.
description
Valore facoltativo che è possibile fornire per includere ulteriori informazioni sulla connessione di origine.
baseConnectionId
ID di connessione del tuo Event Hubs origine generata nel passaggio precedente.
connectionSpec.id
ID della specifica di connessione fissa per Event Hubs. Questo ID è: bf9f5905-92b7-48bf-bf20-455bc6b60a4e.
data.format
Il formato del Event Hubs i dati che desideri acquisire. Attualmente, l’unico formato di dati supportato è json.
params.eventHubName
Il nome per il Event Hubs sorgente.
params.dataType
Questo parametro definisce il tipo di dati che viene acquisito. I tipi di dati supportati includono: raw e xdm.
params.reset
Questo parametro definisce la modalità di lettura dei dati. Utilizzare latest per iniziare a leggere dai dati più recenti e utilizzare earliest per iniziare a leggere dai primi dati disponibili nel flusso. Questo parametro è facoltativo e viene impostato automaticamente su earliest se non specificato.
params.consumerGroup
Il meccanismo di pubblicazione o di abbonamento da utilizzare per Event Hubs. Questo parametro è facoltativo e viene impostato automaticamente su $Default se non specificato. Fai riferimento a questo Event Hubs guida sui consumatori dell’evento per ulteriori informazioni. Nota: un Event Hubs gruppo di consumer può essere utilizzato solo per un singolo flusso in un determinato momento.

Passaggi successivi

Seguendo questa esercitazione, hai creato un’ Event Hubs connessione sorgente tramite Flow Service API. Puoi utilizzare questo ID connessione sorgente nell’esercitazione successiva per creare un flusso di dati in streaming utilizzando Flow Service API.

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089