Crea un Azure Event Hubs connessione di origine tramite Flow Service API

Questa esercitazione descrive i passaggi per la connessione Azure Event Hubs (in appresso denominato "Event Hubs") ad Experience Platform, utilizzando Flow Service API.

Introduzione

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

  • Origini: Experience Platform consente l’acquisizione di dati da varie sorgenti, fornendo al contempo la possibilità di strutturare, etichettare e migliorare i dati in arrivo utilizzando Platform servizi.
  • Sandbox: Experience Platform fornisce sandbox virtuali che suddividono un singolo Platform in ambienti virtuali separati per sviluppare e sviluppare applicazioni di esperienza digitale.

Le sezioni seguenti forniscono informazioni aggiuntive che sarà necessario conoscere per connettersi correttamente Event Hubs su Platform utilizzando Flow Service API.

Raccogli credenziali richieste

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

Credenziali Descrizione
sasKeyName Nome della regola di autorizzazione, noto anche come nome della chiave SAS.
sasKey La chiave primaria del Event Hubs spazio dei nomi. La sasPolicy che sasKey corrisponde a manage diritti configurati per Event Hubs elenco da compilare.
namespace Lo spazio dei nomi del Event Hubs stai accedendo. Un Event Hubs Lo spazio dei nomi fornisce un contenitore di ambito univoco, in cui è 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. La Event Hubs ID della specifica di connessione: bf9f5905-92b7-48bf-bf20-455bc6b60a4e.

Per ulteriori informazioni su questi valori, consulta questo documento Hubs evento.

Utilizzo delle API di Platform

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

Creare una connessione di base

Il primo passaggio nella creazione di una connessione sorgente è quello di autenticare il Event Hubs e genera 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 di identificare gli elementi specifici da acquisire, comprese le informazioni relative ai tipi di dati e ai formati corrispondenti.

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

Formato API

POST /connections

Richiesta

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: {IMS_ORG}' \
    -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"
        }
    }'
Proprietà Descrizione
auth.params.sasKeyName Nome della regola di autorizzazione, noto anche come nome della chiave SAS.
auth.params.sasKey La firma di accesso condiviso generata.
auth.params.namespace Lo spazio dei nomi del Event Hubs stai accedendo.
connectionSpec.id La Event Hubs ID della specifica di connessione: bf9f5905-92b7-48bf-bf20-455bc6b60a4e

Risposta

Una risposta corretta restituisce i dettagli della nuova connessione di base creata, incluso il relativo identificatore univoco (id). Questo ID di connessione è necessario nel passaggio successivo per creare una connessione sorgente.

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

Creazione di una connessione sorgente

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 l’origine dati, il formato dati e un ID di connessione di origine necessari per creare un flusso di dati. Un’istanza di connessione di origine è specifica per un tenant e un’organizzazione IMS.

Per creare una connessione di origine, invia una richiesta POST al /sourceConnections punto finale 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: {IMS_Org}' \
    -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": "{EVENTHUB_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 puoi utilizzarlo per cercare informazioni sulla connessione sorgente.
description Valore facoltativo che è possibile fornire per includere ulteriori informazioni sulla connessione sorgente.
baseConnectionId L'ID di connessione del 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 dati da acquisire. Attualmente, l’unico formato di dati supportato è json.
params.eventHubName Nome del Event Hubs sorgente.
params.dataType Questo parametro definisce il tipo di dati da acquisire. I tipi di dati supportati includono: raw e xdm.
params.reset Questo parametro definisce come verranno letti i dati. Utilizzo 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 come impostazione predefinita su earliest se non fornito.
params.consumerGroup Meccanismo di pubblicazione o sottoscrizione da utilizzare per Event Hubs. Questo parametro è facoltativo e viene impostato come impostazione predefinita su $Default se non fornito. Fai riferimento a questo Event Hubs guida all'evento per i consumatori per ulteriori informazioni.

Passaggi successivi

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

In questa pagina