ドキュメントExperience Platformソースコネクタガイド

Flow Service API を使用した Azure Blob ベース接続の作成

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • トピック：

作成対象：

  • 開発者

ベース接続は、ソースと Adobe Experience Platform 間の認証済み接続を表します。

このチュートリアルでは、Flow Service API を使用して、Azure Blob （以下「Blob」と呼びます）のベース接続を作成する手順について説明します。

はじめに

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

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

次の節では、Flow Service API を使用して Blob ソース接続を正常に作成するために必要な追加情報を示しています。

必要な資格情報の収集

Flow Service を Blob ストレージに接続するには、次の接続プロパティの値を指定する必要があります。

接続文字列認証
table 0-row-2 1-row-2 2-row-2
資格情報 説明
connectionString Experience Platformへの認証に必要な認証情報を含む文字列 Blob す。 Blob の接続文字列パターンは DefaultEndpointsProtocol=https;AccountName={ACCOUNT_NAME};AccountKey={ACCOUNT_KEY} です。 接続文字列について詳しくは、この Blob ドキュメント 接続文字列の設定を参照してください。
connectionSpec.id 接続仕様は、ベース接続とソース接続の作成に関連する認証仕様などの、ソースのコネクタプロパティを返します。Blob の接続仕様 ID は d771e9c1-4f26-40dc-8617-ce58c4b53702 です。
SAS URI 認証
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
資格情報 説明
sasUri Blob アカウントを接続するための代替認証タイプとして使用できる共有アクセス署名 URI です。 Blob の SAS URI パターンを以下に示します。https://{ACCOUNT_NAME}.blob.core.windows.net/?sv=<storage version>&st={START_TIME}&se={EXPIRE_TIME}&sr={RESOURCE}&sp={PERMISSIONS}>&sip=<{IP_RANGE}>&spr={PROTOCOL}&sig={SIGNATURE}> 詳しくは、この Blob ドキュメントの 共有アクセス署名 URI を参照してください。
container アクセスを指定するコンテナの名前。 Blob ソースで新しいアカウントを作成する際に、コンテナ名を指定して、選択したサブフォルダーへのユーザーアクセスを指定できます。
folderPath アクセス権を付与するフォルダーへのパス。
connectionSpec.id 接続仕様は、ベース接続とソース接続の作成に関連する認証仕様などの、ソースのコネクタプロパティを返します。Blob の接続仕様 ID は d771e9c1-4f26-40dc-8617-ce58c4b53702 です。

Platform API の使用

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

ベース接続の作成

TIP
作成した後は、Blob ベース接続の認証タイプを変更できません。 認証タイプを変更するには、新しいベース接続を作成する必要があります。

ベース接続は、ソースと Platform 間の情報（ソースの認証資格情報、現在の接続状態、固有のベース接続 ID など）を保持します。ベース接続 ID により、ソース内からファイルを参照および移動し、データタイプやフォーマットに関する情報を含む、取り込みたい特定の項目を識別することができます。

Blob ソースは、接続文字列と共有アクセス署名（SAS）認証の両方をサポートしています。 共有アクセス署名（SAS） URI を使用すると、Blob アカウントに対する安全なデリゲート認証が可能になります。 SAS ベースの認証では、権限、開始日、有効期限および特定のリソースへのプロビジョニングを設定できるので、SAS を使用して、様々なレベルのアクセスで認証資格情報を作成できます。

この手順では、コンテナの名前とサブフォルダーへのパスを定義することで、アカウントがアクセスできるサブフォルダーを指定することもできます。

ベース接続 ID を作成するには、/connections エンドポイントに POST リクエストを実行し、Blob 認証資格情報をリクエストパラメーターの一部として使用します。

API 形式

POST /connections

リクエスト

接続文字列

次のリクエストは、接続文字列ベースの認証を使用して、Blob のベース接続を作成します。

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 Blob connection using connectionString",
      "description": "Azure Blob connection using connectionString",
      "auth": {
          "specName": "ConnectionString",
          "params": {
              "connectionString": "DefaultEndpointsProtocol=https;AccountName={ACCOUNT_NAME};AccountKey={ACCOUNT_KEY}",
              "container": "acme-blob-container",
              "folderPath": "/acme/customers/salesData"
          }
      },
      "connectionSpec": {
          "id": "4c10e202-c428-4796-9208-5f1f5732b1cf",
          "version": "1.0"
      }
  }'
table 0-row-2 1-row-2 2-row-2
プロパティ 説明
auth.params.connectionString Blob ストレージのデータにアクセスするために必要な接続文字列。 Blob 接続文字列のパターンは DefaultEndpointsProtocol=https;AccountName={ACCOUNT_NAME};AccountKey={ACCOUNT_KEY} です。
connectionSpec.id BLOB ストレージ接続仕様 ID は 4c10e202-c428-4796-9208-5f1f5732b1cf です。
accordion
応答

リクエストが成功した場合は、一意の ID（id）を含め、新しく作成されたベース接続の詳細が返されます。この ID は、次の手順でソース接続を作成する際に必要になります。

code language-json 
{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"1700c57b-0000-0200-0000-5e3b3f440000\""
}
SAS URI 認証

共有アクセス署名 URI を使用して Blob 接続を作成するには、Flow Service API に対してPOSTリクエストを実行し、その際に Blob sasUri の値を指定します。

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 Blob source connection using SAS URI",
      "description": "Azure Blob source connection using SAS URI",
      "auth": {
          "specName": "SAS URI Authentication",
          "params": {
              "sasUri": "https://{ACCOUNT_NAME}.blob.core.windows.net/?sv={STORAGE_VERSION}&st={START_TIME}&se={EXPIRE_TIME}&sr={RESOURCE}&sp={PERMISSIONS}>&sip=<{IP_RANGE}>&spr={PROTOCOL}&sig={SIGNATURE}>",
              "container": "acme-blob-container",
              "folderPath": "/acme/customers/salesData"
          }
      },
      "connectionSpec": {
          "id": "4c10e202-c428-4796-9208-5f1f5732b1cf",
          "version": "1.0"
      }
  }'
table 0-row-2 1-row-2 2-row-2
プロパティ 説明
auth.params.connectionString Blob ストレージ内のデータにアクセスするために必要な SAS URI。 Blob の SAS URI パターンは https://{ACCOUNT_NAME}.blob.core.windows.net/?sv=<storage version>&st={START_TIME}&se={EXPIRE_TIME}&sr={RESOURCE}&sp={PERMISSIONS}>&sip=<{IP_RANGE}>&spr={PROTOCOL}&sig={SIGNATURE}> です。
connectionSpec.id Blob ストレージ接続仕様 ID は 4c10e202-c428-4796-9208-5f1f5732b1cf です。
accordion
応答

リクエストが成功した場合は、一意の ID（id）を含め、新しく作成されたベース接続の詳細が返されます。この ID は、次の手順でソース接続を作成する際に必要になります。

code language-json 
{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"1700c57b-0000-0200-0000-5e3b3f440000\""
}

次の手順

このチュートリアルでは、API を使用して Blob 接続を作成し、一意の ID を応答本文の一部として取得しました。 この接続 ID を使用して Flow Service API を使用したクラウドストレージの調査を行うことができます。

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