次の方法で共有

Pipelines - Selective Deploy

サービス:
Power BI REST APIs
API バージョン:
v1.0

指定したデプロイ パイプラインのソース ステージから、指定した項目をデプロイします。

権限

ユーザーは、少なくともソースとターゲットの両方のデプロイ ワークスペースで共同作成者である必要があります。 詳細については、「アクセス許可の」を参照してください。

必要なスコープ

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

1 つのデータセットをデプロイするための手順
ReportDeployment

1 つのレポートを配置する手順
DashboardDeployment

1 つのダッシュボードをデプロイするための手順
DataflowDeployment

1 つのデータフローをデプロイするための手順
DatamartDeployment

1 つのデータマートをデプロイするための手順

PipelineNewWorkspaceRequest

Object

新しいワークスペースを作成するための構成の詳細。 ワークスペースが割り当てられていないステージにデプロイする場合に必要です。

名前 型 説明
capacityId

string (uuid)

新しいワークスペースが割り当てられる容量の ID。 指定されておらず、API 呼び出し元にソース ステージ ワークスペース容量に対するアクセス許可がある場合は、その容量が使用されます。 それ以外の場合、Api 呼び出し元がアクセス許可を持つ容量が Power BI によって選択されます。
name

string

新しいワークスペースの名前

PipelineOperation

Object

Power BI デプロイ パイプライン操作

名前 型 説明
executionEndTime

string (date-time)

操作が終了した日時
executionPlan

DeploymentExecutionPlan

デプロイ実行プラン。 1 つのパイプライン操作にのみ適用されます。
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

メモが不完全かどうかを示します。 True の場合、ノートの一部のみが返されます。 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

ターゲット ワークスペースの設定で組織アプリを更新する