Pipelines - Update Pipeline

Ссылка

Service:: Power BI REST APIs

API Version:: v1.0

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

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

Pipeline.ReadWrite.All

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

Параметры URI

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

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

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

Ответы

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

Примеры

Update a deployment pipeline example

Sample Request

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

Request Body

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

Sample Response

Status code:: 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

Конвейер Power BI

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

PipelineStage

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

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

UpdatePipelineRequest

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

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

Поделиться через