Pipelines - Update Pipeline

Service:

Power BI REST APIs

API Version:

v1.0

Aggiornamenti la pipeline di distribuzione specificata.

Ambito obbligatorio

Pipeline.ReadWrite.All

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
pipelineId	path	True	string uuid	ID della pipeline di distribuzione

Corpo della richiesta

Nome	Tipo	Descrizione
description	string	Descrizione aggiornata per la pipeline di distribuzione
displayName	string	Nome visualizzato aggiornato per la pipeline di distribuzione

Risposte

Nome	Tipo	Descrizione
200 OK	Pipeline	OK

Esempio

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

Definizioni

Nome	Descrizione
Pipeline	Pipeline di Power BI
PipelineStage	Fase della pipeline di distribuzione di Power BI
UpdatePipelineRequest	Richiesta di aggiornamento di una pipeline di distribuzione esistente. È necessario un nome visualizzato aggiornato e/o una descrizione.

Pipeline

Pipeline di Power BI

Nome	Tipo	Descrizione
description	string	Descrizione della pipeline di distribuzione
displayName	string	Nome visualizzato della pipeline di distribuzione
id	string	ID della pipeline di distribuzione
stages	PipelineStage[]	Raccolta di fasi della pipeline di distribuzione. Restituito solo quando $expand è impostato su stages nella richiesta.

PipelineStage

Fase della pipeline di distribuzione di Power BI

Nome	Tipo	Descrizione
order	integer	Ordine di fase, a partire da zero.
workspaceId	string	ID area di lavoro assegnata. Applicabile solo quando è presente un'area di lavoro assegnata.
workspaceName	string	Nome dell'area di lavoro assegnato. Applicabile solo quando è presente un'area di lavoro assegnata e l'utente ha accesso all'area di lavoro.

UpdatePipelineRequest

Richiesta di aggiornamento di una pipeline di distribuzione esistente. È necessario un nome visualizzato aggiornato e/o una descrizione.

Nome	Tipo	Descrizione
description	string	Descrizione aggiornata per la pipeline di distribuzione
displayName	string	Nome visualizzato aggiornato per la pipeline di distribuzione