Microsoft Fabric の展開パイプライン ツールを使うと、チームは、Fabric コンテンツのための効率的で再利用可能なリリース プロセスを構築できます。
展開パイプラインの Fabric REST API を使用して、Fabric を組織の自動化プロセスに統合します。 API を使用して実行できることの例をいくつか次に示します。
Azure DevOps や GitHub Actions などの使い慣れた DevOps ツールに、Fabric を統合します。
特定の日時にパイプラインによるデプロイが自動的に実行されるようにスケジュールします。
複数のパイプラインを同時にデプロイします。
パイプラインのデプロイに応じてカスケードします。 パイプライン間で接続されているコンテンツがある場合、一部のパイプラインが他より先にデプロイされるようにできます。
前提条件
展開パイプライン API を使用するには、次の前提条件が必要です。
- 展開パイプラインを使用する必要がある同じ前提条件。
- Fabric サービス用の Microsoft Entra トークン。 API 呼び出しの承認ヘッダーでそのトークンを使用します。 トークンを取得する方法については、「Fabric API のクイック スタート」を参照してください。
PowerShell なしで REST API を使用できますが、この記事のScriptでは PowerShell を使用します。 スクリプトを実行するには、次のプログラムをインストールする必要があります。
デプロイ パイプラインの API 関数
デプロイ パイプラインの Fabric REST API では、次の機能を実行できます。
展開パイプラインの取得: 指定された展開パイプラインに関する情報を返します。
展開パイプラインの一覧表示: ユーザーがアクセスできる展開パイプラインの一覧を返します。
展開パイプライン ステージの一覧表示: 指定した展開のステージ (ID、表示名、説明、ステージが公開されているかどうかなど) を返します。
展開パイプライン ステージ項目の一覧表示: 指定した展開パイプラインの指定したステージに割り当てられているワークスペースから、サポートされている項目を返します。
ステージ コンテンツのデプロイ: 指定した展開パイプラインの指定したステージから項目をデプロイします。
この API を使用して、すべての項目をデプロイするか、デプロイする特定の項目を選択します。 特定の項目が選択されていない場合は、すべての項目がデプロイされます。
展開する関連ステージ ID を見つけるには、展開パイプライン ステージの一覧表示 API を使用します。
この API は、デプロイの状態を監視するために、実行時間の長い操作 API と統合されています。
- 操作の状態を取得し、長時間実行する操作 - 操作状態の取得 API を使用して、操作が完了したかどうかを確認します。
- デプロイが完了してから 24 時間、拡張デプロイ情報は 操作結果の取得 API で入手できます。
デプロイ パイプラインの作成: デプロイ パイプラインを作成します。
デプロイ パイプラインの削除: デプロイ パイプラインを削除します。
デプロイ パイプラインを更新する: デプロイ パイプラインを更新します。
デプロイ パイプライン ステージの取得: デプロイ パイプライン ステージの詳細を取得します。
デプロイ パイプライン ステージを更新する: デプロイ パイプライン ステージを更新します。
デプロイ パイプラインのロールの割り当ての追加: デプロイ パイプラインにロールの割り当てを追加します。
デプロイ パイプライン ロールの割り当てを削除する: デプロイ パイプラインからロールの割り当てを削除します。
デプロイ パイプラインのロールの割り当てを一覧表示する: デプロイ パイプラインのすべてのロールの割り当てを一覧表示します。
デプロイ パイプライン ステージにワークスペースを割り当てる: 特定のデプロイ パイプライン ステージにワークスペースを割り当てます。
デプロイ パイプライン ステージからワークスペースの割り当てを解除する: 特定のデプロイ パイプライン ステージからワークスペースの割り当てを解除します。
デプロイ パイプライン操作の取得: デプロイ パイプライン操作の詳細を取得します。
デプロイ パイプラインの操作を一覧表示する: デプロイ パイプラインのすべての操作を一覧表示します。
他の Fabric REST API 呼び出しを使用して、関連する操作を完了することもできます。
PowerShell の例
以下の PowerShell スクリプトを使って、いくつかの自動化プロセスを実行する方法を理解できます。 PowerShell サンプルのテキストを表示またはコピーするには、このセクションのリンクを使用します。
Fabric-Samples GitHub フォルダー全体をダウンロードすることもできます。
-
次の情報を指定します。
- パイプライン名
- ソース ステージ名
- ターゲット ステージ名
- デプロイに関する注意事項 (省略可能)
- プリンシパルの種類。 UserPrincipal または ServicePrincipal を選択します。 サービス プリンシパルの場合は、以下の情報も提供してください。
- サービス プリンシパルのアプリケーション (クライアント) ID
- サービス プリンシパルのディレクトリ (テナント) ID
- サービス プリンシパルのシークレット値
-
次の情報を指定します。
- パイプライン名
- ソース ステージ名
- ターゲット ステージ名
- 展開する項目 (項目の表示名と項目の種類)
- デプロイに関する注意事項 (省略可能)
- プリンシパルの種類。 UserPrincipal または ServicePrincipal を選択します。 サービス プリンシパルの場合は、次の情報も提供してください。
- サービス プリンシパルのアプリケーション (クライアント) ID
- サービス プリンシパルのディレクトリ (テナント) ID
- サービス プリンシパルのシークレット値
-
次の情報を指定します。
- 開発ワークスペース ID
- 新しい運用ワークスペース名
- パイプライン名
- デプロイに関する注意事項 (省略可能)
- プリンシパルの種類。 UserPrincipal または ServicePrincipal を選択します。 サービス プリンシパルの場合は、次も指定します。
- サービス プリンシパルのアプリケーション (クライアント) ID
- サービス プリンシパルのディレクトリ (テナント) ID
- サービス プリンシパルのシークレット値
考慮事項と制限事項
展開パイプライン API を使用する場合は、次の制限事項を考慮してください。
展開パイプラインに適用されるすべての制限事項は、API を使用する場合に適用されます。 詳細については、「展開パイプラインのベスト プラクティス」を参照してください。
データフローは現在サポートされていません。 データフローを使用しているお客様は、Power BI API を使用できます。
Power BI API で使用できるデプロイ オプションすべてが Fabric で使用できるわけではありません。 次の API は、Fabric のデプロイ ステージ コンテンツ API では使用できません。
- allowPurgeData
- 引き継ぎを許可
- allowSkipTilesWithMissingPrerequisites
これらの API のいずれかを使用するには、 Power BI API を使用してデプロイします。 ただし、これらの API は Power BI 項目でのみ機能します。