Pipelines - Update Pipeline

Service:

Power BI REST APIs

API Version:

v1.0

Atualizações o pipeline de implantação especificado.

Escopo necessário

Pipeline.ReadWrite.All

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
pipelineId	path	True	string uuid	A ID do pipeline de implantação

Corpo da solicitação

Nome	Tipo	Description
description	string	A descrição atualizada do pipeline de implantação
displayName	string	O nome de exibição atualizado para o pipeline de implantação

Respostas

Nome	Tipo	Description
200 OK	Pipeline	OK

Exemplos

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

Definições

Nome	Description
Pipeline	Um pipeline do Power BI
PipelineStage	Um estágio de pipeline de implantação do Power BI
UpdatePipelineRequest	Uma solicitação para atualizar um pipeline de implantação existente. Um nome de exibição atualizado e/ou uma descrição são necessários.

Pipeline

Um pipeline do Power BI

Nome	Tipo	Description
description	string	A descrição do pipeline de implantação
displayName	string	O nome de exibição do pipeline de implantação
id	string	A ID do pipeline de implantação
stages	PipelineStage[]	A coleção de estágios de pipeline de implantação. Retornado somente quando $expand está definido stages na solicitação.

PipelineStage

Um estágio de pipeline de implantação do Power BI

Nome	Tipo	Description
order	integer	A ordem do estágio, começando do zero.
workspaceId	string	A ID do workspace atribuída. Aplicável somente quando há um workspace atribuído.
workspaceName	string	O nome do workspace atribuído. Aplicável somente quando há um workspace atribuído e o usuário tem acesso ao workspace.

UpdatePipelineRequest

Uma solicitação para atualizar um pipeline de implantação existente. Um nome de exibição atualizado e/ou uma descrição são necessários.

Nome	Tipo	Description
description	string	A descrição atualizada do pipeline de implantação
displayName	string	O nome de exibição atualizado para o pipeline de implantação