Web アクティビティを使用してパイプライン内で REST API を呼び出す

Web アクティビティを使用すると、Azure Data Factory または Synapse パイプラインからカスタム REST エンドポイントを呼び出すことができます。 このアクティビティで使用したり、アクセスしたりするデータセットやリンクされたサービスを渡すことができます。

Note

サポートされている出力応答ペイロードの最大サイズは 4 MB です。

前提条件

開始するには、次の前提条件を満たしている必要があります。

UI を使用したパイプラインへの Web アクティビティの追加

パイプライン内で Web アクティビティを使用するには、次の手順を実行します。

アクティビティを作成する

  1. ワークスペースに新しいパイプラインを作成します。

  2. パイプラインの [アクティビティ] ペイン内で [Web] を探し、それを選択してパイプライン キャンバスに追加します。

    Screenshot of the Fabric UI with the Activities pane and Web activity highlighted.

  3. まだ選択されていない場合は、キャンバス上でその新しい Web アクティビティを選びます。

    Screenshot showing the General settings tab of the Web activity.

    Note

    前の画像内に示したように、この画面の解像度でアイコン名を完全に表示できない場合、Web アクティビティは単にツールバー上のアイコンとして表示される場合があります。

[全般設定] タブを構成するには、全般設定のガイダンスを参照してください。

Web アクティビティの設定

  1. [設定] タブを選択し、[接続] ドロップダウンから既存の接続を選択するか、[+ 新規] ボタンを使用して新しい接続を作成し、その構成の詳細を指定します。

    Screenshot showing the Lookup activity settings tab highlighting the tab, and where to choose a new connection.

  2. [+ 新規] を選択して新しい接続を作成すると、接続作成ダイアログが表示され、接続先のベース URL と資格情報を指定することができます。

    Screenshot showing the new connection dialog for the Web activity.

Note

接続名は最大 80 文字です。

  1. お使いの接続を選択または作成したら、残りの必須フィールドに入力する、必要なヘッダーを追加する、または詳細設定を設定します。 Web アクティビティでは、GET、POST、PUT、DELETE、PATCH メソッドがサポートされます。

パイプラインを保存して実行またはスケジュールする

通常は、Web アクティビティの出力を他のアクティビティで使用しますが、一旦構成すると、他のアクティビティなしで直接実行することもできます。 何らかのアクションを実行する REST API を呼び出すために Web アクティビティを実行しており、かつそのアクティビティからの出力が必要ない場合、お使いのパイプラインにはその Web アクティビティのみが含まれる場合もあります。 このアクティビティを実行するには、パイプライン エディターの上部にある [ホーム] タブに切り替え、[保存] ボタンを選択してお使いのパイプラインを保存します。 [実行] を選択して直接実行するか、[スケジュール] を選択してスケジュールを設定します。 ここで実行履歴を表示したり、他の設定を構成したりすることもできます。

Screenshot showing the Home tab in the pipeline editor with the tab name, Save, Run, and Schedule buttons highlighted.