Pipelines - Deploy All

指定したデプロイ パイプラインのソース ステージから、サポートされているすべての項目をデプロイします。

デプロイ パイプラインでサポートされていない項目については、「 サポートされていない項目」を参照してください。

アクセス許可

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

必要なスコープ

Pipeline.Deploy

制限事項

要求あたり最大 300 個の展開済みアイテム。

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

URI パラメーター

名前 / 必須 説明
pipelineId
path True

string

uuid

デプロイ パイプライン ID

要求本文

名前 必須 説明
sourceStageOrder True

integer

コンテンツのデプロイ元となるパイプライン デプロイ ステージの数値識別子。 開発 (0)、テスト (1)、運用 (2)。

isBackwardDeployment

boolean

デプロイがデプロイ パイプラインの後のステージから以前のステージに配置されるかどうか。 既定値は false です。

newWorkspace

PipelineNewWorkspaceRequest

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

note

string

デプロイについて説明するメモ。

options

DeploymentOptions

デプロイ全体の動作を制御するオプション

updateAppSettings

PipelineUpdateAppSettings

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

応答

名前 説明
202 Accepted

PipelineOperation

同意

Example of deploying all 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/deployAll
{
  "sourceStageOrder": 0,
  "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
    }
  ]
}

定義

名前 説明
DeployAllRequest

デプロイ パイプライン ステージからサポートされているすべての項目をデプロイする要求

DeploymentError

デプロイ 手順のエラーの詳細

DeploymentExecutionPlan

デプロイ実行プラン

DeploymentExecutionStep

デプロイの実行手順

DeploymentExecutionStepPreDeploymentDiffState

デプロイ前のターゲット ステージの項目とは異なる、または同一の新しい項目です。

DeploymentOptions

デプロイ構成オプション。 展開全体、または特定の Power BI アイテム (レポートやダッシュボードなど) に対して指定できます。 両方を指定すると、Power BI 項目の展開オプションのみが使用されます。

DeploymentSourceAndTarget

ソースアイテムとターゲットアイテム

DeploymentStepType

デプロイ 手順の種類

PipelineNewWorkspaceRequest

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

PipelineOperation

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

PipelineOperationNote

デプロイについて説明するメモ。

PipelineOperationStatus

パイプライン操作の状態

PipelineOperationType

操作の種類

PipelineOperationUser

パイプライン操作を実行したユーザーまたはサービス プリンシパル。

PipelineUpdateAppSettings

デプロイ後の構成更新組織アプリ

PreDeploymentDiffInformation

デプロイ前の新しい、異なる、同一のデプロイ済みアイテムの量。

PrincipalType

プリンシパルの種類

DeployAllRequest

デプロイ パイプライン ステージからサポートされているすべての項目をデプロイする要求

名前 説明
isBackwardDeployment

boolean

デプロイがデプロイ パイプラインの後のステージから以前のステージに行われるかどうか。 既定値は false です。

newWorkspace

PipelineNewWorkspaceRequest

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

note

string

デプロイについて説明するメモ。

options

DeploymentOptions

デプロイ全体の動作を制御するオプション

sourceStageOrder

integer

コンテンツのデプロイ元となるパイプライン デプロイ ステージの数値識別子。 開発 (0)、テスト (1)、運用 (2)。

updateAppSettings

PipelineUpdateAppSettings

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

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

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

DataflowDeployment

string

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

DatamartDeployment

string

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

DatasetDeployment

string

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

ReportDeployment

string

1 つのレポートを展開する手順

PipelineNewWorkspaceRequest

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

名前 説明
capacityId

string

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

name

string

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

PipelineOperation

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

名前 説明
executionEndTime

string

操作が終了した日時

executionPlan

DeploymentExecutionPlan

デプロイ実行プラン。 1 つのパイプライン操作にのみ適用されます。

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

ユーザー プリンシパルの種類