Documentatie Experience Platform Gids voor Source Connectors

[Ultieme]{class="badge positive"}

Een Azure Event Hubs bronverbinding maken met de Flow Service API

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

Onderwerpen:

Gemaakt voor:

Ontwikkelaar

IMPORTANT

De Azure Event Hubs -bron is in de broncatalogus beschikbaar voor gebruikers die Real-time Customer Data Platform Ultimate hebben aangeschaft.

Lees dit leerprogramma leren hoe te om Azure Event Hubs (verder te verbinden die als " Event Hubs") aan Experience Platform wordt bedoeld, gebruikend Flow Service API.

Aan de slag

Deze handleiding vereist een goed begrip van de volgende onderdelen van Adobe Experience Platform:

Bronnen: Experience Platform staat gegevens toe om van diverse bronnen worden opgenomen terwijl het voorzien van u van de capaciteit om, inkomende gegevens te structureren te etiketteren en te verbeteren gebruikend Platform diensten.
Sandboxen: Experience Platform verstrekt virtuele zandbakken die één enkele Platform instantie in afzonderlijke virtuele milieu's verdelen helpen digitale ervaringstoepassingen ontwikkelen en ontwikkelen.

In de volgende secties vindt u aanvullende informatie die u nodig hebt om Event Hubs met de API van Flow Service te kunnen verbinden met Platform.

Vereiste referenties verzamelen

Flow Service kan alleen verbinding maken met uw Event Hubs -account als u waarden opgeeft voor de volgende verbindingseigenschappen:

Standaard authentificatie

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
Credentials	Beschrijving
`sasKeyName`	De naam van de machtigingsregel, ook wel de SAS-sleutelnaam genoemd.
`sasKey`	De primaire sleutel van de naamruimte Event Hubs . De `sasPolicy` die `sasKey` aansluit bij `manage` , moet rechten hebben geconfigureerd om de Event Hubs -lijst te vullen.
`namespace`	De naamruimte van de Event Hub die u opent. Een naamruimte Event Hub biedt een unieke container voor het bereik, waarin u een of meer naamruimten kunt maken Event Hubs .
`connectionSpec.id`	De verbindingsspecificatie keert de schakelaareigenschappen van een bron, met inbegrip van authentificatiespecificaties met betrekking tot het creëren van de basis en bronverbindingen terug. De Event Hubs -id van de verbindingsspecificatie is: `bf9f5905-92b7-48bf-bf20-455bc6b60a4e` .

SAS authentificatie

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
Credentials	Beschrijving
`sasKeyName`	De naam van de machtigingsregel, ook wel de SAS-sleutelnaam genoemd.
`sasKey`	De primaire sleutel van de naamruimte Event Hubs . De `sasPolicy` die `sasKey` aansluit bij `manage` , moet rechten hebben geconfigureerd om de Event Hubs -lijst te vullen.
`namespace`	De naamruimte van de Event Hub die u opent. Een naamruimte Event Hub biedt een unieke container voor het bereik, waarin u een of meer naamruimten kunt maken Event Hubs .
`eventHubName`	Vul de naam Azure Event Hub in. Lees de documentatie van Microsoftvoor meer informatie over Event Hub namen.
`connectionSpec.id`	De verbindingsspecificatie keert de schakelaareigenschappen van een bron, met inbegrip van authentificatiespecificaties met betrekking tot het creëren van de basis en bronverbindingen terug. De Event Hubs -id van de verbindingsspecificatie is: `bf9f5905-92b7-48bf-bf20-455bc6b60a4e` .

Voor meer informatie over de authentificatie van gedeelde toegangshandtekeningen (SAS) voor Event Hubs, lees de Azure gids bij het gebruiken van SAS.

Hub van de Gebeurtenis Azure Actieve Auth van de Folder

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
Credentials	Beschrijving
`tenantId`	De huurder-id waarvan u toestemming wilt vragen. Uw huurder identiteitskaart kan als GUID of als vriendschappelijke naam worden geformatteerd. Nota: De huurder identiteitskaart wordt bedoeld als "identiteitskaart van de Folder"in de Microsoft Azure interface.
`clientId`	De toepassings-id die aan uw app is toegewezen. U kunt deze id ophalen via de portal Microsoft Entra ID waar u uw Azure Active Directory hebt geregistreerd.
`clientSecretValue`	Het clientgeheim dat naast de client-id wordt gebruikt om uw app te verifiëren. U kunt uw clientgeheim ophalen via de Microsoft Entra ID -portal waar u uw Azure Active Directory hebt geregistreerd.
`namespace`	De naamruimte van de Event Hub die u opent. Een naamruimte Event Hub biedt een unieke container voor het bereik, waarin u een of meer naamruimten kunt maken Event Hubs .

Voor meer informatie over Azure Active Directory, lees de Azure gids bij het gebruiken van identiteitskaart van Microsoft Entra.

Hub Scoped Azure Actieve Auth van de Folder van de Gebeurtenis

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
Credentials	Beschrijving
`tenantId`	De huurder-id waarvan u toestemming wilt vragen. Uw huurder identiteitskaart kan als GUID of als vriendschappelijke naam worden geformatteerd. Nota: De huurder identiteitskaart wordt bedoeld als "identiteitskaart van de Folder"in de Microsoft Azure interface.
`clientId`	De toepassings-id die aan uw app is toegewezen. U kunt deze id ophalen via de portal Microsoft Entra ID waar u uw Azure Active Directory hebt geregistreerd.
`clientSecretValue`	Het clientgeheim dat naast de client-id wordt gebruikt om uw app te verifiëren. U kunt uw clientgeheim ophalen via de Microsoft Entra ID -portal waar u uw Azure Active Directory hebt geregistreerd.
`namespace`	De naamruimte van de Event Hub die u opent. Een naamruimte Event Hub biedt een unieke container voor het bereik, waarin u een of meer naamruimten kunt maken Event Hubs .
`eventHubName`	Vul de naam Azure Event Hub in. Lees de documentatie van Microsoftvoor meer informatie over Event Hub namen.

Voor meer informatie over deze waarden, verwijs naar dit document van de Hubs van deze Gebeurtenis.

Platform-API's gebruiken

Voor informatie over hoe te om vraag aan Platform APIs met succes te maken, zie de gids op begonnen wordt met Platform APIs.

Een basisverbinding maken

TIP

Nadat u een Event Hubs basisverbinding hebt gemaakt, kunt u het verificatietype niet wijzigen. Als u het verificatietype wilt wijzigen, moet u een nieuwe basisverbinding maken.

De eerste stap bij het maken van een bronverbinding is het verifiëren van de Event Hubs -bron en het genereren van een basis-verbindings-id. Met een basis-verbindings-id kunt u bestanden verkennen en door de bestanden navigeren vanuit de bron en specifieke items identificeren die u wilt invoeren, zoals informatie over de gegevenstypen en indelingen.

Als u een basis-verbindings-id wilt maken, vraagt u een POST naar het /connections -eindpunt en geeft u de Event Hubs -verificatiegegevens op als onderdeel van de aanvraagparameters.

API formaat

POST /connections

Standaard authentificatie

Als u een account wilt maken met behulp van standaardverificatie, vraagt u een POST naar het /connections -eindpunt en geeft u waarden op voor de sasKeyName , sasKey en namespace .

accordion

verzoek

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
Eigenschap	Beschrijving
`auth.params.sasKeyName`	De naam van de machtigingsregel, ook wel de SAS-sleutelnaam genoemd.
`auth.params.sasKey`	De gegenereerde handtekening voor gedeelde toegang.
`auth.params.namespace`	De naamruimte van de Event Hubs die u opent.
`connectionSpec.id`	De Event Hubs connection specification ID is: `bf9f5905-92b7-48bf-bf20-455bc6b60a4e`

accordion

Response

Een succesvolle reactie keert details van de pas gecreëerde basisverbinding, met inbegrip van zijn uniek herkenningsteken (id) terug. Deze verbinding-id is vereist in de volgende stap om een bronverbinding te maken.

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

SAS authentificatie

Als u een account wilt maken met behulp van SAS-verificatie, vraagt u een POST naar het /connections -eindpunt en geeft u waarden op voor de sasKeyName , sasKey , namespace en eventHubName .

accordion

verzoek

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
Eigenschap	Beschrijving
`auth.params.sasKeyName`	De naam van de machtigingsregel, ook wel de SAS-sleutelnaam genoemd.
`auth.params.sasKey`	De gegenereerde handtekening voor gedeelde toegang.
`auth.params.namespace`	De naamruimte van de Event Hubs die u opent.
`params.eventHubName`	De naam voor de Event Hubs -bron.
`connectionSpec.id`	De Event Hubs connection specification ID is: `bf9f5905-92b7-48bf-bf20-455bc6b60a4e`

accordion

Response

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

Hub van de Gebeurtenis Azure Actieve Auth van de Folder

Als u een account wilt maken met Azure Active Directory Auth, vraagt u een POST naar het /connections -eindpunt terwijl u waarden opgeeft voor uw tenantId , clientId , clientSecretValue en namespace .

accordion

verzoek

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
Eigenschap	Beschrijving
`auth.params.tenantId`	De huurder-id van uw toepassing. Nota: De huurder identiteitskaart wordt bedoeld als "identiteitskaart van de Folder"in de Microsoft Azure interface.
`auth.params.clientId`	De client-id van uw organisatie.
`auth.params.clientSecretValue`	De geheime waarde van de cliënt van uw organisatie.
`auth.params.namespace`	De naamruimte van de Event Hubs die u opent.
`connectionSpec.id`	De Event Hubs connection specification ID is: `bf9f5905-92b7-48bf-bf20-455bc6b60a4e`

accordion

Response

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

Hub Scoped Azure Actieve Auth van de Folder van de Gebeurtenis

Als u een account wilt maken met Azure Active Directory Auth, vraagt u een POST naar het /connections -eindpunt en geeft u waarden op voor uw tenantId , clientId , clientSecretValue , namespace en eventHubName .

accordion

verzoek

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
Eigenschap	Beschrijving
`auth.params.tenantId`	De huurder-id van uw toepassing. Nota: De huurder identiteitskaart wordt bedoeld als "identiteitskaart van de Folder"in de Microsoft Azure interface.
`auth.params.clientId`	De client-id van uw organisatie.
`auth.params.clientSecretValue`	De geheime waarde van de cliënt van uw organisatie.
`auth.params.namespace`	De naamruimte van de Event Hubs die u opent.
`auth.params.eventHubName`	De naam voor de Event Hubs -bron.
`connectionSpec.id`	De Event Hubs connection specification ID is: `bf9f5905-92b7-48bf-bf20-455bc6b60a4e`

accordion

Response

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

Een bronverbinding maken

TIP

Een consumentengroep van Event Hubs kan slechts voor één enkele stroom in een bepaald tijd worden gebruikt.

Een bronverbinding maakt en beheert de verbinding met de externe bron vanwaar gegevens worden ingevoerd. Een bronverbinding bestaat uit informatie zoals gegevensbron, gegevensformaat, en een identiteitskaart van de bronverbinding nodig om een gegevensstroom tot stand te brengen. Een bronverbindingsinstantie is specifiek voor een huurder en organisatie.

Als u een bronverbinding wilt maken, vraagt u een POST naar het /sourceConnections -eindpunt van de Flow Service API.

API formaat

POST /sourceConnections

Verzoek

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

Eigenschap

Beschrijving

name

De naam van de bronverbinding. Zorg ervoor dat de naam van uw bronverbinding beschrijvend is aangezien u dit kunt gebruiken om informatie over uw bronverbinding op te zoeken.

description

Een optionele waarde die u kunt opgeven voor meer informatie over uw bronverbinding.

baseConnectionId

De verbindings-id van de Event Hubs -bron die in de vorige stap is gegenereerd.

connectionSpec.id

The fixed connection specification ID for Event Hubs. Deze id is: bf9f5905-92b7-48bf-bf20-455bc6b60a4e .

data.format

De indeling van de Event Hubs -gegevens die u wilt invoeren. Momenteel is de enige ondersteunde gegevensindeling json .

params.eventHubName

De naam voor de Event Hubs -bron.

params.dataType

Deze parameter bepaalt het type van de gegevens die worden opgenomen. Tot de ondersteunde gegevenstypen behoren: raw en xdm .

params.reset

Deze parameter bepaalt hoe de gegevens worden gelezen. Gebruik latest om te beginnen met het lezen van de meest recente gegevens en gebruik earliest om te beginnen met het lezen van de eerste beschikbare gegevens in de stream. Deze parameter is optioneel en wordt standaard ingesteld op earliest als deze niet wordt opgegeven.

params.consumerGroup

Het publicatie- of abonnementsmechanisme dat voor Event Hubs moet worden gebruikt. Deze parameter is optioneel en wordt standaard ingesteld op $Default als deze niet wordt opgegeven. Verwijs naar deze Event Hubs gids op gebeurtenisconsumentenvoor meer informatie. Nota: Een Event Hubs consumentengroep kan slechts voor één enkele stroom in een bepaalde tijd worden gebruikt.

Volgende stappen

Aan de hand van deze zelfstudie hebt u een Event Hubs -bronverbinding gemaakt met de Flow Service API. U kunt deze bron verbindingsidentiteitskaart in het volgende leerprogramma gebruiken om een het stromen dataflow tot stand te brengen gebruikend Flow Service API.

recommendation-more-help

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