Compartilhar via

Pipelines - Update Pipeline

Serviço:
Power BI REST APIs
Versão da API:
v1.0

Atualiza 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

maxLength: 1024

A descrição atualizada do pipeline de implantação
displayName

string

maxLength: 256

O nome de exibição atualizado para o pipeline de implantação

Respostas

Nome Tipo Description
200 OK

Pipeline

OKEY

Exemplos

Update a deployment pipeline example

Solicitação de exemplo

PATCH https://api.powerbi.com/v1.0/myorg/pipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824
Corpo da solicitação
{
  "displayName": "Updated Deployment Pipeline Name",
  "description": "Updated deployment pipeline description"
}

Resposta de exemplo

Código de status:
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. É necessário um nome de exibição atualizado e/ou uma descrição.

Pipeline

Objeto

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 (uuid)

A ID do pipeline de implantação
stages

PipelineStage[]

A coleção de estágios de pipeline de implantação. Retornado somente quando $expand é definido como stages na solicitação.

PipelineStage

Objeto

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

Nome Tipo Description
order

integer

A ordem do estágio, começando a partir de zero.
workspaceId

string (uuid)

A ID do workspace atribuída. Aplicável somente quando houver 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

Objeto

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

Nome Tipo Description
description

string

maxLength: 1024

A descrição atualizada do pipeline de implantação
displayName

string

maxLength: 256

O nome de exibição atualizado para o pipeline de implantação