DokumentationExperience PlatformAnvändarhandbok om Source Connectors

[Ultimate]{class="badge positive"}

Skapa en Azure Event Hubs-källanslutning med API:t Flow Service

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Ämnen:

Skapat för:

  • Utvecklare
IMPORTANT
Källan Azure Event Hubs är tillgänglig i källkatalogen för användare som har köpt Real-time Customer Data Platform Ultimate.

I den här självstudiekursen får du lära dig hur du ansluter Azure Event Hubs (kallas nedan Event Hubs) till Experience Platform med Flow Service API.

Komma igång

Handboken kräver en fungerande förståelse av följande komponenter i Adobe Experience Platform:

  • Källor: Experience Platform tillåter att data kan hämtas från olika källor samtidigt som du kan strukturera, etikettera och förbättra inkommande data med Platform-tjänster.
  • Sandlådor: Experience Platform innehåller virtuella sandlådor som partitionerar en enskild Platform-instans till separata virtuella miljöer för att hjälpa till att utveckla och utveckla program för digitala upplevelser.

I följande avsnitt finns ytterligare information som du behöver känna till för att kunna ansluta Event Hubs till plattformen med API:t Flow Service.

Samla in nödvändiga inloggningsuppgifter

För att Flow Service ska kunna ansluta till ditt Event Hubs-konto måste du ange värden för följande anslutningsegenskaper:

Standardautentisering
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
Autentiseringsuppgifter Beskrivning
sasKeyName Auktoriseringsregelns namn, som också kallas SAS-nyckelnamn.
sasKey Primärnyckeln för namnområdet Event Hubs. sasPolicy som sasKey motsvarar måste ha manage rättigheter konfigurerade för att Event Hubs-listan ska kunna fyllas i.
namespace Namnområdet för Event Hub som du använder. Ett Event Hub-namnområde innehåller en unik omfångsbehållare där du kan skapa en eller flera Event Hubs.
connectionSpec.id Anslutningsspecifikationen returnerar en källas kopplingsegenskaper, inklusive autentiseringsspecifikationer för att skapa bas- och källanslutningarna. Anslutningsspecifikations-ID Event Hubs är: bf9f5905-92b7-48bf-bf20-455bc6b60a4e.
SAS-autentisering
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
Autentiseringsuppgifter Beskrivning
sasKeyName Auktoriseringsregelns namn, som också kallas SAS-nyckelnamn.
sasKey Primärnyckeln för namnområdet Event Hubs. sasPolicy som sasKey motsvarar måste ha manage rättigheter konfigurerade för att Event Hubs-listan ska kunna fyllas i.
namespace Namnområdet för Event Hub som du använder. Ett Event Hub-namnområde innehåller en unik omfångsbehållare där du kan skapa en eller flera Event Hubs.
eventHubName Fyll i ditt Azure Event Hub-namn. Läs Microsoft-dokumentationen om du vill ha mer information om Event Hub-namn.
connectionSpec.id Anslutningsspecifikationen returnerar en källas kopplingsegenskaper, inklusive autentiseringsspecifikationer för att skapa bas- och källanslutningarna. Anslutningsspecifikations-ID Event Hubs är: bf9f5905-92b7-48bf-bf20-455bc6b60a4e.

Mer information om SAS-autentisering (Shared Access Signatures) för Event Hubs finns i Azure handboken om användning av SAS.

Händelsehubben Azure Active Directory-autentisering
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
Autentiseringsuppgifter Beskrivning
tenantId Klient-ID som du vill begära behörighet från. Ditt klient-ID kan formateras som ett GUID eller som ett eget namn. Obs! Klient-ID kallas för "katalog-ID" i gränssnittet Microsoft Azure.
clientId Program-ID som tilldelats din app. Du kan hämta detta ID från portalen Microsoft Entra ID där du registrerade din Azure Active Directory.
clientSecretValue Klienthemligheten som används tillsammans med klient-ID för att autentisera din app. Du kan hämta din klienthemlighet från portalen Microsoft Entra ID där du registrerade din Azure Active Directory.
namespace Namnområdet för Event Hub som du använder. Ett Event Hub-namnområde innehåller en unik omfångsbehållare där du kan skapa en eller flera Event Hubs.

Mer information om Azure Active Directory finns i Azure-guiden om hur du använder Microsoft Entra ID.

Händelsehubben har omfattat Azure Active Directory Auth
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
Autentiseringsuppgifter Beskrivning
tenantId Klient-ID som du vill begära behörighet från. Ditt klient-ID kan formateras som ett GUID eller som ett eget namn. Obs! Klient-ID kallas för "katalog-ID" i gränssnittet Microsoft Azure.
clientId Program-ID som tilldelats din app. Du kan hämta detta ID från portalen Microsoft Entra ID där du registrerade din Azure Active Directory.
clientSecretValue Klienthemligheten som används tillsammans med klient-ID för att autentisera din app. Du kan hämta din klienthemlighet från portalen Microsoft Entra ID där du registrerade din Azure Active Directory.
namespace Namnområdet för Event Hub som du använder. Ett Event Hub-namnområde innehåller en unik omfångsbehållare där du kan skapa en eller flera Event Hubs.
eventHubName Fyll i ditt Azure Event Hub-namn. Läs Microsoft-dokumentationen om du vill ha mer information om Event Hub-namn.

Mer information om dessa värden finns i det här händelsehubbsdokumentet.

Använda plattforms-API:er

Mer information om hur du kan anropa plattforms-API:er finns i guiden Komma igång med plattforms-API:er.

Skapa en basanslutning

TIP
När du väl har skapat den kan du inte ändra autentiseringstypen för en Event Hubs-basanslutning. Om du vill ändra autentiseringstypen måste du skapa en ny basanslutning.

Det första steget i att skapa en källanslutning är att autentisera Event Hubs-källan och generera ett grundläggande anslutnings-ID. Med ett grundläggande anslutnings-ID kan du utforska och navigera bland filer inifrån källan och identifiera specifika objekt som du vill importera, inklusive information om deras datatyper och format.

Om du vill skapa ett grundläggande anslutnings-ID skickar du en POST till slutpunkten /connections och anger dina autentiseringsuppgifter för Event Hubs som en del av parametrarna för begäran.

API-format

POST /connections
Standardautentisering

Om du vill skapa ett konto med standardautentisering skickar du en POST till /connections-slutpunkten samtidigt som du anger värden för sasKeyName, sasKey och namespace.

accordion
Begäran
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
Egenskap Beskrivning
auth.params.sasKeyName Auktoriseringsregelns namn, som också kallas SAS-nyckelnamn.
auth.params.sasKey Den genererade signaturen för delad åtkomst.
auth.params.namespace Namnområdet för Event Hubs som du använder.
connectionSpec.id Anslutningsspecifikations-ID Event Hubs är: bf9f5905-92b7-48bf-bf20-455bc6b60a4e
accordion
svar

Ett godkänt svar returnerar information om den nya basanslutningen, inklusive dess unika identifierare (id). Detta anslutnings-ID krävs i nästa steg för att skapa en källanslutning.

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

Om du vill skapa ett konto med SAS-autentisering skickar du en POST till /connections-slutpunkten samtidigt som du anger värden för sasKeyName, sasKey, namespace och eventHubName.

accordion
Begäran
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
Egenskap Beskrivning
auth.params.sasKeyName Auktoriseringsregelns namn, som också kallas SAS-nyckelnamn.
auth.params.sasKey Den genererade signaturen för delad åtkomst.
auth.params.namespace Namnområdet för Event Hubs som du använder.
params.eventHubName Namnet på Event Hubs-källan.
connectionSpec.id Anslutningsspecifikations-ID Event Hubs är: bf9f5905-92b7-48bf-bf20-455bc6b60a4e
accordion
svar

Ett godkänt svar returnerar information om den nya basanslutningen, inklusive dess unika identifierare (id). Detta anslutnings-ID krävs i nästa steg för att skapa en källanslutning.

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

Om du vill skapa ett konto med Azure Active Directory Auth skickar du en POST till /connections-slutpunkten samtidigt som du anger värden för tenantId, clientId, clientSecretValue och namespace.

accordion
Begäran
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
Egenskap Beskrivning
auth.params.tenantId Klient-ID för ditt program. Obs! Klient-ID kallas för "katalog-ID" i gränssnittet Microsoft Azure.
auth.params.clientId Klient-ID för din organisation.
auth.params.clientSecretValue Klientens hemliga värde för din organisation.
auth.params.namespace Namnområdet för Event Hubs som du använder.
connectionSpec.id Anslutningsspecifikations-ID Event Hubs är: bf9f5905-92b7-48bf-bf20-455bc6b60a4e
accordion
svar

Ett godkänt svar returnerar information om den nya basanslutningen, inklusive dess unika identifierare (id). Detta anslutnings-ID krävs i nästa steg för att skapa en källanslutning.

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

Om du vill skapa ett konto med Azure Active Directory Auth skickar du en POST till /connections-slutpunkten samtidigt som du anger värden för tenantId, clientId, clientSecretValue, namespace och eventHubName.

accordion
Begäran
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
Egenskap Beskrivning
auth.params.tenantId Klient-ID för ditt program. Obs! Klient-ID kallas för "katalog-ID" i gränssnittet Microsoft Azure.
auth.params.clientId Klient-ID för din organisation.
auth.params.clientSecretValue Klientens hemliga värde för din organisation.
auth.params.namespace Namnområdet för Event Hubs som du använder.
auth.params.eventHubName Namnet på Event Hubs-källan.
connectionSpec.id Anslutningsspecifikations-ID Event Hubs är: bf9f5905-92b7-48bf-bf20-455bc6b60a4e
accordion
svar

Ett godkänt svar returnerar information om den nya basanslutningen, inklusive dess unika identifierare (id). Detta anslutnings-ID krävs i nästa steg för att skapa en källanslutning.

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

Skapa en källanslutning

TIP
En Event Hubs-konsumentgrupp kan bara användas för ett enda flöde vid en given tidpunkt.

En källanslutning skapar och hanterar anslutningen till den externa källan som data importeras från. En källanslutning består av information som datakälla, dataformat och ett källanslutnings-ID som behövs för att skapa ett dataflöde. En källanslutningsinstans är specifik för en klientorganisation och organisation.

Om du vill skapa en källanslutning skickar du en POST till /sourceConnections-slutpunkten för Flow Service API:t.

API-format

POST /sourceConnections

Begäran

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}"
      }
  }'
Egenskap
Beskrivning
name
Namnet på källanslutningen. Kontrollera att namnet på källanslutningen är beskrivande, eftersom du kan använda det här för att söka efter information om källanslutningen.
description
Ett valfritt värde som du kan ange för att inkludera mer information om din källanslutning.
baseConnectionId
Anslutnings-ID för källan Event Hubs som skapades i föregående steg.
connectionSpec.id
Det fasta anslutningsspecifikations-ID:t för Event Hubs. Detta ID är: bf9f5905-92b7-48bf-bf20-455bc6b60a4e.
data.format
Formatet på de Event Hubs-data som du vill importera. För närvarande är det enda dataformat som stöds json.
params.eventHubName
Namnet på Event Hubs-källan.
params.dataType
Den här parametern definierar vilken typ av data som importeras. Datatyper som stöds är: raw och xdm.
params.reset
Den här parametern definierar hur data läses. Använd latest för att börja läsa från de senaste data och använd earliest för att börja läsa från de första tillgängliga data i strömmen. Den här parametern är valfri och standardvärdet är earliest om den inte anges.
params.consumerGroup
Publicerings- eller prenumerationsmekanismen som ska användas för Event Hubs. Den här parametern är valfri och standardvärdet är $Default om den inte anges. Mer information finns i Event Hubs handboken om händelsekonsumenter. Obs!: En Event Hubs-konsumentgrupp kan bara användas för ett enda flöde vid en given tidpunkt.

Nästa steg

Genom att följa den här självstudiekursen har du skapat en Event Hubs-källanslutning med API:t Flow Service. Du kan använda det här källanslutnings-ID:t i nästa självstudie för att skapa ett direktuppspelat dataflöde med Flow Service API.

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