Deployment Pipelines - Get Deployment Pipeline

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

Возвращает указанные метаданные конвейера развертывания.

Разрешения

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

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

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

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

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

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

Интерфейс

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

Параметры URI

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

string (uuid)

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

Ответы

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

DeploymentPipelineExtendedInfo

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

ErrorResponse

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

Заголовки

Retry-After: integer
Other Status Codes

ErrorResponse

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

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

Примеры

Get a deployment pipeline example

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

GET https://api.fabric.microsoft.com/v1/deploymentPipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824

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

Код состояния:
200 
{
  "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
  "displayName": "Marketing Deployment Pipeline",
  "description": "Fabric deployment pipeline to manage marketing reports",
  "stages": [
    {
      "id": "2e6f0272-e809-410a-be63-50e1d97ba75a",
      "order": 0,
      "displayName": "Development",
      "description": "Design, review, and revise your content in a development workspace. When it's ready to test and preview, deploy the content to the test stage.",
      "workspaceId": "4de5bcc4-2c88-4efe-b827-4ee7b289b496",
      "workspaceName": "Workpsace-Development",
      "isPublic": false
    },
    {
      "id": "d2056166-041c-4a56-8d37-ea90038bc0d6",
      "order": 1,
      "displayName": "Test",
      "description": "Test and verify your content in a preproduction workspace. When it's ready, deploy the content to the production stage.",
      "workspaceId": "44b499cf-1eeb-45e2-9ada-63b6ec9d516e",
      "isPublic": false
    },
    {
      "id": "4c3eb03b-fbbb-4605-9b1a-6fba1003679e",
      "order": 2,
      "displayName": "Production",
      "description": "Your content has been tested and is ready for your customers as an app or by access to the production workspace.",
      "isPublic": true
    }
  ]
}

Определения

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

Конвейер развертывания Fabric.
DeploymentPipelineStage

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

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

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

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

DeploymentPipelineExtendedInfo

Объект

Конвейер развертывания Fabric.

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

string

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

string

Отображаемое имя конвейера развертывания.
id

string (uuid)

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

DeploymentPipelineStage[]

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

DeploymentPipelineStage

Объект

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

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

string

Описание этапа конвейера развертывания.
displayName

string

Отображаемое имя этапа конвейера развертывания.
id

string (uuid)

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

boolean

Указывает, является ли этап конвейера развертывания общедоступным. True - этап является общедоступным, False - этап не является общедоступным.
order

integer

Порядок этапов, начиная с нуля.
workspaceId

string (uuid)

Идентификатор назначенной рабочей области. Применимо только при наличии назначенной рабочей области.
workspaceName

string

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

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

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