Pipelines - Get Pipeline

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

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

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

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

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

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

С использованием необязательных параметров:

GET https://api.powerbi.com/v1.0/myorg/pipelines/{pipelineId}?$expand={$expand}

Параметры URI

Имя	В	Обязательно	Тип	Описание
pipelineId	path	True	string (uuid)	Идентификатор конвейера развертывания
$expand	query		string	Принимает разделенный запятыми список типов данных, который будет развернут встроенным в ответе. Поддерживает `stages`.

Ответы

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

Примеры

Get a deployment pipeline with its 'stages' expanded example

Get a deployment pipeline without its 'stages' expanded example

Get a deployment pipeline with its 'stages' expanded example

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

GET https://api.powerbi.com/v1.0/myorg/pipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824?$expand=stages

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

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

{
  "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
  "displayName": "My Deployment Pipeline",
  "description": "My deployment pipeline",
  "stages": [
    {
      "order": 0,
      "workspaceId": "4de5bcc4-2c88-4efe-b827-4ee7b289b496",
      "workspaceName": "Workspace-Development"
    },
    {
      "order": 1,
      "workspaceId": "44b499cf-1eeb-45e2-9ada-63b6ec9d516e"
    },
    {
      "order": 2
    }
  ]
}

Get a deployment pipeline without its 'stages' expanded example

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

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

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

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

{
  "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
  "displayName": "Marketing Deployment Pipeline",
  "description": "Power BI deployment pipeline to manage marketing reports"
}

Определения

Имя	Описание
Pipeline	Конвейер Power BI
PipelineStage	Этап развертывания Power BI

Pipeline

Object

Конвейер Power BI

Имя	Тип	Описание
description	string	Описание конвейера развертывания
displayName	string	Отображаемое имя конвейера развертывания
id	string (uuid)	Идентификатор конвейера развертывания
stages	PipelineStage[]	Коллекция этапов конвейера развертывания. Возвращается только в том случае, если `$expand` задано значение `stages` в запросе.

PipelineStage

Object

Этап развертывания Power BI

Имя	Тип	Описание
order	integer	Порядок этапов, начиная с нуля.
workspaceId	string (uuid)	Идентификатор назначенной рабочей области. Применимо только при наличии назначенной рабочей области.
workspaceName	string	Имя назначенной рабочей области. Применимо только при наличии назначенной рабочей области и у пользователя есть доступ к рабочей области.