[Ultimate]{class="badge positive"}

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

IMPORTANT
此 Azure Event Hubs 已購買Real-time Customer Data Platform Ultimate的使用者可在來源目錄中取得來源。

閱讀本教學課程以瞭解如何連線 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 帳戶,您必須提供下列連線屬性的值:

標準驗證
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
認證 說明
sasKeyName 授權規則的名稱,也稱為SAS金鑰名稱。
sasKey 的主要索引鍵 Event Hubs 名稱空間。 此 sasPolicysasKey 對應到必須具有 manage 已設定的許可權,以用於 Event Hubs 要填入的清單。
namespace 的名稱空間 Event Hubs 您正在存取。 一個 Event Hubs namespace提供唯一的範圍設定容器,您可以在其中建立一或多個 Event Hubs.
connectionSpec.id 連線規格會傳回來源的聯結器屬性,包括與建立基礎連線和來源連線相關的驗證規格。 此 Event Hubs 連線規格ID為: bf9f5905-92b7-48bf-bf20-455bc6b60a4e.
SAS驗證
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
認證 說明
sasKeyName 授權規則的名稱,也稱為SAS金鑰名稱。
sasKey 的主要索引鍵 Event Hubs 名稱空間。 此 sasPolicysasKey 對應到必須具有 manage 已設定的許可權,以用於 Event Hubs 要填入的清單。
namespace 的名稱空間 Event Hubs 您正在存取。 一個 Event Hubs namespace提供唯一的範圍設定容器,您可以在其中建立一或多個 Event Hubs.
eventHubName 您的名稱 Event Hubs 來源。
connectionSpec.id 連線規格會傳回來源的聯結器屬性,包括與建立基礎連線和來源連線相關的驗證規格。 此 Event Hubs 連線規格ID為: bf9f5905-92b7-48bf-bf20-455bc6b60a4e.

如需下列專案的共用存取簽章(SAS)驗證的詳細資訊: Event Hubs,閱讀 Azure 使用SAS指南.

事件中樞Azure Active Directory驗證
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
認證 說明
tenantId 您要向其請求許可權的租使用者ID。 您可以將您的租使用者ID格式化為GUID或友好名稱。 注意:租使用者ID在中稱為「目錄ID」。 Microsoft Azure 介面。
clientId 指派給應用程式的應用程式ID。 您可以從以下位置擷取此ID: Microsoft Entra ID 您註冊的入口網站 Azure Active Directory.
clientSecretValue 使用者端密碼與使用者端ID搭配使用,用來驗證您的應用程式。 您可以從以下位置擷取您的使用者端密碼: Microsoft Entra ID 您註冊的入口網站 Azure Active Directory.
namespace 的名稱空間 Event Hubs 您正在存取。 一個 Event Hubs namespace提供唯一的範圍設定容器,您可以在其中建立一或多個 Event Hubs.

如需詳細資訊,請參閱 Azure Active Directory,閱讀 使用Microsoft Entra ID的Azure指南.

事件中心範圍的Azure Active Directory驗證
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
認證 說明
tenantId 您要向其請求許可權的租使用者ID。 您可以將您的租使用者ID格式化為GUID或友好名稱。 注意:租使用者ID在中稱為「目錄ID」。 Microsoft Azure 介面。
clientId 指派給應用程式的應用程式ID。 您可以從以下位置擷取此ID: Microsoft Entra ID 您註冊的入口網站 Azure Active Directory.
clientSecretValue 使用者端密碼與使用者端ID搭配使用,用來驗證您的應用程式。 您可以從以下位置擷取您的使用者端密碼: Microsoft Entra ID 您註冊的入口網站 Azure Active Directory.
namespace 的名稱空間 Event Hubs 您正在存取。 一個 Event Hubs namespace提供唯一的範圍設定容器,您可以在其中建立一或多個 Event Hubs.
eventHubName 您的名稱 Event Hubs 來源。

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

使用平台API

如需如何成功呼叫Platform API的詳細資訊,請參閱以下指南: Platform API快速入門.

建立基礎連線

TIP
建立後,您就無法變更的驗證型別 Event Hubs 基礎連線。 若要變更驗證型別,您必須建立新的基礎連線。

建立來源連線的第一個步驟是驗證您的 Event Hubs 來源並產生基本連線ID。 基礎連線ID可讓您從來源內部探索及導覽檔案,並識別您要擷取的特定專案,包括其資料型別和格式的資訊。

若要建立基本連線ID,請向以下連線ID發出POST請求: /connections 端點,同時提供 Event Hubs 要求引數中的驗證認證。

API格式

POST /connections
標準驗證

POST若要使用標準驗證建立帳戶,請向 /connections 端點,同時提供您的值 sasKeyNamesasKey、和 namespace.

accordion
要求
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
屬性 說明
auth.params.sasKeyName 授權規則的名稱,也稱為SAS金鑰名稱。
auth.params.sasKey 產生的共用存取權簽章。
auth.params.namespace 的名稱空間 Event Hubs 您正在存取。
connectionSpec.id 此 Event Hubs 連線規格ID為: bf9f5905-92b7-48bf-bf20-455bc6b60a4e
accordion
回應

成功的回應會傳回新建立的基本連線的詳細資料,包括其唯一識別碼(id)。 建立來源連線的下一個步驟需要此連線ID。

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

POST若要使用SAS驗證建立帳戶,請向 /connections 端點,同時提供您的值 sasKeyNamesasKeynamespace、和 eventHubName.

accordion
要求
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
屬性 說明
auth.params.sasKeyName 授權規則的名稱,也稱為SAS金鑰名稱。
auth.params.sasKey 產生的共用存取權簽章。
auth.params.namespace 的名稱空間 Event Hubs 您正在存取。
params.eventHubName 您的名稱 Event Hubs 來源。
connectionSpec.id 此 Event Hubs 連線規格ID為: bf9f5905-92b7-48bf-bf20-455bc6b60a4e
accordion
回應

成功的回應會傳回新建立的基本連線的詳細資料,包括其唯一識別碼(id)。 建立來源連線的下一個步驟需要此連線ID。

code language-json
{
    "id": "4cdbb15c-fb1e-46ee-8049-0f55b53378fe",
    "etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}
事件中樞Azure Active Directory驗證

POST若要使用Azure Active Directory驗證建立帳戶,請向 /connections 端點,同時提供您的值 tenantIdclientIdclientSecretValue、和 namespace.

accordion
要求
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
屬性 說明
auth.params.tenantId 您應用程式的租使用者ID。 注意:租使用者ID在中稱為「目錄ID」。 Microsoft Azure 介面。
auth.params.clientId 您組織的使用者端ID。
auth.params.clientSecretValue 您組織的使用者端密碼值。
auth.params.namespace 的名稱空間 Event Hubs 您正在存取。
connectionSpec.id 此 Event Hubs 連線規格ID為: bf9f5905-92b7-48bf-bf20-455bc6b60a4e
accordion
回應

成功的回應會傳回新建立的基本連線的詳細資料,包括其唯一識別碼(id)。 建立來源連線的下一個步驟需要此連線ID。

code language-json
{
    "id": "4cdbb15c-fb1e-46ee-8049-0f55b53378fe",
    "etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}
事件中心範圍的Azure Active Directory驗證

POST若要使用Azure Active Directory驗證建立帳戶,請向 /connections 端點,同時提供您的值 tenantIdclientIdclientSecretValuenamespace、和 eventHubName.

accordion
要求
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
屬性 說明
auth.params.tenantId 您應用程式的租使用者ID。 注意:租使用者ID在中稱為「目錄ID」。 Microsoft Azure 介面。
auth.params.clientId 您組織的使用者端ID。
auth.params.clientSecretValue 您組織的使用者端密碼值。
auth.params.namespace 的名稱空間 Event Hubs 您正在存取。
auth.params.eventHubName 您的名稱 Event Hubs 來源。
connectionSpec.id 此 Event Hubs 連線規格ID為: bf9f5905-92b7-48bf-bf20-455bc6b60a4e
accordion
回應

成功的回應會傳回新建立的基本連線的詳細資料,包括其唯一識別碼(id)。 建立來源連線的下一個步驟需要此連線ID。

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

建立來源連線

TIP
一個 Event Hubs 使用者群組在特定時間只能用於單一流量。

來源連線會建立和管理與擷取資料的外部來源的連線。 來源連線包含資料來源、資料格式等資訊,以及建立資料流所需的來源連線ID。 租使用者和組織專屬的來源連線例項。

POST若要建立來源連線,請向 /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": "{EVENT_HUB_NAME}",
          "dataType": "raw",
          "reset": "latest",
          "consumerGroup": "{CONSUMER_GROUP}"
      }
  }'
屬性
說明
name
來源連線的名稱。 確保來源連線的名稱是描述性的,因為您可以使用此名稱來查詢來源連線的資訊。
description
您可以提供的選用值,包含來源連線的詳細資訊。
baseConnectionId
您的連線ID 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 使用者群組在特定時間只能用於單一流量。

後續步驟

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

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089