[Ultimate]{class="badge positive"}

Flow Service APIを使用してAzure Synapse AnalyticsをExperience Platformに接続します

IMPORTANT
Azure Synapse Analytics ソースは、Real-Time Customer Data Platform Ultimateを購入したユーザーがソースカタログで利用できます。

このガイドでは、Flow Service APIを使用してAzure Synapse Analytics アカウントをAdobe Experience Platformに接続する方法について説明します。

基本を学ぶ

このガイドは、Adobe Experience Platform の次のコンポーネントを実際に利用および理解しているユーザーを対象としています。

  • ​ ソース ​: Experience Platformを使用すると、様々なソースからデータを取り込むことができますが、Experience Platform サービスを使用して着信データを構造化、ラベル付け、強化することができます。
  • ​ サンドボックス ​: Experience Platformは、1つのExperience Platform インスタンスを個別のバーチャル環境に分割して、デジタルエクスペリエンスアプリケーションの開発と進化に役立つバーチャルサンドボックスを提供します。

次の節では、Flow Service APIを使用してAzure Synapse Analyticsに正常に接続するために知っておく必要がある追加情報を示します。

必要な資格情報の収集

認証について詳しくは、Azure Synapse Analytics 概要を参照してください。

Experience Platform APIの使用

Experience Platform APIの呼び出しを正常に行う方法について詳しくは、Experience Platform APIの概要に関するガイドを参照してください。

Azure Synapse AnalyticsをExperience Platformに接続

ベース接続を作成し、Azure Synapse Analytics アカウントをExperience Platformに接続する方法については、次を参照してください。

ベース接続の作成

ベース接続​には、ソースシステムとAdobe Experience Platformをリンクするキー情報が格納されます。 これには以下が含まれます。

  • ソースの認証情報
  • 接続の現在ステータス
  • 一意の​ベース接続ID

ベース接続ID​を使用すると、ソースからファイルを参照および探索し、取り込む項目とそのデータの種類および形式を特定できます。

ベース接続IDを作成するには、リクエストパラメーターにAzure Synapse Analytics認証情報を含むPOST リクエストを/connections エンドポイントに送信します。

API 形式

POST /connections
接続文字列ベースの認証

リクエスト

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

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": "Connection for Azure Synapse Analytics",
      "description": "Connection for Azure Synapse Analytics",
      "auth": {
          "specName": "Connection String Based Authentication",
          "params": {
              "connectionString": "Server=tcp:{SERVER_NAME}.database.windows.net,1433;Database={DATABASE};User ID={USERNAME}@{SERVER_NAME};Password={PASSWORD};Trusted_Connection=False;Encrypt=True;Connection Timeout=30"
          }
      },
      "connectionSpec": {
          "id": "a49bcc7d-8038-43af-b1e4-5a7a089a7d79",
          "version": "1.0"
      }
  }'
table 0-row-2 1-row-2 2-row-2
パラメーター 説明
auth.params.connectionString Azure Synapse Analyticsへの接続に使用される接続文字列。 Azure Synapse Analytics接続文字列パターンはServer=tcp:{SERVER_NAME}.database.windows.net,1433;Database={DATABASE};User ID={USERNAME}@{SERVER_NAME};Password={PASSWORD};Trusted_Connection=False;Encrypt=True;Connection Timeout=30です。
connectionSpec.id Azure Synapse Analytics 接続仕様 ID は a49bcc7d-8038-43af-b1e4-5a7a089a7d79 です。

応答

リクエストが成功した場合は、一意の ID(id)を含め、新しく作成されたベース接続の詳細が返されます。

accordion
回答の例を表示
code language-json
{
    "id": "6bc13a3b-3546-455f-813a-3b3546a55fb1",
    "etag": "\"3500866c-0000-0200-0000-5e83afa30000\""
}
サービス プリンシパル キーベースの認証

次のリクエストは、サービスプリンシパルキーベースの認証を使用して、Azure Synapse Analyticsのベース接続を作成します。

リクエスト

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": "Connection for Azure Synapse Analytics",
    "description": "Connection for Azure Synapse Analytics",
    "auth": {
      "specName": "Service Principal Key Based Authentication",
      "params": {
        "server": "yourworkspace.sql.azuresynapse.net",
        "database": "SalesDW",
        "tenant": "72f988bf-86f1-41af-91ab-2d7cd011db47",
        "servicePrincipalId": "e7b8c1f2-1234-4c9a-9f3e-abcdef123456",
        "servicePrincipalKey": "~XyZ1234abcDEF5678..."
      }
    },
    "connectionSpec": {
      "id": "a49bcc7d-8038-43af-b1e4-5a7a089a7d79",
      "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.server Azure Synapse Analytics SQL エンドポイントの完全修飾ドメイン名。
auth.params.database Azure Synapse Analytics ワークスペース内の特定のデータベースの名前。
auth.params.tenant Azure サブスクリプションに関連付けられているAzure Active Directory テナント ID。
auth.params.servicePrincipalId Azure Active Directory アプリケーションのクライアント ID。
auth.params.servicePrincipalKey サービス プリンシパルに関連付けられているクライアントの秘密鍵またはパスワード。
connectSpec.id 接続仕様ID Azure Synapse Analyticsです。

応答

リクエストが成功した場合は、一意の ID(id)を含め、新しく作成されたベース接続の詳細が返されます。

accordion
回答の例を表示
code language-json
{
    "id": "6bc13a3b-3546-455f-813a-3b3546a55fb1",
    "etag": "\"3500866c-0000-0200-0000-5e83afa30000\""
}

次の手順

このチュートリアルでは、Flow Service API を使用して Azure Synapse Analytics ベース接続を作成しました。 このベース接続 ID は、次のチュートリアルで使用できます。

recommendation-more-help
experience-platform-help-sources