Microsoft Fabric REST API は、Fabric 項目の作成、読み取り、更新、削除 (CRUD) 操作用のサービス エンドポイントを提供します。 この記事では、使用可能なノートブック REST API とそれらの使用方法について説明します。
データ エンジニアとデータ サイエンティストは、ノートブック API を使用して独自のパイプラインを自動化し、CI/CD を便利かつ効率的に確立できます。 また、ユーザーはこれらの API を使用して、Fabric ノートブック項目を簡単に管理および操作したり、ノートブックを他のツールやシステムと統合したりできます。
ノートブックでは、次の項目管理アクションを使用できます。
| アクション | 説明 |
|---|---|
| アイテムの作成 | ワークスペース内でノートブックを作成する。 |
| 項目を更新する | ノートブックのメタデータを更新する。 |
| 項目定義を更新する | ノートブックの内容を更新する。 |
| アイテムの削除 | ノートブックを削除する。 |
| 項目を取得する | ノートブックのメタデータを取得する。 |
| 項目定義を取得する | ノートブックの内容を取得する。 |
| リスト項目 | ワークスペース内のすべての項目を一覧表示する。 |
詳細については、項目 - REST API に関するページを参照してください。
ノートブックでは、次のジョブ スケジューラ アクションを使用できます。
| アクション | 説明 |
|---|---|
| オンデマンドでアイテムジョブを実行する | パラメーター化を使用してノートブックを実行する。 |
| 項目ジョブのインスタンスを取り消す | ノートブック ジョブの実行を取り消す。 |
| 項目タスクのインスタンスを取得する | ノートブックの実行状態を取得する。 |
詳細については、ジョブ スケジューラに関する記事を参照してください。
注意
サービス プリンシパル認証は、Notebook CRUD API とジョブ スケジューラ API で使用できます。つまり、サービス プリンシパルを使用して CRUD 操作を実行し、ノートブックの実行をトリガー/キャンセルし、実行状態を取得できます。 適切なロールを持つワークスペースにサービス プリンシパルを追加する必要があります。