Pipelines - Selective Deploy

Служба:: Power BI REST APIs

Версия API:: v1.0

Развертывает указанные элементы из исходного этапа указанного конвейера развертывания.

Permissions

Пользователь должен быть участником как в исходных, так и целевых рабочих областях развертывания. Дополнительные сведения см. в разделе "Разрешения".

Требуемая область

Pipeline.Deploy

Ограничения

Максимум 300 развернутых элементов на запрос.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
pipelineId	path	True	string (uuid)	Идентификатор конвейера развертывания

Текст запроса

Имя	Обязательно	Тип	Описание
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 (например, отчета или панели мониторинга) для развертывания

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, развернутого на исходном этапе
sourceDisplayName	string	Отображаемое имя элемента Power BI, развернутого на исходном этапе
target	string (uuid)	Идентификатор элемента Power BI, который будет перезаписан на целевом этапе. Применяется только при перезаписи элемента Power BI.
targetDisplayName	string	Имя элемента Power BI, который будет перезаписан на целевом этапе. Применяется только при перезаписи элемента Power BI.
type	string	Тип элемента Power BI, который будет перезаписан на целевом этапе. Применяется только при перезаписи элемента Power BI.

DeploymentStepType

Перечисление

Тип шага развертывания

Значение	Описание
DatasetDeployment	Шаг развертывания одного набора данных
ReportDeployment	Шаг развертывания одного отчета
DashboardDeployment	Шаг развертывания одной панели мониторинга
DataflowDeployment	Шаг развертывания одного потока данных
DatamartDeployment	Шаг развертывания одного объекта datamart

PipelineNewWorkspaceRequest

Object

Сведения о конфигурации для создания новой рабочей области. Требуется при развертывании на стадии, которая не имеет назначенных рабочих областей.

Имя	Тип	Описание
capacityId	string (uuid)	Идентификатор емкости, к которому будет назначена новая рабочая область. Если не указано и вызывающий API имеет разрешения для емкости исходной рабочей области этапа, будет использоваться эта емкость. В противном случае Power BI выберет емкость, для которую вызывающий API имеет разрешения.
name	string	Имя новой рабочей области

PipelineOperation

Object

Операция конвейера развертывания Power BI

Имя	Тип	Описание
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

Примечание, описывающее развертывание.

Имя	Тип	Описание
content	string	Текст, описывающий развертывание.
isTruncated	boolean	Указывает, является ли примечание неполным. True, возвращается только часть заметки. False, заметка завершена.

PipelineOperationStatus

Перечисление

Состояние операции конвейера

Значение	Описание
NotStarted	Операция не запущена
Executing	Выполнение операции
Succeeded	Операция выполнена успешно
Failed	Сбой операции

PipelineOperationType

Перечисление

Тип операции

Значение	Описание
Deploy	Развертывание содержимого между этапами

PipelineOperationUser

Object

Пользователь или субъект-служба, выполняющий операцию конвейера.

Имя	Тип	Описание
principalObjectID	string (uuid)	Идентификатор субъекта-службы, выполняющего развертывание.
principalType	PrincipalType	Тип пользователя, выполняющего развертывание.
userPrincipalName	string	Имя участника-пользователя, выполнившего развертывание.

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	Обновление приложения организации в параметрах целевой рабочей области