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 매개 변수

Name	In(다음 안에)	필수	형식	Description
pipelineId	path	True	string uuid	배포 파이프라인 ID

요청 본문

Name	필수	형식	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	대상 작업 영역 설정에서 조직 앱 업데이트

응답

Name	형식	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
    }
  ]
}

정의

Name	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 항목 배포 요청(예: 보고서 또는 대시보드)

Name	형식	Description
options	DeploymentOptions	특정 Power BI 항목에 대한 배포 구성 옵션(예: 보고서 또는 대시보드)
sourceId	string	배포할 Power BI 항목의 ID(예: 보고서 또는 대시보드)

DeploymentError

배포 단계에 대한 오류 세부 정보

Name	형식	Description
errorCode	string	오류 코드
errorDetails	string	추가 오류 세부 정보

DeploymentExecutionPlan

배포 실행 계획

Name	형식	Description
steps	DeploymentExecutionStep[]	실행 계획 단계의 컬렉션

DeploymentExecutionStep

배포 실행 단계

Name	형식	Description
error	DeploymentError	오류 세부 정보입니다. 파이프라인 작업이 실패한 경우에만 적용됩니다.
index	integer	단계 인덱스
preDeploymentDiffState	DeploymentExecutionStepPreDeploymentDiffState	배포 전 대상 단계의 항목과 다르거나 동일한 새 항목입니다.
sourceAndTarget	DeploymentSourceAndTarget	단계의 원본 및 대상 항목
status	PipelineOperationStatus	파이프라인 작업의 상태
type	DeploymentStepType	배포 단계의 유형

DeploymentExecutionStepPreDeploymentDiffState

배포 전 대상 단계의 항목과 다르거나 동일한 새 항목입니다.

Name	형식	Description
Different	string	배포 전에는 원본 단계의 항목이 대상 단계의 항목과 동일하지 않았습니다.
New	string	대상 단계에 없는 배포된 새 항목입니다.
NoDifference	string	배포 전에 원본 단계의 항목은 대상 단계의 항목과 동일했습니다.

DeploymentOptions

배포 구성 옵션. 전체 배포 또는 특정 Power BI 항목(예: 보고서 또는 대시보드)에 대해 지정할 수 있습니다. 둘 다 지정된 경우 Power BI 항목에 대한 배포 옵션만 사용됩니다.

Name	형식	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

원본 및 대상 항목

Name	형식	Description
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

배포 단계의 유형

Name	형식	Description
DashboardDeployment	string	단일 대시보드를 배포하는 단계
DataflowDeployment	string	단일 데이터 흐름을 배포하기 위한 단계
DatamartDeployment	string	단일 데이터 마트를 배포하는 단계
DatasetDeployment	string	단일 데이터 세트를 배포하기 위한 단계
ReportDeployment	string	단일 보고서를 배포하는 단계

PipelineNewWorkspaceRequest

새 작업 영역을 만들기 위한 구성 세부 정보입니다. 할당된 작업 영역이 없는 단계에 배포할 때 필요합니다.

Name	형식	Description
capacityId	string	새 작업 영역이 할당될 용량의 ID입니다. 지정되지 않고 API 호출자에게 원본 단계 작업 영역 용량에 대한 권한이 있는 경우 해당 용량이 사용됩니다. 그렇지 않으면 Power BI는 API 호출자에게 권한이 있는 용량을 선택합니다.
name	string	새 작업 영역의 이름

PipelineOperation

Power BI 배포 파이프라인 작업

Name	형식	Description
executionEndTime	string	작업이 종료된 날짜 및 시간입니다.
executionPlan	DeploymentExecutionPlan	배포 실행 계획입니다. 단일 파이프라인 작업에만 적용됩니다.
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

배포를 설명하는 참고 사항입니다.

Name	형식	Description
content	string	배포를 설명하는 텍스트입니다.
isTruncated	boolean	메모가 불완전한지 나타냅니다. True이면 메모의 일부만 반환됩니다. False이면 메모가 완료됩니다.

PipelineOperationStatus

파이프라인 작업 상태

Name	형식	Description
Executing	string	작업 실행
Failed	string	작업 실패
NotStarted	string	작업이 시작되지 않음
Succeeded	string	작업이 성공했습니다.

PipelineOperationType

작업 유형

Name	형식	Description
Deploy	string	단계 간에 콘텐츠 배포

PipelineOperationUser

파이프라인 작업을 수행한 사용자 또는 서비스 주체입니다.

Name	형식	Description
principalObjectID	string	배포를 수행한 서비스 주체의 ID입니다.
principalType	PrincipalType	배포를 수행한 사용자 유형입니다.
userPrincipalName	string	배포를 수행한 사용자의 UPN입니다.

PipelineUpdateAppSettings

배포 후 구성 업데이트 조직 앱

Name	형식	Description
updateAppInTargetWorkspace	boolean	대상 작업 영역에서 앱을 업데이트할지 여부입니다. 앱에 이미 있는 배포된 항목만 업데이트됩니다. 배포된 새 항목은 앱에 추가되지 않습니다.

PreDeploymentDiffInformation

배포 전에 배포된 신규, 다른 항목 및 동일한 항목의 양입니다.

Name	형식	Description
differentArtifactsCount	integer	배포 전 원본 단계와 대상 단계 간에 차이가 있는 배포된 항목의 수입니다.
newArtifactsCount	integer	대상 단계에 배포된 새 항목의 수입니다.
noDifferenceArtifactsCount	integer	배포 전 원본 및 대상 단계에서 동일한 배포된 항목의 수입니다.

PrincipalType

보안 주체 유형

Name	형식	Description
App	string	서비스 주체 유형
Group	string	그룹 보안 주체 유형
None	string	보안 주체 유형이 없습니다. 전체 조직 수준 액세스에 사용합니다.
User	string	사용자 계정 유형

SelectiveDeployRequest

배포 파이프라인 단계에서 항목을 선택적으로 배포하기 위한 요청

Name	형식	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

추가 리소스