使用 Fabric API 自动化部署管道

借助 Microsoft Fabric 部署管道工具，团队可以为其 Fabric 内容构建有效且可重复使用的发布过程。

使用部署管道 Fabric REST API 将 Fabric 集成到组织的自动化过程中。 下面是可以使用 API 完成的几个示例：

• 将 Fabric 集成到熟悉的 DevOps 工具中，如 Azure DevOps 或 GitHub Actions。

• 安排管道部署在特定时间自动进行。

• 同时部署多个管道。

• 根据管道部署来设置级联。 如果有跨管道连接的内容，则可以确保某些管道在其他管道之前部署。

先决条件

若要使用部署管道 API，需要满足以下先决条件：

• 使用部署管道所需的相同先决条件。
• 具有 Fabric 服务的 Microsoft Entra 令牌。 该令牌将在 API 调用的授权标头中使用。 有关如何获取令牌的信息，请参阅 Fabric API 快速入门。

可以在不使用 PowerShell 的情况下使用 REST API，不过本文中的脚本使用了 PowerShell。 若要运行脚本，需要安装以下程序：

• PowerShell
• Azure PowerShell Az 模块

部署管道 API 函数

利用部署管道 Fabric REST API 可实现以下功能：

• 获取部署管道：返回有关指定部署管道的信息。

• 列出部署管道：返回用户有权访问的部署管道列表。

• 获取部署管道阶段：返回指定部署的阶段，包括其 ID、显示名称、说明以及该阶段是否为公共阶段。

• 获取部署管道阶段项：从分配给指定部署管道的指定阶段的工作区返回支持的项。

• 部署阶段内容：从指定部署管道的指定阶段部署项。

  • 使用此 API 部署所有项或选择要部署的特定项。 如果未选择特定项，则将部署所有项。

  • 若要查找要部署的相关阶段 ID，请使用“获取部署管道阶段”API。

  • 此 API 与长期运行操作 API 集成以监视部署状态。

    • 使用“获取长期运行 - 获取操作状态”API 获取操作状态，以查看操作是否已完成。
    • 部署完成后 24 小时内，扩展部署信息可在“获取操作结果”API 中获取。

还可以使用其他 Fabric REST API 调用来完成相关操作。

PowerShell 示例

可以通过下面的 PowerShell 脚本来了解如何执行多个自动化过程。 若要在 PowerShell 示例中查看或复制文本，请使用本部分中的链接。

• 全部部署

  提供以下信息：

  • 管道名称
  • 源阶段名称
  • 目标阶段名称
  • 部署说明（可选）

• 选择性部署

  提供以下信息：

  • 管道名称
  • 源阶段名称
  • 目标阶段名称
  • 要部署的项（项显示名称和项目类型）
  • 部署说明（可选）

注意事项和限制

使用部署管道 API 时，请考虑下面的限制：

• 适用于部署管道的所有限制都在使用 API 时适用。 有关详细信息，请参阅部署管道最佳做法。

• 目前不支持数据流。 使用数据流的客户可以使用 Power BI API。

• 仅 Power BI 项支持服务主体。

• 并非 Power BI API 中可用的所有部署选项都可以在 Fabric 中使用。 以下 API 在 Fabric 的部署阶段内容 API 中不可用：

  • allowPurgeData
  • allowTakeOver
  • allowSkipTilesWithMissingPrerequisites

  如果需要其中一个 API，请使用 Power BI API 进行部署。 但是，这些 API 仅适用于 Power BI 项。

相关内容

• 开始使用部署管道
• 部署管道最佳实践
• 排查部署管道问题