Pipelines - Update Pipeline

Service:

Power BI REST APIs

API Version:

v1.0

Aktualizacje określony potok wdrażania.

Zakres wymagany

Pipeline.ReadWrite.All

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
pipelineId	path	True	string uuid	Identyfikator potoku wdrażania

Treść żądania

Nazwa	Typ	Opis
description	string	Zaktualizowany opis potoku wdrażania
displayName	string	Zaktualizowana nazwa wyświetlana potoku wdrażania

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Pipeline	OK

Przykłady

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"
}

Definicje

Nazwa	Opis
Pipeline	Potok usługi Power BI
PipelineStage	Etap potoku wdrażania usługi Power BI
UpdatePipelineRequest	Żądanie zaktualizowania istniejącego potoku wdrażania. Wymagana jest zaktualizowana nazwa wyświetlana i/lub opis.

Pipeline

Potok usługi Power BI

Nazwa	Typ	Opis
description	string	Opis potoku wdrażania
displayName	string	Nazwa wyświetlana potoku wdrażania
id	string	Identyfikator potoku wdrażania
stages	PipelineStage[]	Kolekcja etapów potoku wdrażania. Zwracane tylko wtedy, gdy $expand jest ustawiona na stages wartość w żądaniu.

PipelineStage

Etap potoku wdrażania usługi Power BI

Nazwa	Typ	Opis
order	integer	Kolejność etapu, począwszy od zera.
workspaceId	string	Identyfikator przypisanego obszaru roboczego. Ma zastosowanie tylko wtedy, gdy istnieje przypisany obszar roboczy.
workspaceName	string	Przypisana nazwa obszaru roboczego. Ma zastosowanie tylko wtedy, gdy istnieje przypisany obszar roboczy, a użytkownik ma dostęp do obszaru roboczego.

UpdatePipelineRequest

Żądanie zaktualizowania istniejącego potoku wdrażania. Wymagana jest zaktualizowana nazwa wyświetlana i/lub opis.

Nazwa	Typ	Opis
description	string	Zaktualizowany opis potoku wdrażania
displayName	string	Zaktualizowana nazwa wyświetlana potoku wdrażania