Pipelines - Selective Deploy

參考

Service:: Power BI REST APIs

API Version:: v1.0

從指定部署管線的來源階段部署指定的專案。

權限

使用者至少必須是來源和目標部署工作區的成員。如需詳細資訊，請參閱權限。

必要範圍

Pipeline.Deploy

限制

每個要求最多 300 個已部署的專案。

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

URI 參數

名稱	位於	必要	類型	Description
pipelineId	path	True	string uuid	部署管線識別碼

要求本文

名稱	必要	類型	Description
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	更新目標工作區設定中的組織應用程式

回應

名稱	類型	Description
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

Request Body

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

Status code:: 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

Sample Request

POST https://api.powerbi.com/v1.0/myorg/pipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/deploy

Request Body

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

Status code:: 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
    }
  ]
}

定義

名稱	Description
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 專案的要求 (，例如報表或儀表板)

名稱	類型	Description
options	DeploymentOptions	特定 Power BI 專案的部署組態選項 (例如報表或儀表板)
sourceId	string	要部署的 Power BI 專案 (識別碼，例如報表或儀表板)

DeploymentError

部署步驟的錯誤詳細資料

名稱	類型	Description
errorCode	string	錯誤碼
errorDetails	string	其他錯誤詳細資料

DeploymentExecutionPlan

部署執行計畫

名稱	類型	Description
steps	DeploymentExecutionStep[]	執行計畫步驟的集合

DeploymentExecutionStep

部署執行步驟

名稱	類型	Description
error	DeploymentError	錯誤詳細資料。僅適用于管線作業失敗時。
index	integer	步驟索引
preDeploymentDiffState	DeploymentExecutionStepPreDeploymentDiffState	這是部署前目標階段中專案的新專案、不同或完全相同的專案。
sourceAndTarget	DeploymentSourceAndTarget	步驟的來源和目標專案
status	PipelineOperationStatus	管線作業的狀態
type	DeploymentStepType	部署步驟的類型

DeploymentExecutionStepPreDeploymentDiffState

這是部署前目標階段中專案的新專案、不同或完全相同的專案。

名稱	類型	Description
Different	string	在部署之前，來源階段中的專案與目標階段中的專案不同。
New	string	目標階段中不存在的新已部署專案。
NoDifference	string	在部署之前，來源階段中的專案與目標階段中的專案相同。

DeploymentOptions

部署組態選項。可以針對整個部署或特定 Power BI 專案 (指定，例如報表或儀表板) 。如果同時指定兩者，則只會使用 Power BI 專案的部署選項。

名稱	類型	Description
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

來源和目標專案

名稱	類型	Description
source	string	從來源階段部署的 Power BI 專案識別碼
sourceDisplayName	string	從來源階段部署的 Power BI 專案的顯示名稱
target	string	將在目標階段中覆寫之 Power BI 專案的識別碼。只有在覆寫 Power BI 專案時才適用。
targetDisplayName	string	將在目標階段中覆寫的 Power BI 專案名稱。只有在覆寫 Power BI 專案時才適用。
type	string	將在目標階段中覆寫的 Power BI 專案類型。只有在覆寫 Power BI 專案時才適用。

DeploymentStepType

部署步驟的類型

名稱	類型	Description
DashboardDeployment	string	部署單一儀表板的步驟
DataflowDeployment	string	部署單一資料流程的步驟
DatamartDeployment	string	部署單一資料超市的步驟
DatasetDeployment	string	部署單一資料集的步驟
ReportDeployment	string	部署單一報表的步驟

PipelineNewWorkspaceRequest

用於建立新工作區的組態詳細資料。部署至沒有指派工作區的階段時，為必要專案。

名稱	類型	Description
capacityId	string	將指派新工作區之容量的識別碼。如果未指定，且 API 呼叫端具有來源階段工作區容量的許可權，則會使用該容量。否則，Power BI 會選取 API 呼叫者具有許可權的容量。
name	string	新工作區的名稱

PipelineOperation

Power BI 部署管線作業

名稱	類型	Description
executionEndTime	string	作業結束的日期和時間
executionPlan	DeploymentExecutionPlan	部署執行計畫。僅適用于單一管線作業。
executionStartTime	string	作業啟動的日期和時間
id	string	作業識別碼
lastUpdatedTime	string	上次更新作業的日期和時間
note	PipelineOperationNote	表示作業描述的附注。
performedBy	PipelineOperationUser	執行管線作業的使用者或服務主體。
preDeploymentDiffInformation	PreDeploymentDiffInformation	部署之前，來源階段中已部署的專案數量，與目標階段中的專案相同或不同。
sourceStageOrder	integer	來源管線部署階段的數值識別碼。開發 (0) 、測試 (1) 、生產 (2) 。
status	PipelineOperationStatus	管線作業狀態
targetStageOrder	integer	目標管線部署階段的數值識別碼。開發 (0) 、測試 (1) 、生產 (2) 。
type	PipelineOperationType	作業類型

PipelineOperationNote

描述部署的附注。

名稱	類型	Description
content	string	描述部署的文字。
isTruncated	boolean	指出附注是否不完整。 True 是表示只會傳回一部分的附注。 False，附注已完成。

PipelineOperationStatus

管線作業狀態

名稱	類型	Description
Executing	string	正在執行的作業
Failed	string	作業失敗
NotStarted	string	作業未啟動
Succeeded	string	作業成功

PipelineOperationType

作業類型

名稱	類型	Description
Deploy	string	在階段之間部署內容

PipelineOperationUser

執行管線作業的使用者或服務主體。

名稱	類型	Description
principalObjectID	string	執行部署的服務主體識別碼。
principalType	PrincipalType	執行部署的使用者類型。
userPrincipalName	string	執行部署之使用者的 UPN。

PipelineUpdateAppSettings

部署後設定更新組織應用程式

名稱	類型	Description
updateAppInTargetWorkspace	boolean	是否要更新目標工作區中的應用程式。只會更新應用程式中已存在的已部署專案。新的已部署專案不會新增至應用程式。

PreDeploymentDiffInformation

部署前的新、不同和相同的已部署專案數量。

名稱	類型	Description
differentArtifactsCount	integer	在部署之前，來源和目標階段之間有差異的已部署專案數目。
newArtifactsCount	integer	部署到目標階段的新專案數目。
noDifferenceArtifactsCount	integer	部署之前，來源和目標階段中相同的已部署專案數目。

PrincipalType

主體類型

名稱	類型	Description
App	string	服務主體類型
Group	string	群組主體類型
None	string	沒有主體類型。用於整個組織層級存取。
User	string	使用者主體類型

SelectiveDeployRequest

從部署管線階段選擇性部署專案的要求

名稱	類型	Description
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

權限

必要範圍

限制

URI 參數

要求本文

回應

範例

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

Sample Request

Sample Response

Example of deploying specific Power BI items with custom options

Sample Request

Sample Response

定義

DeployArtifactRequest

DeploymentError

DeploymentExecutionPlan

DeploymentExecutionStep

DeploymentExecutionStepPreDeploymentDiffState

DeploymentOptions

DeploymentSourceAndTarget

DeploymentStepType

PipelineNewWorkspaceRequest

PipelineOperation

PipelineOperationNote

PipelineOperationStatus

PipelineOperationType

PipelineOperationUser

PipelineUpdateAppSettings

PreDeploymentDiffInformation

PrincipalType

SelectiveDeployRequest

其他資源