[Ultimate]{class="badge positive"}
Flow Service API を使用した Azure Event Hubs ソース接続の作成
このチュートリアルでは、Flow Service API を使用して Azure Event Hubs (以下「Event Hubs」)をExperience Platformに接続する方法について説明します。
はじめに
このガイドでは、Adobe Experience Platform の次のコンポーネントに関する十分な知識が必要です。
次の節では、Flow Service API を使用してExperience Platformに正しく接続するために必要 Event Hubs 追加情報を示します。
必要な資格情報の収集
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 名前空間のプライマリキー。 Event Hubs リストを入力するには、sasKey が対応する sasPolicy に manage 権限が設定されている必要があります。 |
namespace |
アクセスする Event Hub の名前空間。 Event Hub 名前空間は、一意のスコーピングコンテナを提供し、このコンテナでは 1 つ以上の Event Hubs を作成できます。 |
connectionSpec.id |
接続仕様は、ベース接続とソース接続の作成に関連する認証仕様などの、ソースのコネクタプロパティを返します。Event Hubs 接続仕様 ID は bf9f5905-92b7-48bf-bf20-455bc6b60a4e です。 |
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 | |
---|---|
資格情報 | 説明 |
sasKeyName |
承認ルールの名前。SAS キー名とも呼ばれます。 |
sasKey |
Event Hubs 名前空間のプライマリキー。 Event Hubs リストを入力するには、sasKey が対応する sasPolicy に manage 権限が設定されている必要があります。 |
namespace |
アクセスする Event Hub の名前空間。 Event Hub 名前空間は、一意のスコーピングコンテナを提供し、このコンテナでは 1 つ以上の Event Hubs を作成できます。 |
eventHubName |
Azure Event Hub 名を入力します。 Event Hub の名前について詳しくは、Microsoft ドキュメントを参照してください。 |
connectionSpec.id |
接続仕様は、ベース接続とソース接続の作成に関連する認証仕様などの、ソースのコネクタプロパティを返します。Event Hubs 接続仕様 ID は bf9f5905-92b7-48bf-bf20-455bc6b60a4e です。 |
Event Hubs の共有アクセス署名(SAS)認証について詳しくは、Azure SAS の使用に関するガイドを参照してください。
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
---|---|
資格情報 | 説明 |
tenantId |
権限をリクエストするテナント ID。 テナント ID は、GUID またはわかりやすい名前として書式設定できます。 注意:テナント ID は、Microsoft Azure インターフェイスでは「ディレクトリ ID」と呼ばれます。 |
clientId |
アプリに割り当てられたアプリケーション ID。 この ID は、Azure Active Directory ーザーを登録した Microsoft Entra ID ポータルから取得できます。 |
clientSecretValue |
アプリを認証するためにクライアント ID と共に使用されるクライアント秘密鍵。 クライアントの秘密鍵は、クライアントを登録した Microsoft Entra ID ポータルから取得でき Azure Active Directory す。 |
namespace |
アクセスする Event Hub の名前空間。 Event Hub 名前空間は、一意のスコーピングコンテナを提供し、このコンテナでは 1 つ以上の Event Hubs を作成できます。 |
Azure Active Directory について詳しくは、Microsoft Entra ID の使用に関する Azure ガイドを参照してください。
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 | |
---|---|
資格情報 | 説明 |
tenantId |
権限をリクエストするテナント ID。 テナント ID は、GUID またはわかりやすい名前として書式設定できます。 注意:テナント ID は、Microsoft Azure インターフェイスでは「ディレクトリ ID」と呼ばれます。 |
clientId |
アプリに割り当てられたアプリケーション ID。 この ID は、Azure Active Directory ーザーを登録した Microsoft Entra ID ポータルから取得できます。 |
clientSecretValue |
アプリを認証するためにクライアント ID と共に使用されるクライアント秘密鍵。 クライアントの秘密鍵は、クライアントを登録した Microsoft Entra ID ポータルから取得でき Azure Active Directory す。 |
namespace |
アクセスする Event Hub の名前空間。 Event Hub 名前空間は、一意のスコーピングコンテナを提供し、このコンテナでは 1 つ以上の Event Hubs を作成できます。 |
eventHubName |
Azure Event Hub 名を入力します。 Event Hub の名前について詳しくは、Microsoft ドキュメントを参照してください。 |
これらの値について詳しくは、 この Event Hubs ドキュメントを参照してください。
Experience Platform API の使用
Experience Platform API を正常に呼び出す方法について詳しくは、Experience Platform API の概要を参照してください。
ベース接続の作成
ソース接続を作成する最初の手順は、Event Hubs ソースを認証し、ベース接続 ID を生成することです。ベース接続 ID を使用すると、ソース内を移動してファイルを探索し、データのタイプや形式に関する情報など、取り込みたい特定の項目を識別できます。
ベース接続 ID を作成するには、/connections
エンドポイントに対して POST リクエストを実行し、その際に Event Hubs 認証資格情報をリクエストパラメーターの一部として指定します。
API 形式
POST /connections
標準認証を使用してアカウントを作成するには、/connections
エンドポイントに POST リクエストを実行し、その際、sasKeyName
、sasKey
、namespace
の値を指定します。
accordion | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
リクエスト | ||||||||||||||
|
accordion | ||
---|---|---|
応答 | ||
リクエストが成功した場合は、一意の ID(
|
SAS 認証を使用してアカウントを作成するには、sasKeyName
、sasKey
、namespace
、eventHubName
の値を指定すると同時に、/connections
エンドポイントに対して POST リクエストを行います。
accordion | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
リクエスト | ||||||||||||||||
|
accordion | ||
---|---|---|
応答 | ||
リクエストが成功した場合は、一意の ID(
|
Azure Active Directory Auth を使用してアカウントを作成するには、tenantId
、clientId
、clientSecretValue
、namespace
の値を指定したうえで、/connections
エンドポイントに対して POST リクエストを行います。
accordion | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
リクエスト | ||||||||||||||||
|
accordion | ||
---|---|---|
応答 | ||
リクエストが成功した場合は、一意の ID(
|
Azure Active Directory Auth を使用してアカウントを作成するには、tenantId
、clientId
、clientSecretValue
、namespace
、eventHubName
の値を指定したうえで、/connections
エンドポイントに対して POST リクエストを行います。
accordion | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
リクエスト | ||||||||||||||||||
|
accordion | ||
---|---|---|
応答 | ||
リクエストが成功した場合は、一意の ID(
|
ソース接続の作成
ソース接続は、データの取り込み元となる外部ソースへの接続を作成および管理します。ソース接続は、データソース、データ形式、データフローの作成に必要なソース接続 ID などの情報で構成されます。ソース接続インスタンスは、テナントと組織に固有です。
ソース接続を作成するには、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": "{EVENT_HUB_NAME}",
"dataType": "raw",
"reset": "latest",
"consumerGroup": "{CONSUMER_GROUP}"
}
}'
name
description
baseConnectionId
connectionSpec.id
bf9f5905-92b7-48bf-bf20-455bc6b60a4e
です。data.format
json
のみです。params.eventHubName
params.dataType
raw
および xdm
を含むデータタイプがサポートされています。params.reset
latest
を使用すると、最新のデータから読み取りを開始でき、earliest
を使用すると、ストリーム内の最初の使用可能なデータから読み取りを開始できます。 このパラメーターはオプションです。指定しない場合、デフォルトは earliest
になります。params.consumerGroup
$Default
になります。 詳しくは、この Event Hubs イベントコンシューマーに関するガイドを参照してください。 メモ:Event Hubs コンシューマーグループは、特定の時間に 1 つのフローに対してのみ使用できます。次の手順
このチュートリアルでは、Flow Service API を使用して Event Hubs ソース接続を作成しました。 次のチュートリアルでは、このソース接続 ID を使用して、 Flow Service API を使用したストリーミングデータフローの作成を行います。