Pipelines - Selective Deploy

服務:: Power BI REST APIs

API 版本:: v1.0

從指定部署管線的來源階段部署指定的項目。

權限

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

必要範圍

管線.部署

局限性

每個請求最多 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

範例要求

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

定義

名稱	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

Object

部署 Power BI 專案的要求（例如報表或儀錶板）

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

DeploymentError

Object

部署步驟的錯誤詳細資料

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

DeploymentExecutionPlan

Object

部署執行計劃

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

DeploymentExecutionStep

Object

部署執行步驟

名稱	類型	Description
error	DeploymentError	錯誤詳細數據。只有在管線作業失敗時才適用。
index	integer	步數索引
preDeploymentDiffState	DeploymentExecutionStepPreDeploymentDiffState	是部署前目標階段中的項目是新的、不同或相同的項目。
sourceAndTarget	DeploymentSourceAndTarget	步驟的來源和目標項目
status	PipelineOperationStatus	管線作業的狀態
type	DeploymentStepType	部署步驟的類型

DeploymentExecutionStepPreDeploymentDiffState

列舉型別

是部署前目標階段中的項目是新的、不同或相同的項目。

值	Description
New	目標階段中不存在的新部署項目。
Different	在部署之前，來源階段中的項目與目標階段中的項目不同。
NoDifference	在部署之前，來源階段中的項目與目標階段中的項目相同。

DeploymentOptions

Object

部署組態選項。可以針對整個部署或特定 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

Object

來源和目標項目

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

DeploymentStepType

列舉型別

部署步驟的類型

值	Description
DatasetDeployment	部署單一資料集的步驟
ReportDeployment	部署單一報表的步驟
DashboardDeployment	部署單一儀表板的步驟
DataflowDeployment	部署單一資料流程的步驟
DatamartDeployment	部署單一資料市集的步驟

PipelineNewWorkspaceRequest

Object

建立新工作區的組態詳細資料。部署至沒有指派工作區的階段時，需要。

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

PipelineOperation

Object

Power BI 部署管線作業

名稱	類型	Description
executionEndTime	string (date-time)	作業結束的日期和時間
executionPlan	DeploymentExecutionPlan	部署執行計劃。僅適用於單一管線作業。
executionStartTime	string (date-time)	作業開始的日期和時間
id	string (uuid)	作業識別碼
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

說明部署的附註。

名稱	類型	Description
content	string	描述部署的文字。
isTruncated	boolean	指出註記是否不完整。沒錯，只會傳回部分註解。 False，則註釋已完成。

PipelineOperationStatus

列舉型別

管線作業狀態

值	Description
NotStarted	作業未開始
Executing	執行作業
Succeeded	操作成功
Failed	作業失敗

PipelineOperationType

列舉型別

作業類型

值	Description
Deploy	在階段之間部署內容

PipelineOperationUser

Object

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

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

PipelineUpdateAppSettings

Object

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

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

PreDeploymentDiffInformation

Object

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

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

PrincipalType

列舉型別

主體類型

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

SelectiveDeployRequest

Object

從部署管線階段選擇性地部署項目的要求

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

範例要求

範例回覆

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