Ultimate
使用Flow Service API创建Azure Event Hubs源连接
创建对象:
- 开发人员
阅读本教程,了解如何使用Flow Service API将Azure Event Hubs(以下简称“Event Hubs”)连接到Experience Platform。
快速入门
本指南要求您对 Adobe Experience Platform 的以下组件有一定了解:
以下部分提供了使用Flow Service API成功将Event Hubs连接到Experience Platform所需了解的其他信息。
收集所需的凭据
为了使Flow Service与您的Event Hubs帐户连接,您必须提供以下连接属性的值:
凭据 | 描述 |
---|---|
sasKeyName | 授权规则的名称,也称为SAS密钥名称。 |
sasKey | Event Hubs命名空间的主键。 sasKey 对应的sasPolicy 必须配置manage 权限才能填充Event Hubs列表。 |
namespace | 您正在访问的Event Hub的命名空间。 Event Hub命名空间提供了一个唯一的范围容器,您可以在其中创建一个或多个Event Hubs。 |
connectionSpec.id | 连接规范返回源的连接器属性,包括与创建基础连接和源连接相关的验证规范。 Event Hubs连接规范ID为: bf9f5905-92b7-48bf-bf20-455bc6b60a4e 。 |
凭据 | 描述 |
---|---|
sasKeyName | 授权规则的名称,也称为SAS密钥名称。 |
sasKey | Event Hubs命名空间的主键。 sasKey 对应的sasPolicy 必须配置manage 权限才能填充Event Hubs列表。 |
namespace | 您正在访问的Event Hub的命名空间。 Event Hub命名空间提供了一个唯一的范围容器,您可以在其中创建一个或多个Event Hubs。 |
eventHubName | 填写您的Azure Event Hub名称。 有关Event Hub名称的详细信息,请阅读Microsoft文档。 |
connectionSpec.id | 连接规范返回源的连接器属性,包括与创建基础连接和源连接相关的验证规范。 Event Hubs连接规范ID为: bf9f5905-92b7-48bf-bf20-455bc6b60a4e 。 |
有关Event Hubs的共享访问签名(SAS)身份验证的更多信息,请阅读有关使用SAS🔗的Azure 指南。
凭据 | 描述 |
---|---|
tenantId | 要从中请求权限的租户ID。 可以将您的租户ID格式化为GUID或友好名称。 注意:租户ID在Microsoft Azure界面中称为“目录ID”。 |
clientId | 分配给您应用程序的应用程序ID。 您可以从注册Azure Active Directory的Microsoft Entra ID门户检索此ID。 |
clientSecretValue | 与客户端ID一起用于对应用程序进行身份验证的客户端密码。 您可以从注册Azure Active Directory的Microsoft Entra ID门户中检索客户端密钥。 |
namespace | 您正在访问的Event Hub的命名空间。 Event Hub命名空间提供了一个唯一的范围容器,您可以在其中创建一个或多个Event Hubs。 |
有关Azure Active Directory的详细信息,请阅读有关使用Microsoft Entra ID🔗的Azure指南。
tenantId
clientId
clientSecretValue
namespace
eventHubName
有关这些值的详细信息,请参阅此事件中心文档。
创建源连接的第一步是验证您的Event Hubs源并生成基本连接ID。 基本连接ID允许您浏览和浏览源中的文件,并识别要摄取的特定项目,包括有关其数据类型和格式的信息。
要创建基本连接ID,请在提供您的Event Hubs身份验证凭据作为请求参数的一部分时,向/connections
端点发出POST请求。
API格式
POST /connections
要使用标准身份验证创建帐户,请在为您的sasKeyName
、sasKey
和namespace
提供值时向/connections
端点发出POST请求。
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
成功的响应返回新创建的基本连接的详细信息,包括其唯一标识符(id
)。 在下一步创建源连接时需要此连接ID。
{
"id": "4cdbb15c-fb1e-46ee-8049-0f55b53378fe",
"etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}
要使用SAS身份验证创建帐户,请在为您的sasKeyName
、sasKey
、namespace
和eventHubName
提供值时向/connections
端点发出POST请求。
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
成功的响应返回新创建的基本连接的详细信息,包括其唯一标识符(id
)。 在下一步创建源连接时需要此连接ID。
{
"id": "4cdbb15c-fb1e-46ee-8049-0f55b53378fe",
"etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}
要使用Azure Active Directory身份验证创建帐户,请在为您的tenantId
、clientId
、clientSecretValue
和namespace
提供值时向/connections
端点发出POST请求。
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
成功的响应返回新创建的基本连接的详细信息,包括其唯一标识符(id
)。 在下一步创建源连接时需要此连接ID。
{
"id": "4cdbb15c-fb1e-46ee-8049-0f55b53378fe",
"etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}
要使用Azure Active Directory身份验证创建帐户,请在为您的tenantId
、clientId
、clientSecretValue
、namespace
和eventHubName
提供值时向/connections
端点发出POST请求。
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
成功的响应返回新创建的基本连接的详细信息,包括其唯一标识符(id
)。 在下一步创建源连接时需要此连接ID。
{
"id": "4cdbb15c-fb1e-46ee-8049-0f55b53378fe",
"etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}
创建源连接
源连接创建和管理与摄取数据的外部源的连接。 源连接由数据源、数据格式和创建数据流所需的源连接ID等信息组成。 源连接实例特定于租户和组织。
要创建源连接,请向Flow Service API的/sourceConnections
端点发出POST请求。
API格式
POST /sourceConnections
请求
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
和xdm
。params.reset
latest
开始读取最新数据,并使用earliest
开始读取流中的第一个可用数据。 此参数是可选的,如果未提供,则默认为earliest
。params.consumerGroup
$Default
。 有关详细信息,请参阅此Event Hubs 关于事件使用者的指南。 注意: Event Hubs使用者组只能在给定时间用于单个流。后续步骤
通过学习本教程,您已使用Flow Service API创建了Event Hubs源连接。 您可以在下一个教程中使用此源连接ID来使用 Flow Service API创建流式数据流。