Deployment Pipelines - Get Deployment Pipeline Operation

Служба:: Core

Версия API:: v1

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

Разрешения

Вызывающий объект должен иметь роль конвейеров развертывания администратора .

Обязательные делегированные области

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

Поддерживаемые удостоверения Microsoft Entra

Этот API поддерживает удостоверения Microsoft, перечисленные в этом разделе.

Идентичность	Поддержка
Пользователь	Да
учетные записи службы и управляемые удостоверения	Да

Интерфейс

GET https://api.fabric.microsoft.com/v1/deploymentPipelines/{deploymentPipelineId}/operations/{operationId}

Параметры URI

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

Ответы

Имя Тип Описание

200 OK

Имя	Тип	Описание
200 OK	DeploymentPipelineOperationExtendedInfo	Запрос успешно завершен.
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий `Retry-After` в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: UnknownError — произошла ошибка

DeploymentPipelineOperationExtendedInfo

Запрос успешно завершен.

429 Too Many Requests

ErrorResponse

Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий Retry-After в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов.

Заголовки

Retry-After: integer

Other Status Codes

ErrorResponse

Распространенные коды ошибок:

UnknownError — произошла ошибка

Примеры

Get a deployment pipeline operation example

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

HTTP

GET https://api.fabric.microsoft.com/v1/deploymentPipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/operations/1065e6a3-a020-4c0c-ada7-92b5fe99eec5

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

Код состояния:: 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",
  "sourceStageId": "2e6f0272-e809-410a-be63-50e1d97ba75a",
  "targetStageId": "d2056166-041c-4a56-8d37-ea90038bc0d6",
  "executionPlan": {
    "steps": [
      {
        "index": 0,
        "description": "DataflowDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "New",
        "sourceAndTarget": {
          "sourceItemId": "29efcfb0-0063-44af-a4ed-6c0bee3417d3",
          "sourceItemDisplayName": "Source dataflow",
          "itemType": "Dataflow"
        }
      },
      {
        "index": 1,
        "description": "DatamartDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "New",
        "sourceAndTarget": {
          "sourceItemId": "645cd81f-1b21-4006-82b6-54cc7ec0352e",
          "sourceItemDisplayName": "Source datamart",
          "itemType": "Datamart"
        }
      },
      {
        "index": 2,
        "description": "DatasetDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "NoDifference",
        "sourceAndTarget": {
          "sourceItemId": "1a201f2a-d1d8-45c0-8c61-1676338517de",
          "sourceItemDisplayName": "Source dataset",
          "targetItemId": "dd3b6aa1-4d40-405c-a19b-48314a27e8ee",
          "targetItemDisplayName": "Target dataset",
          "itemType": "SemanticModel"
        }
      },
      {
        "index": 3,
        "description": "ReportDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "Different",
        "sourceAndTarget": {
          "sourceItemId": "2d225191-65f8-4ec3-b77d-06100602b1f7",
          "sourceItemDisplayName": "Source report",
          "targetItemId": "9d5c1f0f-f85c-48f4-8a8e-4c77547116b3",
          "targetItemDisplayName": "Target report",
          "itemType": "Report"
        }
      },
      {
        "index": 4,
        "description": "DashboardDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "New",
        "sourceAndTarget": {
          "sourceItemId": "9046e4cc-8aea-4a7a-a3b5-1a78b1447d82",
          "sourceItemDisplayName": "Source dashboard",
          "itemType": "Dashboard"
        }
      }
    ]
  },
  "note": {
    "content": "Sample note"
  },
  "preDeploymentDiffInformation": {
    "newItemsCount": 3,
    "differentItemsCount": 1,
    "noDifferenceItemsCount": 1
  },
  "performedBy": {
    "id": "a35d842b-90d5-59a2-c56a-5f8fcff0bf9d",
    "type": "User"
  }
}

Определения

Имя	Описание
DeploymentExecutionPlan	План выполнения развертывания.
DeploymentExecutionStep	Шаг выполнения развертывания.
DeploymentPipelineOperationExtendedInfo	Операция конвейера развертывания Fabric.
DeploymentPipelineOperationNote	Примечание, описывающее развертывание.
DeploymentPipelineOperationStatus	Состояние операции конвейера развертывания. С течением времени могут добавляться дополнительные состояния.
DeploymentPipelineOperationType	Тип операции. С течением времени могут добавляться дополнительные типы.
DeploymentSourceAndTarget	Исходные и целевые элементы.
EntireTenantPrincipal	Представляет субъект клиента
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
GroupDetails	Группировка конкретных сведений. Применимо, если тип субъекта `Group`.
GroupPrincipal	Представляет группу безопасности.
GroupType	Тип группы. С течением времени могут добавляться дополнительные типы групп.
ItemPreDeploymentDiffState	Указывает, является ли элемент новым, другим или идентичным элементам на целевом этапе перед развертыванием. С течением времени могут добавляться дополнительные состояния.
ItemType	Тип элемента. С течением времени могут добавляться дополнительные типы элементов.
PreDeploymentDiffInformation	Количество новых, разных и идентичных развернутых элементов перед развертыванием.
PrincipalType	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.
ServicePrincipalDetails	Сведения о субъекте-службе. Применимо, если тип субъекта `ServicePrincipal`.
ServicePrincipalPrincipal	Представляет субъект-службу Microsoft Entra.
ServicePrincipalProfileDetails	Сведения о профиле субъекта-службы. Применимо, если тип субъекта `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Представляет профиль субъекта-службы.
UserDetails	Сведения о субъекте-пользователе. Применимо, если тип субъекта `User`.
UserPrincipal	Представляет субъект пользователя Microsoft Entra.

DeploymentExecutionPlan

Объект

План выполнения развертывания.

Имя	Тип	Описание
steps	DeploymentExecutionStep[]	Коллекция шагов плана выполнения.

DeploymentExecutionStep

Объект

Шаг выполнения развертывания.

Имя	Тип	Описание
description	string	Описание шага развертывания.
error	ErrorResponse	Сведения об ошибке. Применимо только в случае сбоя операции конвейера развертывания.
index	integer	Индекс шага.
preDeploymentDiffState	ItemPreDeploymentDiffState	Представляет собой новый элемент, другой или идентичный элементам на целевом этапе перед развертыванием.
sourceAndTarget	DeploymentSourceAndTarget	Исходные и целевые элементы шага.
status	DeploymentPipelineOperationStatus	Состояние операции конвейера развертывания. С течением времени могут добавляться дополнительные состояния.

DeploymentPipelineOperationExtendedInfo

Объект

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

Имя	Тип	Описание
executionEndTime	string (date-time)	Дата и время завершения операции.
executionPlan	DeploymentExecutionPlan	План выполнения развертывания.
executionStartTime	string (date-time)	Дата и время запуска операции.
id	string (uuid)	Идентификатор операции.
lastUpdatedTime	string (date-time)	Дата и время последнего обновления операции.
note	DeploymentPipelineOperationNote	Примечание, представляющее описание операции.
performedBy	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Субъект, выполняющий операцию конвейера развертывания.
preDeploymentDiffInformation	PreDeploymentDiffInformation	Количество развернутых элементов на исходном этапе, которые являются новыми, идентичными или разными элементами на целевом этапе перед развертыванием.
sourceStageId	string (uuid)	Идентификатор этапа конвейера развертывания источника.
status	DeploymentPipelineOperationStatus	Состояние операции конвейера развертывания. С течением времени могут добавляться дополнительные состояния.
targetStageId	string (uuid)	Идентификатор этапа целевого конвейера развертывания.
type	DeploymentPipelineOperationType	Тип операции. С течением времени могут добавляться дополнительные типы.

DeploymentPipelineOperationNote

Объект

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

Имя	Тип	Описание
content	string	Текст, описывающий развертывание.
isTruncated	boolean	Указывает, усечено ли содержимое заметки. True — содержимое заметки усечено, false — содержимое заметки не усечено. Значение по умолчанию — false.

DeploymentPipelineOperationStatus

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

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

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

DeploymentPipelineOperationType

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

Тип операции. С течением времени могут добавляться дополнительные типы.

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

DeploymentSourceAndTarget

Объект

Исходные и целевые элементы.

Имя	Тип	Описание
itemType	ItemType	Тип элемента Fabric, который будет перезаписан на целевом этапе. Применяется только при перезаписи элемента Fabric.
sourceItemDisplayName	string	Отображаемое имя элемента Fabric, развернутого на исходном этапе.
sourceItemId	string (uuid)	Идентификатор элемента Fabric, развернутого на исходном этапе.
targetItemDisplayName	string	Имя элемента Fabric, который будет перезаписан на целевом этапе. Применяется только при перезаписи элемента Fabric.
targetItemId	string (uuid)	Идентификатор элемента Fabric, который будет перезаписан на целевом этапе. Применяется только при перезаписи элемента Fabric.

EntireTenantPrincipal

Объект

Представляет субъект клиента

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта.
id	string (uuid)	Идентификатор субъекта.
type	string: EntireTenant	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.

ErrorRelatedResource

Объект

Объект сведений об ошибках, связанных с ресурсом.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

Ответ на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
isRetriable	boolean	Если задано значение true, запрос можно получить. `Retry-After` Используйте заголовок ответа, чтобы определить задержку, если она доступна.
message	string	Удобочитаемое представление ошибки.
moreDetails	ErrorResponseDetails[]	Список дополнительных сведений об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.
requestId	string (uuid)	Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

Сведения об ответе на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.

GroupDetails

Объект

Группировка конкретных сведений. Применимо, если тип субъекта Group.

Имя	Тип	Описание
groupType	GroupType	Тип группы. С течением времени могут добавляться дополнительные типы групп.

GroupPrincipal

Объект

Представляет группу безопасности.

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта.
groupDetails	GroupDetails	Группировка конкретных сведений. Применимо, если тип субъекта `Group`.
id	string (uuid)	Идентификатор субъекта.
type	string: Group	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.

GroupType

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

Тип группы. С течением времени могут добавляться дополнительные типы групп.

Значение	Описание
Unknown	Тип основной группы неизвестен.
SecurityGroup	Субъект — это группа безопасности.
DistributionList	Субъект — это список рассылки.

ItemPreDeploymentDiffState

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

Указывает, является ли элемент новым, другим или идентичным элементам на целевом этапе перед развертыванием. С течением времени могут добавляться дополнительные состояния.

Значение	Описание
New	Новый развернутый элемент, который не существует на целевом этапе.
Different	Перед развертыванием элемент на исходном этапе не был идентичен одному на целевом этапе.
NoDifference	Перед развертыванием элемент на исходном этапе был идентичен одному на целевом этапе.

ItemType

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

Тип элемента. С течением времени могут добавляться дополнительные типы элементов.

Значение	Описание
Dashboard	Панель мониторинга PowerBI.
Report	Отчет PowerBI.
SemanticModel	Семантическая модель PowerBI.
PaginatedReport	Отчет с разбивкой на страницы PowerBI.
Datamart	Datamart PowerBI.
Lakehouse	Озеро.
Eventhouse	Хранилище событий.
Environment	Среда.
KQLDatabase	База данных KQL.
KQLQueryset	Набор запросов KQL.
KQLDashboard	Панель мониторинга KQL.
DataPipeline	Конвейер данных.
Notebook	Записная книжка.
SparkJobDefinition	Определение задания Spark.
MLExperiment	Эксперимент машинного обучения.
MLModel	Модель машинного обучения.
Warehouse	Склад.
Eventstream	Поток событий.
SQLEndpoint	Конечная точка SQL.
MirroredWarehouse	Зеркальный склад.
MirroredDatabase	Зеркальная база данных.
Reflex	Рефлекс.
GraphQLApi	API для элемента GraphQL.
MountedDataFactory	ПодключеннаяdataFactory.
SQLDatabase	База данных SQLDatabase.
CopyJob	Задание копирования.
VariableLibrary	ПеременнаяLibrary.
Dataflow	Поток данных.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Моментальный снимок хранилища.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Поток Конструктора цифровых двойников.
MirroredAzureDatabricksCatalog	Зеркальный каталог azure databricks.
Map	Карта.
AnomalyDetector	Детектор аномалий.
UserDataFunction	Функция данных пользователя.
GraphModel	A GraphModel.
GraphQuerySet	Набор запросов Graph.
SnowflakeDatabase	База данных Snowflake для хранения таблиц Iceberg, созданных из учетной записи Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	База данных Cosmos DB.
Ontology	An Ontology.
EventSchemaSet	An EventSchemaSet.
DataAgent	A DataAgent.
MirroredCatalog	ЗеркальныйCatalog.

PreDeploymentDiffInformation

Объект

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

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

PrincipalType

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

Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.

Значение	Описание
User	Субъект является субъектом-пользователем Microsoft Entra.
ServicePrincipal	Субъект является субъектом-службой Microsoft Entra.
Group	Субъект — это группа безопасности.
ServicePrincipalProfile	Субъект — это профиль субъекта-службы.
EntireTenant	Субъект представляет всех пользователей клиента.

ServicePrincipalDetails

Объект

Сведения о субъекте-службе. Применимо, если тип субъекта ServicePrincipal.

Имя	Тип	Описание
aadAppId	string (uuid)	Microsoft Entra AppId субъекта-службы.

ServicePrincipalPrincipal

Объект

Представляет субъект-службу Microsoft Entra.

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта.
id	string (uuid)	Идентификатор субъекта.
servicePrincipalDetails	ServicePrincipalDetails	Сведения о субъекте-службе. Применимо, если тип субъекта `ServicePrincipal`.
type	string: ServicePrincipal	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.

ServicePrincipalProfileDetails

Объект

Сведения о профиле субъекта-службы. Применимо, если тип субъекта ServicePrincipalProfile.

Имя	Тип	Описание
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Родительский субъект профиля субъекта-службы.

ServicePrincipalProfilePrincipal

Объект

Представляет профиль субъекта-службы.

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта.
id	string (uuid)	Идентификатор субъекта.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Сведения о профиле субъекта-службы. Применимо, если тип субъекта `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.

UserDetails

Объект

Сведения о субъекте-пользователе. Применимо, если тип субъекта User.

Имя	Тип	Описание
userPrincipalName	string	Основное имя пользователя.

UserPrincipal

Объект

Представляет субъект пользователя Microsoft Entra.

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта.
id	string (uuid)	Идентификатор субъекта.
type	string: User	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.
userDetails	UserDetails	Сведения о субъекте-пользователе. Применимо, если тип субъекта `User`.