Pipelines - Update Pipeline

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

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

Обновляет указанный конвейер развертывания.

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

Pipeline.ReadWrite.All

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

Параметры URI

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

Текст запроса

Имя	Тип	Описание
description	string maxLength: 1024	Обновленное описание конвейера развертывания
displayName	string maxLength: 256	Обновленное отображаемое имя конвейера развертывания

Ответы

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

Примеры

Update a deployment pipeline example

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

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

Текст запроса

{
  "displayName": "Updated Deployment Pipeline Name",
  "description": "Updated deployment pipeline description"
}

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

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

{
  "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
  "displayName": "Updated Deployment Pipeline Name",
  "description": "Updated deployment pipeline description"
}

Определения

Имя	Описание
Pipeline	Конвейер Power BI
PipelineStage	Этап развертывания Power BI
UpdatePipelineRequest	Запрос на обновление существующего конвейера развертывания. Требуется обновленное отображаемое имя и (или) описание.

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	Имя назначенной рабочей области. Применимо только при наличии назначенной рабочей области и у пользователя есть доступ к рабочей области.

UpdatePipelineRequest

Object

Запрос на обновление существующего конвейера развертывания. Требуется обновленное отображаемое имя и (или) описание.

Имя	Тип	Описание
description	string maxLength: 1024	Обновленное описание конвейера развертывания
displayName	string maxLength: 256	Обновленное отображаемое имя конвейера развертывания