Pipelines - Get Pipeline Operation

Ссылка

Service:: Power BI REST APIs

API Version:: v1.0

Возвращает сведения об указанной операции развертывания, выполняемой в указанном конвейере развертывания, включая план выполнения развертывания.

Используйте для отслеживания состояния операции развертывания.

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

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

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

Параметры URI

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

Ответы

Имя	Тип	Описание
200 OK	PipelineOperation	ОК

Примеры

Get a pipeline operation example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/pipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/operations/1065e6a3-a020-4c0c-ada7-92b5fe99eec5

Sample Response

Status code:: 200

{
  "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,
  "executionPlan": {
    "Steps": [
      {
        "index": 0,
        "type": "DataflowDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "New",
        "sourceAndTarget": {
          "source": "29efcfb0-0063-44af-a4ed-6c0bee3417d3",
          "sourceDisplayName": "Source dataflow",
          "type": "dataflow"
        }
      },
      {
        "index": 1,
        "type": "DatamartDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "New",
        "sourceAndTarget": {
          "source": "645cd81f-1b21-4006-82b6-54cc7ec0352e",
          "sourceDisplayName": "Source datamart",
          "type": "datamart"
        }
      },
      {
        "index": 2,
        "type": "DatasetDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "NoDifference",
        "sourceAndTarget": {
          "source": "1a201f2a-d1d8-45c0-8c61-1676338517de",
          "sourceDisplayName": "Source dataset",
          "target": "dd3b6aa1-4d40-405c-a19b-48314a27e8ee",
          "targetDisplayName": "Target dataset",
          "type": "dataset"
        }
      },
      {
        "index": 3,
        "type": "ReportDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "Different",
        "sourceAndTarget": {
          "source": "2d225191-65f8-4ec3-b77d-06100602b1f7",
          "sourceDisplayName": "Source report",
          "target": "9d5c1f0f-f85c-48f4-8a8e-4c77547116b3",
          "targetDisplayName": "Target report",
          "type": "report"
        }
      },
      {
        "index": 4,
        "type": "DashboardDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "New",
        "sourceAndTarget": {
          "source": "9046e4cc-8aea-4a7a-a3b5-1a78b1447d82",
          "sourceDisplayName": "Source dashboard",
          "type": "dashboard"
        }
      }
    ]
  },
  "note": {
    "content": "Sample note",
    "isTruncated": false
  },
  "preDeploymentDiffInformation": {
    "newArtifactsCount": 3,
    "differentArtifactsCount": 1,
    "noDifferenceArtifactsCount": 1
  },
  "performedBy": {
    "userPrincipalName": "john@contoso.com",
    "principalType": "User"
  }
}

Определения

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

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

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	Шаг для развертывания одного объекта datamart
DatasetDeployment	string	Шаг для развертывания одного набора данных
ReportDeployment	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	Имя участника-пользователя, выполнившего развертывание.

PreDeploymentDiffInformation

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

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

PrincipalType

Тип субъекта

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

Поделиться через