の作成 Azure Event Hubs を使用したソース接続 Flow Service API

このチュートリアルでは、 Flow Service API を使用して Azure Event Hubs(以下「Event Hubs」)を Experience Platform に接続する手順を詳しく説明します。

はじめに

このガイドでは、Adobe Experience Platform の次のコンポーネントに関する十分な知識が必要です。

  • ソース:Experience Platform を使用すると、データを様々なソースから取得しながら、Platform サービスを使用して受信データの構造化、ラベル付け、拡張を行うことができます。
  • サンドボックス:Experience Platform には、単一の Platform インスタンスを別々の仮想環境に分割して、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスが用意されています。

以下の節では、Flow Service API を使用して Event Hubs を Platform に正しく接続するために必要な追加情報を示します。

必要な認証情報の収集

次のために Flow Service を Event Hubs アカウントの場合、次の接続プロパティの値を指定する必要があります。

認証情報 説明
sasKeyName 認証規則の名前。SAS キー名とも呼ばれます。
sasKey のプライマリキー Event Hubs 名前空間。 この sasPolicy この sasKey 必ず~に対応する manage 次に対して設定された権限: Event Hubs リストに値を入力します。
namespace の名前空間 Event Hubs にアクセスしています。 An Event Hubs 名前空間は、1 つ以上のスコーピングコンテナを作成できる一意のスコーピングコンテナを提供します Event Hubs.
connectionSpec.id 接続仕様は、ベース接続とソース接続の作成に関連する認証仕様を含む、ソースのコネクタプロパティを返します。Event Hubs 接続仕様 ID は bf9f5905-92b7-48bf-bf20-455bc6b60a4e です。

これらの値について詳しくは、 この Event Hubs ドキュメント.

Platform API の使用

Platform API への呼び出しを正常に実行する方法について詳しくは、Platform API の概要を参照してください。

ベース接続の作成

ソース接続を作成する最初の手順は、Event Hubs ソースを認証し、ベース接続 ID を生成することです。ベース接続 ID を使用すると、ソース内を移動してファイルを探索し、データのタイプや形式に関する情報など、取り込みたい特定の項目を識別できます。

ベース接続 ID を作成するには、/connections エンドポイントに対して POST リクエストを実行し、その際に 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 は、次の手順でソース接続を作成する際に必要になります。

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

ソース接続の作成

ソース接続は、データの取り込み元となる外部ソースへの接続を作成および管理します。ソース接続は、データソース、データ形式、データフローの作成に必要なソース接続 ID などの情報で構成されます。ソース接続インスタンスは、テナントと IMS 組織に固有です。

ソース接続を作成するには、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": "{EVENTHUB_NAME}",
            "dataType": "raw",
            "reset": "latest",
            "consumerGroup": "{CONSUMER_GROUP}"
        }
    }'
プロパティ 説明
name ソース接続の名前。 ソース接続の情報を検索する際に使用できるので、ソース接続の名前はわかりやすいものにしてください。
description 指定するとソース接続に関する詳細情報を含めることができるオプションの値。
baseConnectionId の接続 ID Event Hubs 前の手順で生成されたソース。
connectionSpec.id Event Hubs の固定接続仕様 ID。この 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 を使用したストリーミングデータフローの作成を行います。

このページ