本教程将指导您完成连接的步骤 Azure Event Hubs (以下简称“Event Hubs")Experience Platform,使用 Flow Service API.
本指南要求您对Adobe Experience Platform的以下组件有一定的了解:
以下部分提供了成功连接所需了解的其他信息 Event Hubs 使用 Flow Service API。
为 Flow Service 与 Event Hubs 帐户,则必须为以下连接属性提供值:
凭据 | 描述 |
---|---|
sasKeyName |
授权规则的名称,也称为SAS密钥名称。 |
sasKey |
的主键 Event Hubs 命名空间。 的 sasPolicy 该 sasKey 对应于必须拥有 manage 为 Event Hubs 列表。 |
namespace |
的命名空间 Event Hubs 您正在访问。 安 Event Hubs 命名空间提供了唯一的作用域容器,您可以在其中创建一个或多个 Event Hubs. |
connectionSpec.id |
连接规范返回源的连接器属性,包括与创建基连接和源连接相关的验证规范。 的 Event Hubs 连接规范ID是: bf9f5905-92b7-48bf-bf20-455bc6b60a4e . |
有关这些值的更多信息,请参阅 此事件中心文档.
有关如何成功调用Platform API的信息,请参阅 Platform API快速入门.
创建源连接的第一步是验证您的 Event Hubs 源并生成基本连接ID。 基本连接ID允许您从源中浏览和导航文件,并标识要摄取的特定项目,包括有关其数据类型和格式的信息。
要创建基本连接ID,请向 /connections
提供 Event Hubs 身份验证凭据作为请求参数的一部分。
API格式
POST /connections
请求
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 |
授权规则的名称,也称为SAS密钥名称。 |
auth.params.sasKey |
生成的共享访问签名。 |
auth.params.namespace |
的命名空间 Event Hubs 您正在访问。 |
connectionSpec.id |
的 Event Hubs 连接规范ID是: bf9f5905-92b7-48bf-bf20-455bc6b60a4e |
响应
成功的响应会返回新创建的基本连接的详细信息,包括其唯一标识符(id
)。 要创建源连接,需要在下一步中使用此连接ID。
{
"id": "4cdbb15c-fb1e-46ee-8049-0f55b53378fe",
"etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}
源连接创建并管理从中摄取数据的外部源的连接。 源连接由创建数据流所需的数据源、数据格式和源连接ID等信息组成。 源连接实例特定于租户和IMS组织。
要创建源连接,请向 /sourceConnections
的端点 Flow Service API。
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": "{EVENTHUB_NAME}",
"dataType": "raw",
"reset": "latest",
"consumerGroup": "{CONSUMER_GROUP}"
}
}'
属性 | 描述 |
---|---|
name |
源连接的名称。 确保源连接的名称具有描述性,因为您可以使用该名称查找有关源连接的信息。 |
description |
可提供的可选值,用于包含有关源连接的更多信息。 |
baseConnectionId |
您的 Event Hubs 上一步中生成的源。 |
connectionSpec.id |
的固定连接规范ID Event Hubs. 此ID为: bf9f5905-92b7-48bf-bf20-455bc6b60a4e . |
data.format |
的格式 Event Hubs 要摄取的数据。 目前,唯一支持的数据格式是 json . |
params.eventHubName |
您的 Event Hubs 来源。 |
params.dataType |
此参数定义正在摄取的数据的类型。 支持的数据类型包括: raw 和 xdm . |
params.reset |
此参数定义数据的读取方式。 使用 latest 以开始从最新数据中读取,并使用 earliest 从流中的第一个可用数据开始读取。 此参数为可选参数,默认为 earliest 如果未提供。 |
params.consumerGroup |
要用于的发布或订阅机制 Event Hubs. 此参数为可选参数,默认为 $Default 如果未提供。 请参阅 Event Hubs 事件消费者指南 以了解更多信息。 |
通过阅读本教程,您已创建 Event Hubs 源连接使用 Flow Service API。 在下一个教程中,您可以使用此源连接ID 使用创建流数据流 Flow Service API.