Microsoft Fabric データパイプラインパブリック REST API (プレビュー)

[アーティクル]
11/21/2024

重要

Data Factory の Microsoft Fabric API は現在パブリックプレビュー段階です。この情報はプレリリース製品に関連するものであり、リリース前に大幅に変更される可能性があります。ここに記載された情報について、Microsoft は明示か黙示かを問わずいかなる保証をするものでもありません。

Microsoft Fabric では、Data Factory API はパイプラインとデータフローに対する CRUD 操作のみで構成されます。現在、パイプラインのみがサポートされています。データフロー API は後でリリースされる予定です。データ統合プロジェクトのその他の共通領域は個別の API (スケジュール、監視、接続) にあり、ファブリック内に独自の API があります。 Microsoft Fabric REST API の主要なオンラインリファレンスドキュメントについては、Microsoft Fabric REST API リファレンスを参照してください。また、コア項目 API とジョブスケジューラも参照してください。

パブリック API のマウント

マウントパブリック API を使用できるようになりました。これらの API を使用すると、データパイプライン内のさまざまなパブリックデータソースをシームレスに統合してアクセスできます。

承認トークンを取得

オプション 1: MSAL.Net の使用

Fabric API クイックスタート - Microsoft Fabric REST API

MSAL.Net を使用して、Workspace.ReadWrite.All、Item.ReadWrite.All のスコープを持つ Fabric サービスの Microsoft Entra ID トークンを取得します。 MSAL.Net を使用したトークン取得の詳細については、「トークンの取得 - .NET用 Microsoft 認証ライブラリ」を参照してください。

先ほどコピーしたアプリケーション (クライアント) ID を貼り付け、ClientId 変数に貼り付けます。

オプション 2: ファブリックポータルの使用

テストするテナントの Fabric Portal にサインインし、F12 キーを押してブラウザーの開発者モードに入ります。そこのコンソールで、次を実行します。

powerBIAccessToken

トークンをコピーし、ClientId 変数に貼り付けます。

ペイロード base64 でエンコードされた項目定義

Base64 エンコードとデコードを使用してJSON をエンコードします。
[URL セーフエンコードの実行] ボックスがチェックされていないことを確認します。
パイプライン定義は、ファブリックユーザーインターフェイスの [表示] -- >[JSON コードの表示] タブから取得できます。

{ 
    "name": "Pipeline_1_updated", 
    "objectId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 
    "properties": { 
        "description": "this is the description", 
        "activities": [ 
            { 
                "name": "Wait1", 
                "type": "Wait", 
                "dependsOn": [], 
                "typeProperties": { 
                    "waitTimeInSeconds": 240 
                } 
            } 
        ], 
        "annotations": [], 
        "lastModifiedByObjectId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 
        "lastPublishTime": "2024-02-01T17:28:02Z" 
    } 
}

properties オブジェクトを取り、中かっこ- { } -で囲むので、REST 項目定義ペイロードは次のようになります。

{
    "properties": { 
        "description": "this is the description", 
        "activities": [ 
            { 
                "name": "Wait1", 
                "type": "Wait", 
                "dependsOn": [], 
                "typeProperties": { 
                    "waitTimeInSeconds": 240 
                } 
            } 
        ], 
        "annotations": [], 
        "lastModifiedByObjectId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 
        "lastPublishTime": "2024-02-01T17:28:02Z" 
    } 
}

アイテムの作成

REST API - 項目 - アイテムの作成

例 1 - DataPipeline を作成する:

POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items

本文は次のようになります。

{ 
  "displayName": "pipeline_1", 
  "type": "DataPipeline" 
}

Note

ドキュメントには、displayNameと type という 2 つの必須プロパティしかないことが示されています。現在、Workload-DI では、定義のない作成もサポートされていません。この誤った要件に対する修正プログラムは、現在デプロイ中です。現時点では、ファブリックユーザーインターフェイス ‘{"properties":{"activities":[]}}’ で使用されるのと同じデフォルト定義を送信できます。

定義を含む変更された JSON:

{ 
  "displayName": "pipeline_1", 
  "type": "DataPipeline", 
  "definition": { 
    "parts": [ 
      { 
        "path": "pipeline-content.json", 
        "payload": "eyJwcm9wZXJ0aWVzIjp7ImFjdGl2aXRpZXMiOltdfX0=", 
        "payloadType": "InlineBase64" 
      } 
    ] 
  } 
}

応答 201:

{ 
    "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 
    "type": "DataPipeline", 
    "displayName": "Pipeline_1", 
    "description": "", 
    "workspaceId": "<Your WS Id>" 
}

例 2 - MountedDataFactory を作成する

POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items

本文は次のようになります。

ペイロード:

{"DataFactoryResourceId":"/subscriptions/<ADF subscription Id>/resourceGroups/<ADF resource group name>/providers/Microsoft.DataFactory/factories/<ADF datafactory name>"}

エンコードされた JSON:

{ 
  "displayName": "pipeline_mdf", 
  "type": " MountedDataFactory ", 
  "definition": { 
    "parts": [ 
      { 
        "path": "mountedDataFactory-content.json", 
        "payload": <base64 encoded value>, 
        "payloadType": "InlineBase64" 
      } 
    ] 
  } 
}

応答 201:

{ 
    "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 
    "type": "MountedDataFactory", 
    "displayName": "Pipeline_mdf", 
    "description": "", 
    "workspaceId": "<Your WS Id>"
}

アイテムの削除

REST API - 項目 - アイテムの削除

例:

DELETE https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>

応答 200: (本文なし)

項目を取得する

REST API - 項目 - アイテムの取得

例:

GET https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>

応答 200:

{ 
    "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 
    "type": "DataPipeline", 
    "displayName": "Pipeline_1", 
    "workspaceId": "<your WS Id>" 
}

項目定義を取得する

REST API - 項目 - 項目定義の取得

例:

POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/getDefinition

応答 200:

{ 
    "definition": { 
        "parts":[ 
            { 
                "path": "pipeline-content.json", 
                "payload": "ewogICJwcm9wZXJ0aWVzIjogewogICAgImFjdGl2aXRpZXMiOiBbXQogIH0KfQ==", 
                "payloadType": "InlineBase64" 
            } 
        ] 
    } 
}

項目を一覧表示する

REST API - 項目 - リスト項目

例:

GET https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items

応答 200:

{ 
    "value": [ 
        { 
            "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 
            "type": "SemanticModel", 
            "displayName": "deata_lh", 
            "description": "", 
            "workspaceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" 
        }, 
        { 
            "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 
            "type": "SQLEndpoint", 
            "displayName": "deata_lh", 
            "description": "", 
            "workspaceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" 
        }, 
        { 
            "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 
            "type": "Lakehouse", 
            "displayName": "deata_lh", 
            "description": "", 
            "workspaceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" 
        }, 
        { 
            "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 
            "type": "DataPipeline", 
            "displayName": "Pipeline_1", 
            "description": "", 
            "workspaceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" 
        } 
    ] 
}

項目を更新する

REST API - アイテム - アイテムの更新

例:

PATCH https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>

本文は次のようになります。

{ 
  "displayName": "Pipeline_1_updated", 
  "description": "This is the description." 
}

応答 200:

{ 
    "id": "<pipeline id>", 
    "type": "DataPipeline", 
    "displayName": "Pipeline_1_updated", 
    "description": "This is the description.", 
    "workspaceId": "<Your WS id>" 
}

項目定義を更新する

REST API - 項目 - アイテム定義の更新

例:

POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/updateDefinition

本文は次のようになります。

{ 
  "definition": { 
    "parts": [ 
      { 
        "path": "pipeline-content.json", 
        "payload": "eyJwcm9wZXJ0aWVzIjp7ImFjdGl2aXRpZXMiOltdfX0=", 
        "payloadType": "InlineBase64" 
      } 
    ] 
  } 
}

応答 200: (本文なし)

オンデマンドの項目ジョブの実行

REST API - 項目 - オンデマンド項目ジョブの実行

例:

POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/jobs/instances?jobType=Pipeline

応答 202: (本文なし)

2 つのパラメーター値を持つ例:

以下は、待機する秒数を指定する param_waitsec という名前のパラメーターを持つ Wait アクティビティの例です。

POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/jobs/instances?jobType=Pipeline

本文は次のようになります。

{ 
  "executionData": { 
    "parameters": {
      "param_waitsec": "10" 
    } 
  } 
}

応答 202: (本文なし)

Note

現在、本文は返されていませんが、ジョブ ID を返す必要があります。プレビュー期間中は、返されたヘッダーの 'Location' プロパティにあります。

項目ジョブのインスタンスの取得

REST API - アイテム - 項目ジョブのインスタンスの取得

例:

GET https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/jobs/instances/<job ID>

応答 200:

{ 
    "id": "4511ffcd-a9f6-4f75-91a9-9ceab08d7539", 
    "itemId": "2bb9fe4a-0a84-4725-a01f-7ac4e6850259", 
    "jobType": "Pipeline", 
    "invokeType": "Manual", 
    "status": "Completed", 
    "failureReason": null, 
    "rootActivityId": "f14bdd95-2cff-4451-b839-bea81509126d", 
    "startTimeUtc": "2024-02-01T03:03:19.8361605", 
    "endTimeUtc": "2024-02-01T03:05:00.3433333" 
}

項目ジョブのインスタンスの取り消し

REST API - 項目 - アイテムジョブインスタンスの取り消し

例:

POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/jobs/instances/<job ID>/cancel

応答 202: (本文なし)

Note

ジョブを取り消した後は、項目ジョブインスタンスの取得を呼び出すか、Fabric ユーザーインターフェイスで実行履歴の表示を確認することで、状態をチェックできます。

アクティビティ実行のクエリ

例:

POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/datapipelines/pipelineruns/<job id>/queryactivityruns

本文は次のようになります。

{
  "filters":[],
  "orderBy":[{"orderBy":"ActivityRunStart","order":"DESC"}],
  "lastUpdatedAfter":"2024-05-22T14:02:04.1423888Z",
  "lastUpdatedBefore":"2024-05-24T13:21:27.738Z"
}

Note

"job id" は、Job Scheduler パブリック API で作成および使用される ID と同じです

応答 200:

[
    {
        "pipelineName": "ca91f97e-5bdd-4fe1-b39a-1f134f26a701",
        "pipelineRunId": "bbbb1b1b-cc2c-dd3d-ee4e-ffffff5f5f5f",
        "activityName": "Wait1",
        "activityType": "Wait",
        "activityRunId": "cccc2c2c-dd3d-ee4e-ff5f-aaaaaa6a6a6a",
        "linkedServiceName": "",
        "status": "Succeeded",
        "activityRunStart": "2024-05-23T13:43:03.6397566Z",
        "activityRunEnd": "2024-05-23T13:43:31.3906179Z",
        "durationInMs": 27750,
        "input": {
            "waitTimeInSeconds": 27
        },
        "output": {},
        "error": {
            "errorCode": "",
            "message": "",
            "failureType": "",
            "target": "Wait1",
            "details": ""
        },
        "retryAttempt": null,
        "iterationHash": "",
        "userProperties": {},
        "recoveryStatus": "None",
        "integrationRuntimeNames": null,
        "executionDetails": null,
        "id": "/SUBSCRIPTIONS/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/RESOURCEGROUPS/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/PROVIDERS/MICROSOFT.TRIDENT/WORKSPACES/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/pipelineruns/bbbb1b1b-cc2c-dd3d-ee4e-ffffff5f5f5f/activityruns/cccc2c2c-dd3d-ee4e-ff5f-aaaaaa6a6a6a"
    }
]

既知の制限事項

サービスプリンシパル認証 (SPN) は現在サポートされていません。

次の方法で共有

Microsoft Fabric データパイプラインパブリック REST API (プレビュー)

パブリック API のマウント

承認トークンを取得

オプション 1: MSAL.Net の使用

オプション 2: ファブリックポータルの使用

ペイロード base64 でエンコードされた項目定義

アイテムの作成

アイテムの削除

項目を取得する

項目定義を取得する

項目を一覧表示する

項目を更新する

項目定義を更新する

オンデマンドの項目ジョブの実行

項目ジョブのインスタンスの取得

項目ジョブのインスタンスの取り消し

アクティビティ実行のクエリ

既知の制限事項

フィードバック

その他のリソース

次の方法で共有

Microsoft Fabric データ パイプラインパブリック REST API (プレビュー)

パブリック API のマウント

承認トークンを取得

オプション 1: MSAL.Net の使用

オプション 2: ファブリック ポータルの使用

ペイロード base64 でエンコードされた項目定義

アイテムの作成

アイテムの削除

項目を取得する

項目定義を取得する

項目を一覧表示する

項目を更新する

項目定義を更新する

オンデマンドの項目ジョブの実行

項目ジョブのインスタンスの取得

項目ジョブのインスタンスの取り消し

アクティビティ実行のクエリ

既知の制限事項

関連するコンテンツ

フィードバック

その他のリソース

Microsoft Fabric データパイプラインパブリック REST API (プレビュー)

オプション 2: ファブリックポータルの使用