Dokumentation Experience Platform Anleitung für Quell-Connectoren

[Ultimate]{class="badge positive"}

Erstellen einer Azure Event Hubs-Quellverbindung mit der Flow Service-API

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

Themen:

Erstellt für:

Entwickler

IMPORTANT

Die Quelle "Azure Event Hubs" steht Benutzern, die Real-time Customer Data Platform Ultimate erworben haben, im Quellkatalog zur Verfügung.

In diesem Tutorial erfahren Sie, wie Sie mithilfe der Flow Service API Azure Event Hubs (im Folgenden "1}") mit Experience Platform verbinden.Event Hubs

Erste Schritte

Dieses Handbuch setzt ein Verständnis der folgenden Komponenten von Adobe Experience Platform voraus:

Quellen: Experience Platform ermöglicht die Aufnahme von Daten aus verschiedenen Quellen und bietet Ihnen die Möglichkeit, die eingehenden Daten mithilfe von Platform-Services zu strukturieren, zu kennzeichnen und anzureichern.
Sandboxes: Experience Platform bietet virtuelle Sandboxes, die eine einzelne Platform-Instanz in separate virtuelle Umgebungen unterteilen, damit Sie Programme für digitale Erlebnisse entwickeln und weiterentwickeln können.

Die folgenden Abschnitte enthalten zusätzliche Informationen, die Sie benötigen, um Event Hubs mithilfe der Flow Service-API erfolgreich mit Platform verbinden zu können.

Sammeln erforderlicher Anmeldeinformationen

Damit Flow Service eine Verbindung zu Ihrem Event Hubs-Konto herstellen kann, müssen Sie Werte für die folgenden Verbindungseigenschaften angeben:

Standardauthentifizierung

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
Anmeldedaten	Beschreibung
`sasKeyName`	Der Name der Autorisierungsregel, der auch als SAS-Schlüsselname bezeichnet wird.
`sasKey`	Der Primärschlüssel des Namespace Event Hubs . Die `sasPolicy`, denen die `sasKey` entspricht, müssen über die `manage` -Rechte verfügen, damit die Event Hubs -Liste ausgefüllt werden kann.
`namespace`	Der Namespace der Event Hub , auf die Sie zugreifen. Ein Namespace Event Hub bietet einen eindeutigen Scoping-Container, in dem Sie einen oder mehrere Event Hubs erstellen können.
`connectionSpec.id`	Die Verbindungsspezifikation gibt die Connector-Eigenschaften einer Quelle zurück, einschließlich der Authentifizierungsspezifikationen für die Erstellung der Basis- und Quellverbindungen. Die Spezifikations-ID der Event Hubs-Verbindung lautet: `bf9f5905-92b7-48bf-bf20-455bc6b60a4e`.

SAS-Authentifizierung

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
Anmeldedaten	Beschreibung
`sasKeyName`	Der Name der Autorisierungsregel, der auch als SAS-Schlüsselname bezeichnet wird.
`sasKey`	Der Primärschlüssel des Namespace Event Hubs . Die `sasPolicy`, denen die `sasKey` entspricht, müssen über die `manage` -Rechte verfügen, damit die Event Hubs -Liste ausgefüllt werden kann.
`namespace`	Der Namespace der Event Hub , auf die Sie zugreifen. Ein Namespace Event Hub bietet einen eindeutigen Scoping-Container, in dem Sie einen oder mehrere Event Hubs erstellen können.
`eventHubName`	Geben Sie Ihren Azure Event Hub Namen ein. Weitere Informationen zu Event Hub -Namen finden Sie in der Microsoft-Dokumentation .
`connectionSpec.id`	Die Verbindungsspezifikation gibt die Connector-Eigenschaften einer Quelle zurück, einschließlich der Authentifizierungsspezifikationen für die Erstellung der Basis- und Quellverbindungen. Die Spezifikations-ID der Event Hubs-Verbindung lautet: `bf9f5905-92b7-48bf-bf20-455bc6b60a4e`.

Weitere Informationen zur SAS-Authentifizierung (Shared Access Signatures) für Event Hubs finden Sie im Azure Handbuch zur Verwendung von SAS.

Ereignis-Hub Azure Active Directory Auth

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
Anmeldedaten	Beschreibung
`tenantId`	Die Mandantenkennung, von der Sie die Berechtigung anfordern möchten. Ihre Mandantenkennung kann als GUID oder als benutzerfreundlicher Name formatiert werden. Hinweis: Die Mandanten-ID wird in der Microsoft Azure -Benutzeroberfläche als "Verzeichnis-ID"bezeichnet.
`clientId`	Die Ihrer App zugewiesene Anwendungs-ID. Sie können diese ID aus dem Microsoft Entra ID-Portal abrufen, in dem Sie Ihre Azure Active Directory registriert haben.
`clientSecretValue`	Das Client-Geheimnis, das zusammen mit der Client-ID zur Authentifizierung Ihrer App verwendet wird. Sie können Ihr Client-Geheimnis aus dem Microsoft Entra ID-Portal abrufen, in dem Sie Ihre Azure Active Directory registriert haben.
`namespace`	Der Namespace der Event Hub , auf die Sie zugreifen. Ein Namespace Event Hub bietet einen eindeutigen Scoping-Container, in dem Sie einen oder mehrere Event Hubs erstellen können.

Weitere Informationen zu Azure Active Directory finden Sie im Leitfaden Azure zur Verwendung der Microsoft Entra ID.

Ereignis-Hub-Scoped Azure Active Directory Auth

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
Anmeldedaten	Beschreibung
`tenantId`	Die Mandantenkennung, von der Sie die Berechtigung anfordern möchten. Ihre Mandantenkennung kann als GUID oder als benutzerfreundlicher Name formatiert werden. Hinweis: Die Mandanten-ID wird in der Microsoft Azure -Benutzeroberfläche als "Verzeichnis-ID"bezeichnet.
`clientId`	Die Ihrer App zugewiesene Anwendungs-ID. Sie können diese ID aus dem Microsoft Entra ID-Portal abrufen, in dem Sie Ihre Azure Active Directory registriert haben.
`clientSecretValue`	Das Client-Geheimnis, das zusammen mit der Client-ID zur Authentifizierung Ihrer App verwendet wird. Sie können Ihr Client-Geheimnis aus dem Microsoft Entra ID-Portal abrufen, in dem Sie Ihre Azure Active Directory registriert haben.
`namespace`	Der Namespace der Event Hub , auf die Sie zugreifen. Ein Namespace Event Hub bietet einen eindeutigen Scoping-Container, in dem Sie einen oder mehrere Event Hubs erstellen können.
`eventHubName`	Geben Sie Ihren Azure Event Hub Namen ein. Weitere Informationen zu Event Hub -Namen finden Sie in der Microsoft-Dokumentation .

Weitere Informationen zu diesen Werten finden Sie in diesem Dokument zu Ereignis-Hubs .

Verwenden von Platform-APIs

Informationen zum Aufrufen von Platform-APIs finden Sie im Handbuch unter Erste Schritte mit Platform-APIs.

Erstellen einer Basisverbindung

TIP

Nach der Erstellung können Sie den Authentifizierungstyp einer Basis-Verbindung vom Typ Event Hubs nicht mehr ändern. Um den Authentifizierungstyp zu ändern, müssen Sie eine neue Basisverbindung erstellen.

Der erste Schritt beim Erstellen einer Quellverbindung besteht darin, Ihre Event Hubs-Quelle zu authentifizieren und eine Basisverbindungs-ID zu generieren. Mittels einer Basisverbindungs-ID können Sie Dateien aus Ihrer Quelle durchsuchen, zwischen Dateien innerhalb der Quelle navigieren und bestimmte Elemente identifizieren, die Sie erfassen möchten, einschließlich Informationen zu Datentypen und Formaten.

Um eine Basisverbindungs-ID zu erstellen, stellen Sie eine POST-Anfrage an den /connections-Endpunkt beim Bereitstellen der Event Hubs-Authentifizierungsberechtigungsdaten als Teil der Anfrageparameter.

API-Format

POST /connections

Standardauthentifizierung

Um ein Konto mit Standardauthentifizierung zu erstellen, stellen Sie eine POST-Anfrage an den /connections -Endpunkt und geben Sie dabei Werte für Ihre sasKeyName, sasKey und namespace an.

accordion

Anfrage

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
Eigenschaft	Beschreibung
`auth.params.sasKeyName`	Der Name der Autorisierungsregel, der auch als SAS-Schlüsselname bezeichnet wird.
`auth.params.sasKey`	Die generierte Signatur für den freigegebenen Zugriff.
`auth.params.namespace`	Der Namespace der Event Hubs , auf die Sie zugreifen.
`connectionSpec.id`	Die Event Hubs Verbindungsspezifikations-ID lautet: `bf9f5905-92b7-48bf-bf20-455bc6b60a4e`

accordion

Antwort

Bei einer erfolgreichen Antwort werden Details zu der neu erstellten Basisverbindung zurückgegeben, einschließlich ihrer eindeutigen Kennung (id). Diese Verbindungs-ID ist im nächsten Schritt erforderlich, um eine Quellverbindung zu erstellen.

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

SAS-Authentifizierung

Um ein Konto mit SAS-Authentifizierung zu erstellen, stellen Sie eine POST-Anfrage an den /connections -Endpunkt und geben Sie dabei Werte für Ihre sasKeyName, sasKey, namespace und eventHubName an.

accordion

Anfrage

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
Eigenschaft	Beschreibung
`auth.params.sasKeyName`	Der Name der Autorisierungsregel, der auch als SAS-Schlüsselname bezeichnet wird.
`auth.params.sasKey`	Die generierte Signatur für den freigegebenen Zugriff.
`auth.params.namespace`	Der Namespace der Event Hubs , auf die Sie zugreifen.
`params.eventHubName`	Der Name Ihrer Event Hubs-Quelle.
`connectionSpec.id`	Die Event Hubs Verbindungsspezifikations-ID lautet: `bf9f5905-92b7-48bf-bf20-455bc6b60a4e`

accordion

Antwort

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

Ereignis-Hub Azure Active Directory Auth

Um ein Konto mit Azure Active Directory Auth zu erstellen, stellen Sie eine POST-Anfrage an den /connections -Endpunkt und geben Sie dabei Werte für Ihre tenantId, clientId, clientSecretValue und namespace an.

accordion

Anfrage

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
Eigenschaft	Beschreibung
`auth.params.tenantId`	Die Mandantenkennung Ihrer Anwendung. Hinweis: Die Mandanten-ID wird in der Microsoft Azure -Benutzeroberfläche als "Verzeichnis-ID"bezeichnet.
`auth.params.clientId`	Die Client-ID Ihres Unternehmens.
`auth.params.clientSecretValue`	Der Client-Geheimwert Ihres Unternehmens.
`auth.params.namespace`	Der Namespace der Event Hubs , auf die Sie zugreifen.
`connectionSpec.id`	Die Event Hubs Verbindungsspezifikations-ID lautet: `bf9f5905-92b7-48bf-bf20-455bc6b60a4e`

accordion

Antwort

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

Ereignis-Hub-Scoped Azure Active Directory Auth

accordion

Anfrage

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
Eigenschaft	Beschreibung
`auth.params.tenantId`	Die Mandantenkennung Ihrer Anwendung. Hinweis: Die Mandanten-ID wird in der Microsoft Azure -Benutzeroberfläche als "Verzeichnis-ID"bezeichnet.
`auth.params.clientId`	Die Client-ID Ihres Unternehmens.
`auth.params.clientSecretValue`	Der Client-Geheimwert Ihres Unternehmens.
`auth.params.namespace`	Der Namespace der Event Hubs , auf die Sie zugreifen.
`auth.params.eventHubName`	Der Name Ihrer Event Hubs-Quelle.
`connectionSpec.id`	Die Event Hubs Verbindungsspezifikations-ID lautet: `bf9f5905-92b7-48bf-bf20-455bc6b60a4e`

accordion

Antwort

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

Erstellen einer Quellverbindung

TIP

Eine Event Hubs Verbrauchergruppe kann jeweils nur für einen einzigen Fluss verwendet werden.

Eine Quellverbindung erstellt und verwaltet die Verbindung zu der externen Quelle, aus der Daten erfasst werden. Eine Quellverbindung besteht aus Informationen wie Datenquelle, Datenformat und einer Quell-Verbindungs-ID, die zum Erzeugen eines Datenflusses erforderlich sind. Eine Quellverbindungsinstanz ist für einen Mandanten und eine Organisation spezifisch.

Um eine Quellverbindung zu erstellen, stellen Sie eine POST-Anfrage an den /sourceConnections-Endpunkt der Flow Service-API.

API-Format

POST /sourceConnections

Anfrage

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}"
      }
  }'

Eigenschaft

Beschreibung

name

Der Name Ihrer Quellverbindung. Stellen Sie sicher, dass der Name Ihrer Quellverbindung beschreibend ist, da Sie damit Informationen zu Ihrer Quellverbindung nachschlagen können.

description

Ein optionaler Wert, den Sie angeben können, um weitere Informationen zu Ihrer Quellverbindung einzuschließen.

baseConnectionId

Die Verbindungs-ID Ihrer Event Hubs -Quelle, die im vorherigen Schritt generiert wurde.

connectionSpec.id

Die feste Verbindungsspezifikations-ID für Event Hubs. Diese ID lautet: bf9f5905-92b7-48bf-bf20-455bc6b60a4e.

data.format

Das Format der Event Hubs-Daten, die Sie aufnehmen möchten. Derzeit wird nur das Datenformat json unterstützt.

params.eventHubName

Der Name Ihrer Event Hubs-Quelle.

params.dataType

Dieser Parameter definiert den Typ der aufgenommenen Daten. Zu den unterstützten Datentypen gehören: raw und xdm.

params.reset

Dieser Parameter definiert, wie die Daten gelesen werden. Verwenden Sie latest , um mit dem Lesen der neuesten Daten zu beginnen, und verwenden Sie earliest, um mit dem Lesen der ersten verfügbaren Daten im Stream zu beginnen. Dieser Parameter ist optional und standardmäßig auf earliest festgelegt, wenn er nicht angegeben wird.

params.consumerGroup

Der Veröffentlichungs- oder Abonnementmechanismus, der für Event Hubs verwendet werden soll. Dieser Parameter ist optional und standardmäßig auf $Default festgelegt, wenn er nicht angegeben wird. Weitere Informationen finden Sie in diesem Event Hubs Handbuch zu Ereigniskonsumenten . Hinweis: Eine Event Hubs Verbrauchergruppe kann nur für einen einzelnen Fluss gleichzeitig verwendet werden.

Nächste Schritte

In diesem Tutorial haben Sie eine Event Hubs-Quellverbindung mit der Flow Service-API erstellt. Sie können diese Quellverbindungs-ID im nächsten Tutorial verwenden, um einen Streaming-Datenfluss mit der Flow Service -API zu erstellen.

recommendation-more-help

337b99bb-92fb-42ae-b6b7-c7042161d089