Flow Service APIを使用してAzure Event Hubsソース接続を作成する

このチュートリアルでは、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 生成された共有アクセス署名。
namespace アクセスするEvent Hubsの名前空間。 Event Hubs名前空間は一意のスコープコンテナを提供し、このコンテナでEvent Hubsを1つ以上作成できます。
connectionSpec.id 接続仕様は、ベース接続とソース接続の作成に関連する認証仕様を含む、ソースのコネクタプロパティを返します。 Event Hubs接続仕様IDは次のとおりです。bf9f5905-92b7-48bf-bf20-455bc6b60a4e.

これらの値の詳細については、このEvent Hubsのドキュメントを参照してください。

Platform APIの使用

Platform APIを正常に呼び出す方法について詳しくは、Platform APIの使用の手引きを参照してください。

ベース接続を作成する

ソース接続を作成する最初の手順は、Event Hubsソースを認証し、ベース接続IDを生成することです。 ベース接続IDを使用すると、ソース内からファイルを参照およびナビゲートし、取り込む特定の項目(データのタイプや形式に関する情報を含む)を特定できます。

ベースPOSTIDを作成するには、リクエストパラメーターの一部としてEvent Hubs認証資格情報を指定しながら、/connectionsエンドポイントに接続リクエストを実行します。

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組織に固有です。

ソース接続を作成するには、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: {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ソースの接続ID。
connectionSpec.id Event Hubsの固定接続仕様ID。 この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 イベントコンシューマーのガイドを参照してください。

次の手順

このチュートリアルでは、Flow Service APIを使用してEvent Hubsソース接続を作成しました。 次のチュートリアルでこのソース接続IDを使用して、 Flow Service API🔗を使用してストリーミングデータフローを作成できます。

このページ