Deployment Pipelines - List Deployment Pipeline Operations

Служба:
Core
Версия API:
v1

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

Разрешения

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

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

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

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

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

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

Интерфейс

GET https://api.fabric.microsoft.com/v1/deploymentPipelines/{deploymentPipelineId}/operations
С использованием необязательных параметров: 
GET https://api.fabric.microsoft.com/v1/deploymentPipelines/{deploymentPipelineId}/operations?continuationToken={continuationToken}

Параметры URI

Имя В Обязательно Тип Описание
deploymentPipelineId
 path True

string (uuid)

Идентификатор конвейера развертывания.
continuationToken
 query

string

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

Ответы

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

DeploymentPipelineOperations

Запрос успешно завершен.
429 Too Many Requests

ErrorResponse

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

Заголовки

Retry-After: integer
Other Status Codes

ErrorResponse

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

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

Примеры

List deployment pipeline operations example
List deployment pipeline operations with continuation example

List deployment pipeline operations example

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

GET https://api.fabric.microsoft.com/v1/deploymentPipelines/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",
      "sourceStageId": "2e6f0272-e809-410a-be63-50e1d97ba75a",
      "targetStageId": "d2056166-041c-4a56-8d37-ea90038bc0d6",
      "note": {
        "content": "Sample note"
      },
      "preDeploymentDiffInformation": {
        "newItemsCount": 0,
        "differentItemsCount": 0,
        "noDifferenceItemsCount": 1
      },
      "performedBy": {
        "id": "a35d842b-90d5-59a2-c56a-5f8fcff0bf9d",
        "type": "User"
      }
    },
    {
      "id": "7e113010-3264-41e4-93c1-1dfb34a93d06",
      "type": "Deploy",
      "status": "Failed",
      "lastUpdatedTime": "2020-12-14T09:26:43.153",
      "executionStartTime": "2020-12-14T09:25:43.153Z",
      "executionEndTime": "2020-12-13T09:26:43.153Z",
      "sourceStageId": "2e6f0272-e809-410a-be63-50e1d97ba75a",
      "targetStageId": "d2056166-041c-4a56-8d37-ea90038bc0d6",
      "note": {
        "content": "Lorem ipsum odor amet, consectetuer adipiscing elit. Himenaeos litora volutpat sem eget ipsum sollicitudin ad porta ligula tristique sapien suscipit magnis pulvinar placerat in vulputate aliquam mauris aptent velit phasellus netus fringilla ad taciti in himenaeos eu vitae feugiat et auctor class maximus urna integer erat amet efficitur ex tellus conubia lorem nam viverra cras magnis potenti pharetra natoque suscipit scelerisque eros adipiscing mollis sagittis habitasse ligula nullam rhoncus at scelerisque justo dolor pretium libero urna massa tristique diam viverra aenean mauris malesuada mus sed ultrices consectetur tristique pretium imperdiet vulputate ligula senectus pretium aenean inceptos id cras magna ut nisl etiam eget magna nibh feugiat duis imperdiet ut ornare arcu primis curae taciti purus quisque turpis lacus auctor ligula tristique placerat consectetur mus vitae penatibus varius proin ligula viverra diam neque at tortor porttitor urna ullamcorper ut nec lobortis porta urna egestas eu cursus ante ",
        "isTruncated": true
      },
      "preDeploymentDiffInformation": {
        "newItemsCount": 1,
        "differentItemsCount": 0,
        "noDifferenceItemsCount": 0
      },
      "performedBy": {
        "id": "a35d842b-90d5-59a2-c56a-5f8fcff0bf9d",
        "type": "User"
      }
    }
  ]
}

List deployment pipeline operations with continuation example

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

GET https://api.fabric.microsoft.com/v1/deploymentPipelines/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",
      "sourceStageId": "2e6f0272-e809-410a-be63-50e1d97ba75a",
      "targetStageId": "d2056166-041c-4a56-8d37-ea90038bc0d6",
      "note": {
        "content": "Sample note"
      },
      "preDeploymentDiffInformation": {
        "newItemsCount": 0,
        "differentItemsCount": 0,
        "noDifferenceItemsCount": 1
      },
      "performedBy": {
        "id": "a35d842b-90d5-59a2-c56a-5f8fcff0bf9d",
        "type": "User"
      }
    },
    {
      "id": "7e113010-3264-41e4-93c1-1dfb34a93d06",
      "type": "Deploy",
      "status": "Failed",
      "lastUpdatedTime": "2020-12-14T09:26:43.153",
      "executionStartTime": "2020-12-14T09:25:43.153Z",
      "executionEndTime": "2020-12-13T09:26:43.153Z",
      "sourceStageId": "2e6f0272-e809-410a-be63-50e1d97ba75a",
      "targetStageId": "d2056166-041c-4a56-8d37-ea90038bc0d6",
      "note": {
        "content": "Lorem ipsum odor amet, consectetuer adipiscing elit. Himenaeos litora volutpat sem eget ipsum sollicitudin ad porta ligula tristique sapien suscipit magnis pulvinar placerat in vulputate aliquam mauris aptent velit phasellus netus fringilla ad taciti in himenaeos eu vitae feugiat et auctor class maximus urna integer erat amet efficitur ex tellus conubia lorem nam viverra cras magnis potenti pharetra natoque suscipit scelerisque eros adipiscing mollis sagittis habitasse ligula nullam rhoncus at scelerisque justo dolor pretium libero urna massa tristique diam viverra aenean mauris malesuada mus sed ultrices consectetur tristique pretium imperdiet vulputate ligula senectus pretium aenean inceptos id cras magna ut nisl etiam eget magna nibh feugiat duis imperdiet ut ornare arcu primis curae taciti purus quisque turpis lacus auctor ligula tristique placerat consectetur mus vitae penatibus varius proin ligula viverra diam neque at tortor porttitor urna ullamcorper ut nec lobortis porta urna egestas eu cursus ante ",
        "isTruncated": true
      },
      "preDeploymentDiffInformation": {
        "newItemsCount": 1,
        "differentItemsCount": 0,
        "noDifferenceItemsCount": 0
      },
      "performedBy": {
        "id": "a35d842b-90d5-59a2-c56a-5f8fcff0bf9d",
        "type": "User"
      }
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/deploymentPipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/operations?continuationToken=LDEsMTAwMDAwLDA%3D"
}

Определения

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

DeploymentPipelineOperation

Объект

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

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

string (date-time)

Дата и время завершения операции.
executionStartTime

string (date-time)

Дата и время запуска операции.
id

string (uuid)

Идентификатор операции.
lastUpdatedTime

string (date-time)

Дата и время последнего обновления операции.
note

DeploymentPipelineOperationNote

Примечание, представляющее описание операции.
performedBy Principal:

Субъект, выполняющий операцию конвейера развертывания.
preDeploymentDiffInformation

PreDeploymentDiffInformation

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

string (uuid)

Идентификатор этапа конвейера развертывания источника.
status

DeploymentPipelineOperationStatus

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

string (uuid)

Идентификатор этапа целевого конвейера развертывания.
type

DeploymentPipelineOperationType

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

DeploymentPipelineOperationNote

Объект

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

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

string

Текст, описывающий развертывание.
isTruncated

boolean

Указывает, усечено ли содержимое заметки. True — содержимое заметки усечено, false — содержимое заметки не усечено. Значение по умолчанию — false.

DeploymentPipelineOperations

Объект

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

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

string

Маркер для следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.
continuationUri

string

Универсальный код ресурса (URI) следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.
value

DeploymentPipelineOperation[]

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

DeploymentPipelineOperationStatus

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

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

Значение Описание
NotStarted

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

Выполняется операция конвейера развертывания.
Succeeded

Операция конвейера развертывания завершилась успешно.
Failed

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

DeploymentPipelineOperationType

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

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

Значение Описание
Deploy

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

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

Субъект — это список рассылки.

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:

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

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.