Pipelines - Selective Deploy

从指定部署管道的源阶段部署指定项。

权限

用户必须至少是源和目标部署工作区的成员。 有关详细信息,请参阅权限

必需范围

Pipeline.Deploy

限制

每个请求最多 300 个已部署项。

POST https://api.powerbi.com/v1.0/myorg/pipelines/{pipelineId}/deploy

URI 参数

名称 必需 类型 说明
pipelineId
path True

string

uuid

部署管道 ID

请求正文

名称 必需 类型 说明
sourceStageOrder True

integer

应从中部署内容的管道部署阶段的数字标识符。 开发 (0) ,测试 (1) ,生产 (2) 。

dashboards

DeployArtifactRequest[]

要部署的仪表板列表

dataflows

DeployArtifactRequest[]

要部署的数据流的列表

datamarts

DeployArtifactRequest[]

要部署的数据市场列表

datasets

DeployArtifactRequest[]

要部署的数据集的列表

isBackwardDeployment

boolean

部署是从部署管道的后续阶段到早期阶段。 默认值为 false

newWorkspace

PipelineNewWorkspaceRequest

用于创建新工作区的配置详细信息。 部署到没有分配工作区的阶段时是必需的。 如果需要,如果未提供新的工作区配置详细信息,则部署将失败。

note

string

描述部署的说明。

options

DeploymentOptions

控制整个部署行为的选项

reports

DeployArtifactRequest[]

要部署的报表列表

updateAppSettings

PipelineUpdateAppSettings

在目标工作区设置中更新组织应用

响应

名称 类型 说明
202 Accepted

PipelineOperation

已接受

示例

Example of deploying specific Power BI items (such as reports or dashboards) from the 'Development' stage
Example of deploying specific Power BI items with custom options

Example of deploying specific Power BI items (such as reports or dashboards) from the 'Development' stage

Sample Request

POST https://api.powerbi.com/v1.0/myorg/pipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/deploy
{
  "sourceStageOrder": 0,
  "dataflows": [
    {
      "sourceId": "29efcfb0-0063-44af-a4ed-6c0bee3417d3"
    }
  ],
  "datamarts": [
    {
      "sourceId": "6bfe235c-6d7b-41b7-98a6-2b8276b3e82b"
    }
  ],
  "datasets": [
    {
      "sourceId": "1a201f2a-d1d8-45c0-8c61-1676338517de"
    }
  ],
  "reports": [
    {
      "sourceId": "2d225191-65f8-4ec3-b77d-06100602b1f7"
    }
  ],
  "dashboards": [
    {
      "sourceId": "9046e4cc-8aea-4a7a-a3b5-1a78b1447d82"
    },
    {
      "sourceId": "7f08923c-8f57-49d6-a010-8335bb9cbd1b"
    }
  ],
  "options": {
    "allowOverwriteArtifact": true,
    "allowCreateArtifact": true
  },
  "note": "Deploying business ready items"
}

Sample Response

{
  "value": [
    {
      "id": "1065e6a3-a020-4c0c-ada7-92b5fe99eec5",
      "type": "Deploy",
      "status": "NotStarted",
      "lastUpdatedTime": "2020-12-13T09:26:43.153",
      "executionStartTime": "2020-12-13T09:25:43.153Z",
      "executionEndTime": "2020-12-13T09:26:43.153Z",
      "sourceStageOrder": 0,
      "targetStageOrder": 1
    }
  ]
}

Example of deploying specific Power BI items with custom options

Sample Request

POST https://api.powerbi.com/v1.0/myorg/pipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/deploy
{
  "sourceStageOrder": 0,
  "datamarts": [
    {
      "sourceId": "6bfe235c-6d7b-41b7-98a6-2b8276b3e82b",
      "options": {
        "allowOverwriteArtifact": true,
        "allowCreateArtifact": true
      }
    }
  ],
  "reports": [
    {
      "sourceId": "2d225191-65f8-4ec3-b77d-06100602b1f7",
      "options": {
        "allowOverwriteArtifact": true
      }
    }
  ],
  "note": "Deploying business ready items"
}

Sample Response

{
  "value": [
    {
      "id": "1065e6a3-a020-4c0c-ada7-92b5fe99eec5",
      "type": "Deploy",
      "status": "NotStarted",
      "lastUpdatedTime": "2020-12-13T09:26:43.153",
      "executionStartTime": "2020-12-13T09:25:43.153Z",
      "executionEndTime": "2020-12-13T09:26:43.153Z",
      "sourceStageOrder": 0,
      "targetStageOrder": 1
    }
  ]
}

定义

名称 说明
DeployArtifactRequest

部署 Power BI 项 ((如报表或仪表板)的请求)

DeploymentError

部署步骤的错误详细信息

DeploymentExecutionPlan

部署执行计划

DeploymentExecutionStep

部署执行步骤

DeploymentExecutionStepPreDeploymentDiffState

是新项,与部署前的目标阶段中的项不同或相同。

DeploymentOptions

部署配置选项。 可以为整个部署或特定 Power BI 项指定 (,例如报表或仪表板) 。 如果两者都指定,则仅使用 Power BI 项的部署选项。

DeploymentSourceAndTarget

源项和目标项

DeploymentStepType

部署步骤的类型

PipelineNewWorkspaceRequest

用于创建新工作区的配置详细信息。 部署到没有分配工作区的阶段时是必需的。

PipelineOperation

Power BI 部署管道操作

PipelineOperationNote

描述部署的说明。

PipelineOperationStatus

管道操作状态

PipelineOperationType

操作类型

PipelineOperationUser

执行管道操作的用户或服务主体。

PipelineUpdateAppSettings

部署后的配置更新组织应用

PreDeploymentDiffInformation

部署前新、不同和相同的已部署项的数量。

PrincipalType

主体类型

SelectiveDeployRequest

从部署管道阶段选择性地部署项的请求

DeployArtifactRequest

部署 Power BI 项 ((如报表或仪表板)的请求)

名称 类型 说明
options

DeploymentOptions

特定 Power BI 项 ((例如报表或仪表板)的部署配置选项)

sourceId

string

要部署的 Power BI 项 (的 ID,例如报表或仪表板)

DeploymentError

部署步骤的错误详细信息

名称 类型 说明
errorCode

string

错误代码

errorDetails

string

其他错误详细信息

DeploymentExecutionPlan

部署执行计划

名称 类型 说明
steps

DeploymentExecutionStep[]

执行计划步骤的集合

DeploymentExecutionStep

部署执行步骤

名称 类型 说明
error

DeploymentError

错误详细信息。 仅当管道操作失败时适用。

index

integer

步骤索引

preDeploymentDiffState

DeploymentExecutionStepPreDeploymentDiffState

是新项,与部署前的目标阶段中的项不同或相同。

sourceAndTarget

DeploymentSourceAndTarget

步骤的源项和目标项

status

PipelineOperationStatus

管道操作的状态

type

DeploymentStepType

部署步骤的类型

DeploymentExecutionStepPreDeploymentDiffState

是新项,与部署前的目标阶段中的项不同或相同。

名称 类型 说明
Different

string

在部署之前,源阶段中的项与目标阶段中的项不同。

New

string

目标阶段中不存在的新部署项。

NoDifference

string

在部署之前,源阶段中的项与目标阶段中的项相同。

DeploymentOptions

部署配置选项。 可以为整个部署或特定 Power BI 项指定 (,例如报表或仪表板) 。 如果两者都指定,则仅使用 Power BI 项的部署选项。

名称 类型 说明
allowCreateArtifact

boolean

是否允许在目标阶段工作区中创建新的 Power BI 项 (,例如报表或仪表板) 。 如果在部署需要此选项时未将 true 此选项设置为 ,则部署将失败。

allowOverwriteArtifact

boolean

是否允许覆盖 Power BI 项 (,例如报表或仪表板) 目标阶段工作区。 如果在部署需要此选项时未将 true 此选项设置为 ,则部署将失败。

allowOverwriteTargetArtifactLabel

boolean

是否可以更改目标 Power BI 项的标签 (,例如报表或仪表板) 。 当源受到保护但目标不受保护时,标签会更改。 如果在部署需要此选项时未将 true 此选项设置为 ,则部署将失败。

allowPurgeData

boolean

架构不匹配时,是否从目标 Power BI 项 ((例如报表或仪表板)中删除所有数据) 。 如果在部署需要此选项时未将 true 此选项设置为 ,则部署将失败。

allowSkipTilesWithMissingPrerequisites

boolean

是否跳过目标阶段工作区中没有模型或报表的磁贴。 如果在部署需要此选项时未将 true 此选项设置为 ,则部署将失败。

allowTakeOver

boolean

是否允许重写以前的分页报表所有者并成为分页报表的所有者。 在将分页报表部署到已包含不属于你的分页报表副本的阶段时适用。 如果在部署需要此选项时未将 true 此选项设置为 ,则部署将失败。

DeploymentSourceAndTarget

源项和目标项

名称 类型 说明
source

string

从源阶段部署的 Power BI 项的 ID

sourceDisplayName

string

从源阶段部署的 Power BI 项的显示名称

target

string

将在目标阶段中覆盖的 Power BI 项的 ID。 仅在覆盖 Power BI 项时适用。

targetDisplayName

string

将在目标阶段被覆盖的 Power BI 项的名称。 仅在覆盖 Power BI 项时适用。

type

string

将在目标阶段中覆盖的 Power BI 项的类型。 仅在覆盖 Power BI 项时适用。

DeploymentStepType

部署步骤的类型

名称 类型 说明
DashboardDeployment

string

部署单个仪表板的步骤

DataflowDeployment

string

部署单个数据流的步骤

DatamartDeployment

string

部署单个数据市场的步骤

DatasetDeployment

string

部署单个数据集的步骤

ReportDeployment

string

部署单个报表的步骤

PipelineNewWorkspaceRequest

用于创建新工作区的配置详细信息。 部署到没有分配工作区的阶段时是必需的。

名称 类型 说明
capacityId

string

新工作区将分配到的容量的 ID。 如果未指定,并且 API 调用方具有源阶段工作区容量的权限,则将使用该容量。 否则,Power BI 将选择 API 调用方具有权限的容量。

name

string

新工作区的名称

PipelineOperation

Power BI 部署管道操作

名称 类型 说明
executionEndTime

string

操作结束的日期和时间

executionPlan

DeploymentExecutionPlan

部署执行计划。 仅适用于单个管道操作。

executionStartTime

string

操作开始的日期和时间

id

string

操作 ID

lastUpdatedTime

string

上次更新操作的日期和时间

note

PipelineOperationNote

表示操作说明的注释。

performedBy

PipelineOperationUser

执行管道操作的用户或服务主体。

preDeploymentDiffInformation

PreDeploymentDiffInformation

在部署之前,源阶段中与目标阶段中的项新、相同或不同的已部署项的数量。

sourceStageOrder

integer

源管道部署阶段的数字标识符。 开发 (0) ,测试 (1) ,生产 (2) 。

status

PipelineOperationStatus

管道操作状态

targetStageOrder

integer

目标管道部署阶段的数字标识符。 开发 (0) ,测试 (1) ,生产 (2) 。

type

PipelineOperationType

操作类型

PipelineOperationNote

描述部署的说明。

名称 类型 说明
content

string

描述部署的文本。

isTruncated

boolean

指示注释是否不完整。 True,仅返回部分注释。 False,说明已完成。

PipelineOperationStatus

管道操作状态

名称 类型 说明
Executing

string

操作正在执行

Failed

string

操作失败

NotStarted

string

操作未启动

Succeeded

string

操作成功

PipelineOperationType

操作类型

名称 类型 说明
Deploy

string

在阶段之间部署内容

PipelineOperationUser

执行管道操作的用户或服务主体。

名称 类型 说明
principalObjectID

string

执行部署的服务主体的 ID。

principalType

PrincipalType

执行部署的用户的类型。

userPrincipalName

string

执行部署的用户的 UPN。

PipelineUpdateAppSettings

部署后的配置更新组织应用

名称 类型 说明
updateAppInTargetWorkspace

boolean

是否更新目标工作区中的应用。 仅更新应用中已存在的已部署项。 新部署的项不会添加到应用。

PreDeploymentDiffInformation

部署前新、不同和相同的已部署项的数量。

名称 类型 说明
differentArtifactsCount

integer

部署前源阶段和目标阶段之间存在差异的已部署项数。

newArtifactsCount

integer

部署到目标阶段的新项数。

noDifferenceArtifactsCount

integer

部署前源阶段和目标阶段中部署的相同项数。

PrincipalType

主体类型

名称 类型 说明
App

string

服务主体类型

Group

string

组主体类型

None

string

无主体类型。 用于整个组织级别的访问。

User

string

用户主体类型

SelectiveDeployRequest

从部署管道阶段选择性地部署项的请求

名称 类型 说明
dashboards

DeployArtifactRequest[]

要部署的仪表板列表

dataflows

DeployArtifactRequest[]

要部署的数据流的列表

datamarts

DeployArtifactRequest[]

要部署的数据市场列表

datasets

DeployArtifactRequest[]

要部署的数据集的列表

isBackwardDeployment

boolean

部署是从部署管道的后续阶段到早期阶段。 默认值为 false

newWorkspace

PipelineNewWorkspaceRequest

用于创建新工作区的配置详细信息。 部署到没有分配工作区的阶段时是必需的。 如果需要,如果未提供新的工作区配置详细信息,则部署将失败。

note

string

描述部署的说明。

options

DeploymentOptions

控制整个部署行为的选项

reports

DeployArtifactRequest[]

要部署的报表列表

sourceStageOrder

integer

应从中部署内容的管道部署阶段的数字标识符。 开发 (0) ,测试 (1) ,生产 (2) 。

updateAppSettings

PipelineUpdateAppSettings

在目标工作区设置中更新组织应用