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

Имя	В	Обязательно	Тип	Описание
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

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

Определения

Имя	Описание
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 (например, отчета или панели мониторинга)

Имя	Тип	Описание
options	DeploymentOptions	Параметры конфигурации развертывания для определенного элемента Power BI (например, отчета или панели мониторинга).
sourceId	string	Идентификатор элемента Power BI (например, отчета или панели мониторинга) для развертывания

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

DeploymentStepType

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

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

PipelineNewWorkspaceRequest

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

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

PipelineOperation

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

Имя	Тип	Описание
executionEndTime	string	Дата и время завершения операции.
executionPlan	DeploymentExecutionPlan	План выполнения развертывания. Применимо только к одной операции конвейера.
executionStartTime	string	Дата и время начала операции
id	string	Идентификатор операции
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	Идентификатор субъекта-службы, который выполнил развертывание.
principalType	PrincipalType	Тип пользователя, выполнившего развертывание.
userPrincipalName	string	Имя участника-пользователя, выполнившего развертывание.

PipelineUpdateAppSettings

Обновление конфигурации приложения организации после развертывания

Имя	Тип	Описание
updateAppInTargetWorkspace	boolean	Следует ли обновить приложение в целевой рабочей области. Обновляются только развернутые элементы, которые уже существуют в приложении. Новые развернутые элементы не добавляются в приложение.

PreDeploymentDiffInformation

Количество новых, различных и идентичных развернутых элементов перед развертыванием.

Имя	Тип	Описание
differentArtifactsCount	integer	Количество развернутых элементов с различиями между исходным и целевым этапами перед развертыванием.
newArtifactsCount	integer	Количество новых элементов, развернутых на целевом этапе.
noDifferenceArtifactsCount	integer	Количество идентичных развернутых элементов на исходном и целевом этапах перед развертыванием.

PrincipalType

Тип участника

Имя	Тип	Описание
App	string	Тип субъекта-службы
Group	string	Тип участника группы
None	string	Нет типа субъекта. Используйте для доступа на уровне всей организации.
User	string	Тип участника-пользователя

SelectiveDeployRequest

Запрос на выборочное развертывание элементов из этапа конвейера развертывания

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

Дополнительные ресурсы