建立 Azure Event Hubs 源連接使用 Flow Service API

本教學課程會逐步引導您完成連線步驟 Azure Event Hubs (下稱「Event Hubs")Experience Platform,使用 Flow Service API.

快速入門

本指南需要妥善了解下列Adobe Experience Platform元件:

  • 來源: Experience Platform 可讓您從各種來源擷取資料,同時使用來建構、加標籤及增強傳入資料 Platform 服務。
  • 沙箱: Experience Platform 提供可分割單一沙箱的虛擬沙箱 Platform 例項放入個別的虛擬環境,以協助開發及改進數位體驗應用程式。

以下各節提供了成功連接所需的其他資訊 Event Hubs 到使用 Flow Service API。

收集所需憑據

為了 Flow Service 與 Event Hubs 帳戶,您必須提供下列連線屬性的值:

憑據 說明
sasKeyName 授權規則的名稱,也稱為SAS密鑰名稱。
sasKey 的主鍵 Event Hubs 命名空間。 此 sasPolicy the sasKey 對應到必須有 manage 為 Event Hubs 清單。
namespace 的命名空間 Event Hubs 您正在存取。 安 Event Hubs 命名空間提供唯一的範圍界定容器,您可在其中建立一或多個 Event Hubs.
connectionSpec.id 連接規範返回源的連接器屬性,包括與建立基連接和源連接相關的驗證規範。 此 Event Hubs 連接規範ID為: bf9f5905-92b7-48bf-bf20-455bc6b60a4e.

如需這些值的詳細資訊,請參閱 此事件中心文檔.

使用平台API

如需如何成功呼叫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: {IMS_ORG}' \
    -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: {IMS_Org}' \
    -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 此參數會定義正在擷取的資料類型。 支援的資料類型包括: rawxdm.
params.reset 此參數會定義資料的讀取方式。 使用 latest 從最新資料開始讀取,並使用 earliest 從資料流中的第一個可用資料開始讀取。 此參數為選用,預設值為 earliest 若未提供。
params.consumerGroup 要用於的發佈或訂閱機制 Event Hubs. 此參數為選用,預設值為 $Default 若未提供。 請參閱 Event Hubs 活動使用者指南 以取得更多資訊。

後續步驟

依照本教學課程,您已建立 Event Hubs 源連接使用 Flow Service API。 您可以在下一個教學課程中使用此來源連線ID 使用 Flow Service API.

本頁內容