Pipelines - Get Pipeline Operations

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

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

Возвращает список последних операций развертывания up-to–20, выполняемых в указанном конвейере развертывания.

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

Pipeline.ReadWrite.All или Pipeline.Read.All

GET https://api.powerbi.com/v1.0/myorg/pipelines/{pipelineId}/operations

Параметры URI

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

Ответы

Имя	Тип	Описание
200 OK	PipelineOperations	ХОРОШО

Примеры

Get pipeline operations example

Образец запроса

GET https://api.powerbi.com/v1.0/myorg/pipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/operations

Пример ответа

Код состояния:: 200

{
  "value": [
    {
      "id": "1065e6a3-a020-4c0c-ada7-92b5fe99eec5",
      "type": "Deploy",
      "status": "Succeeded",
      "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,
      "note": {
        "content": "Sample note",
        "isTruncated": false
      },
      "preDeploymentDiffInformation": {
        "newArtifactsCount": 0,
        "differentArtifactsCount": 0,
        "noDifferenceArtifactsCount": 1
      },
      "performedBy": {
        "userPrincipalName": "john@contoso.com",
        "principalType": "User"
      }
    }
  ]
}

Определения

Имя	Описание
DeploymentError	Сведения об ошибке для шага развертывания
DeploymentExecutionPlan	План выполнения развертывания
DeploymentExecutionStep	Шаг выполнения развертывания
DeploymentExecutionStepPreDeploymentDiffState	Представляет собой новый элемент, другой или идентичный элементам на целевом этапе перед развертыванием.
DeploymentSourceAndTarget	Исходные и целевые элементы
DeploymentStepType	Тип шага развертывания
PipelineOperation	Операция конвейера развертывания Power BI
PipelineOperationNote	Примечание, описывающее развертывание.
PipelineOperations	Оболочка ответа OData для коллекции операций конвейера развертывания Power BI
PipelineOperationStatus	Состояние операции конвейера
PipelineOperationType	Тип операции
PipelineOperationUser	Пользователь или субъект-служба, выполняющий операцию конвейера.
PreDeploymentDiffInformation	Количество новых, разных и идентичных развернутых элементов перед развертыванием.
PrincipalType	Тип субъекта

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	Перед развертыванием элемент на исходном этапе был идентичен одному на целевом этапе.

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

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, заметка завершена.

PipelineOperations

Object

Оболочка ответа OData для коллекции операций конвейера развертывания Power BI

Имя	Тип	Описание
@odata.context	string	Контекст OData
value	PipelineOperation[]	Коллекция операций конвейера развертывания

PipelineOperationStatus

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

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

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

PipelineOperationType

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

Тип операции

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

PipelineOperationUser

Object

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

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

PreDeploymentDiffInformation

Object

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

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

PrincipalType

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

Тип субъекта

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