Ultimate
Creare una connessione di origine Azure Event Hubs utilizzando l'API Flow Service
Creato per:
- Sviluppatore
Leggi questo tutorial per scoprire come connettere Azure Event Hubs (di seguito "Event Hubs") ad Experience Platform, utilizzando Flow Service API.
Introduzione
Questa guida richiede una buona conoscenza dei seguenti componenti di Adobe Experience Platform:
- Origini: Experience Platform consente l'acquisizione di dati da varie origini e consente di strutturare, etichettare e migliorare i dati in arrivo tramite i servizi Experience Platform.
- Sandbox: Experience Platform fornisce sandbox virtuali che suddividono una singola istanza di Experience Platform in ambienti virtuali separati, utili per le attività di sviluppo e aggiornamento delle applicazioni di esperienza digitale.
Le sezioni seguenti forniscono informazioni aggiuntive che è necessario conoscere per connettere correttamente Event Hubs ad Experience Platform utilizzando l'API Flow Service.
Raccogli le credenziali richieste
Affinché Flow Service possa connettersi al tuo account Event Hubs, devi fornire i valori per le seguenti proprietà di connessione:
Credenziali | Descrizione |
---|---|
sasKeyName | Il nome della regola di autorizzazione, noto anche come nome della chiave SAS. |
sasKey | Chiave primaria dello spazio dei nomi Event Hubs. I sasPolicy a cui corrisponde sasKey devono avere manage diritti configurati affinché l'elenco Event Hubs possa essere popolato. |
namespace | Spazio dei nomi di Event Hub a cui si sta effettuando l'accesso. Uno spazio dei nomi Event Hub 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. ID della specifica di connessione Event Hubs: bf9f5905-92b7-48bf-bf20-455bc6b60a4e . |
Credenziali | Descrizione |
---|---|
sasKeyName | Il nome della regola di autorizzazione, noto anche come nome della chiave SAS. |
sasKey | Chiave primaria dello spazio dei nomi Event Hubs. I sasPolicy a cui corrisponde sasKey devono avere manage diritti configurati affinché l'elenco Event Hubs possa essere popolato. |
namespace | Spazio dei nomi di Event Hub a cui si sta effettuando l'accesso. Uno spazio dei nomi Event Hub fornisce un contenitore di ambito univoco, in cui è possibile creare uno o più Event Hubs. |
eventHubName | Inserisci il nome Azure Event Hub. Per ulteriori informazioni sui nomi di Event Hub, leggere la documentazione di Microsoft. |
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. ID della specifica di connessione Event Hubs: bf9f5905-92b7-48bf-bf20-455bc6b60a4e . |
Per ulteriori informazioni sull'autenticazione delle firme di accesso condiviso per Event Hubs, leggere la Azure guida sull'utilizzo di SAS.
Credenziali | Descrizione |
---|---|
tenantId | ID tenant a cui desideri richiedere l’autorizzazione. L’ID tenant può essere formattato come GUID o come nome descrittivo. Nota: nell'interfaccia Microsoft Azure l'ID tenant viene indicato come "ID directory". |
clientId | L'ID applicazione assegnato alla tua app. Puoi recuperare questo ID dal portale Microsoft Entra ID in cui hai registrato Azure Active Directory. |
clientSecretValue | Segreto client utilizzato insieme all’ID client per autenticare l’app. Puoi recuperare il segreto client dal portale Microsoft Entra ID in cui hai registrato Azure Active Directory. |
namespace | Spazio dei nomi di Event Hub a cui si sta effettuando l'accesso. Uno spazio dei nomi Event Hub fornisce un contenitore di ambito univoco, in cui è possibile creare uno o più Event Hubs. |
Per ulteriori informazioni su Azure Active Directory, leggere la Guida di Azure sull'utilizzo di Microsoft Entra ID.
Credenziali | Descrizione |
---|---|
tenantId | ID tenant a cui desideri richiedere l’autorizzazione. L’ID tenant può essere formattato come GUID o come nome descrittivo. Nota: nell'interfaccia Microsoft Azure l'ID tenant viene indicato come "ID directory". |
clientId | L'ID applicazione assegnato alla tua app. Puoi recuperare questo ID dal portale Microsoft Entra ID in cui hai registrato Azure Active Directory. |
clientSecretValue | Segreto client utilizzato insieme all’ID client per autenticare l’app. Puoi recuperare il segreto client dal portale Microsoft Entra ID in cui hai registrato Azure Active Directory. |
namespace | Spazio dei nomi di Event Hub a cui si sta effettuando l'accesso. Uno spazio dei nomi Event Hub fornisce un contenitore di ambito univoco, in cui è possibile creare uno o più Event Hubs. |
eventHubName | Inserisci il nome Azure Event Hub. Per ulteriori informazioni sui nomi di Event Hub, leggere la documentazione di Microsoft. |
Per ulteriori informazioni su questi valori, fare riferimento al documento Hub eventi.
Utilizzo delle API di Experience Platform
Per informazioni su come effettuare correttamente chiamate alle API di Experience Platform, consulta la guida introduttiva alle API di Experience Platform.
Creare una connessione di base
Il primo passaggio nella creazione di una connessione di origine consiste nell'autenticare l'origine Event Hubs e generare un ID 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 connessione di base, eseguire una richiesta POST all'endpoint /connections
fornendo le credenziali di autenticazione Event Hubs come parte dei parametri della richiesta.
Formato API
POST /connections
Per creare un account utilizzando l'autenticazione standard, eseguire una richiesta POST all'endpoint /connections
fornendo i valori per sasKeyName
, sasKey
e namespace
.
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"
}
}'
auth.params.sasKeyName
auth.params.sasKey
auth.params.namespace
connectionSpec.id
bf9f5905-92b7-48bf-bf20-455bc6b60a4e
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.
{
"id": "4cdbb15c-fb1e-46ee-8049-0f55b53378fe",
"etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}
Per creare un account utilizzando l'autenticazione SAS, eseguire una richiesta POST all'endpoint /connections
fornendo i valori per sasKeyName
, sasKey
,namespace
e eventHubName
.
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"
}
}'
auth.params.sasKeyName
auth.params.sasKey
auth.params.namespace
params.eventHubName
connectionSpec.id
bf9f5905-92b7-48bf-bf20-455bc6b60a4e
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.
{
"id": "4cdbb15c-fb1e-46ee-8049-0f55b53378fe",
"etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}
Per creare un account utilizzando Azure Active Directory Auth, eseguire una richiesta POST all'endpoint /connections
fornendo i valori per tenantId
, clientId
,clientSecretValue
e namespace
.
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"
}
}'
auth.params.tenantId
auth.params.clientId
auth.params.clientSecretValue
auth.params.namespace
connectionSpec.id
bf9f5905-92b7-48bf-bf20-455bc6b60a4e
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.
{
"id": "4cdbb15c-fb1e-46ee-8049-0f55b53378fe",
"etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}
Per creare un account utilizzando Azure Active Directory Auth, eseguire una richiesta POST all'endpoint /connections
fornendo i valori per tenantId
, clientId
, clientSecretValue
, namespace
e eventHubName
.
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"
}
}'
auth.params.tenantId
auth.params.clientId
auth.params.clientSecretValue
auth.params.namespace
auth.params.eventHubName
connectionSpec.id
bf9f5905-92b7-48bf-bf20-455bc6b60a4e
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.
{
"id": "4cdbb15c-fb1e-46ee-8049-0f55b53378fe",
"etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}
Creare 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 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 di origine, eseguire una richiesta POST all'endpoint /sourceConnections
dell'API Flow Service.
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}"
}
}'
name
description
baseConnectionId
connectionSpec.id
bf9f5905-92b7-48bf-bf20-455bc6b60a4e
.data.format
json
.params.eventHubName
params.dataType
raw
e xdm
.params.reset
latest
per iniziare a leggere dai dati più recenti e earliest
per iniziare a leggere dai primi dati disponibili nel flusso. Questo parametro è facoltativo e, se non specificato, viene impostato automaticamente su earliest
.params.consumerGroup
$Default
. Per ulteriori informazioni, consulta questa Event Hubs guida sugli eventi consumer. Nota: un gruppo di consumer Event Hubs può essere utilizzato solo per un singolo flusso in un determinato momento.Passaggi successivi
Seguendo questa esercitazione, è stata creata una connessione di origine Event Hubs utilizzando l'API Flow Service. Puoi utilizzare questo ID connessione di origine nella prossima esercitazione per creare un flusso di dati in streaming utilizzando l' Flow Service API.