Pipelines - Selective Deploy

服务:: Power BI REST APIs

API 版本:: v1.0

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

Permissions

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

所需范围

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

示例请求

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"
}

示例响应

状态代码:: 200

{
  "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

示例请求

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"
}

示例响应

状态代码:: 200

{
  "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

Object

部署 Power BI 项（例如报表或仪表板）的请求

名称	类型	说明
options	DeploymentOptions	特定 Power BI 项的部署配置选项（例如报表或仪表板）
sourceId	string (uuid)	要部署的 Power BI 项（例如报表或仪表板）的 ID

DeploymentError

Object

部署步骤的错误详细信息

名称	类型	说明
errorCode	string	错误代码
errorDetails	string	其他错误详细信息

DeploymentExecutionPlan

Object

部署执行计划

名称	类型	说明
steps	DeploymentExecutionStep[]	执行计划步骤的集合

DeploymentExecutionStep

Object

部署执行步骤

名称	类型	说明
error	DeploymentError	错误详细信息。仅当管道作失败时适用。
index	integer	步骤索引
preDeploymentDiffState	DeploymentExecutionStepPreDeploymentDiffState	是部署前目标阶段中项的新项、不同项或相同项。
sourceAndTarget	DeploymentSourceAndTarget	步骤的源项和目标项
status	PipelineOperationStatus	管道作的状态
type	DeploymentStepType	部署步骤的类型

DeploymentExecutionStepPreDeploymentDiffState

枚举

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

值	说明
New	目标阶段中不存在的新部署项。
Different	在部署之前，源阶段中的项与目标阶段中的项不同。
NoDifference	在部署之前，源阶段中的项与目标阶段中的项相同。

DeploymentOptions

Object

部署配置选项。可以为整个部署或特定 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

Object

源项和目标项

名称	类型	说明
source	string (uuid)	从源阶段部署的 Power BI 项的 ID
sourceDisplayName	string	从源阶段部署的 Power BI 项的显示名称
target	string (uuid)	将在目标阶段覆盖的 Power BI 项的 ID。仅当覆盖 Power BI 项时适用。
targetDisplayName	string	将在目标阶段覆盖的 Power BI 项的名称。仅当覆盖 Power BI 项时适用。
type	string	将在目标阶段覆盖的 Power BI 项的类型。仅当覆盖 Power BI 项时适用。

DeploymentStepType

枚举

部署步骤的类型

值	说明
DatasetDeployment	部署单个数据集的步骤
ReportDeployment	部署单个报表的步骤
DashboardDeployment	部署单个仪表板的步骤
DataflowDeployment	部署单个数据流的步骤
DatamartDeployment	部署单个 Datamart 的步骤

PipelineNewWorkspaceRequest

Object

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

名称	类型	说明
capacityId	string (uuid)	将分配给新工作区的容量的 ID。如果未指定，并且 API 调用方具有源阶段工作区容量的权限，则将使用该容量。否则，Power BI 将选择 API 调用方有权访问的容量。
name	string	新工作区的名称

PipelineOperation

Object

Power BI 部署管道作

名称	类型	说明
executionEndTime	string (date-time)	作结束的日期和时间
executionPlan	DeploymentExecutionPlan	部署执行计划。仅适用于单个管道作。
executionStartTime	string (date-time)	作启动的日期和时间
id	string (uuid)	作 ID
lastUpdatedTime	string (date-time)	上次更新作的日期和时间
note	PipelineOperationNote	表示作说明的注释。
performedBy	PipelineOperationUser	执行管道作的用户或服务主体。
preDeploymentDiffInformation	PreDeploymentDiffInformation	在部署之前，源阶段中已部署的项量（与目标阶段中的项相同或不同）。
sourceStageOrder	integer	源管道部署阶段的数字标识符。开发（0）、测试（1）、生产（2）。
status	PipelineOperationStatus	管道作状态
targetStageOrder	integer	目标管道部署阶段的数字标识符。开发（0）、测试（1）、生产（2）。
type	PipelineOperationType	作类型

PipelineOperationNote

Object

描述部署的注释。

名称	类型	说明
content	string	描述部署的文本。
isTruncated	boolean	指示注释是否不完整。如此，只返回注释的一部分。 False，便笺已完成。

PipelineOperationStatus

枚举

管道作状态

值	说明
NotStarted	作未启动
Executing	正在执行的作
Succeeded	作成功
Failed	作失败

PipelineOperationType

枚举

作类型

值	说明
Deploy	在阶段之间部署内容

PipelineOperationUser

Object

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

名称	类型	说明
principalObjectID	string (uuid)	执行部署的服务主体的 ID。
principalType	PrincipalType	执行部署的用户的类型。
userPrincipalName	string	执行部署的用户的 UPN。

PipelineUpdateAppSettings

Object

部署后配置更新组织应用

名称	类型	说明
updateAppInTargetWorkspace	boolean	是否更新目标工作区中的应用。仅更新应用中已存在的已部署项。新部署的项不会添加到应用。

PreDeploymentDiffInformation

Object

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

名称	类型	说明
differentArtifactsCount	integer	在部署之前，源阶段和目标阶段之间存在差异的已部署项数。
newArtifactsCount	integer	部署到目标阶段的新项数。
noDifferenceArtifactsCount	integer	在部署之前，源阶段和目标阶段中相同的已部署项数。

PrincipalType

枚举

主体类型

值	说明
None	无主体类型。用于整个组织级别的访问。
User	用户主体类型
Group	组主体类型
App	服务主体类型

SelectiveDeployRequest

Object

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

名称	类型	说明
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	在目标工作区设置中更新组织应用

通过

Pipelines - Selective Deploy

Permissions

所需范围

局限性

URI 参数

请求正文

响应

示例

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

示例请求

示例响应

定义

DeployArtifactRequest

DeploymentError

DeploymentExecutionPlan

DeploymentExecutionStep

DeploymentExecutionStepPreDeploymentDiffState

DeploymentOptions

DeploymentSourceAndTarget

DeploymentStepType

PipelineNewWorkspaceRequest

PipelineOperation

PipelineOperationNote

PipelineOperationStatus

PipelineOperationType

PipelineOperationUser

PipelineUpdateAppSettings

PreDeploymentDiffInformation

PrincipalType

SelectiveDeployRequest