Compartilhar via

Pipelines - Get Pipeline

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

Retorna o pipeline de implantação especificado.

Escopo necessário

Pipeline.ReadWrite.All ou Pipeline.Read.All 

GET https://api.powerbi.com/v1.0/myorg/pipelines/{pipelineId}
Com parâmetros opcionais: 
GET https://api.powerbi.com/v1.0/myorg/pipelines/{pipelineId}?$expand={$expand}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
pipelineId
 path True

string (uuid)

A ID do pipeline de implantação
$expand
 query

string

Aceita uma lista separada por vírgulas de tipos de dados, que será expandida embutida na resposta. Suporta stages.

Respostas

Nome Tipo Description
200 OK

Pipeline

OKEY

Exemplos

Get a deployment pipeline with its 'stages' expanded example
Get a deployment pipeline without its 'stages' expanded example

Get a deployment pipeline with its 'stages' expanded example

Solicitação de exemplo

GET https://api.powerbi.com/v1.0/myorg/pipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824?$expand=stages

Resposta de exemplo

Código de status:
200 
{
  "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
  "displayName": "My Deployment Pipeline",
  "description": "My deployment pipeline",
  "stages": [
    {
      "order": 0,
      "workspaceId": "4de5bcc4-2c88-4efe-b827-4ee7b289b496",
      "workspaceName": "Workspace-Development"
    },
    {
      "order": 1,
      "workspaceId": "44b499cf-1eeb-45e2-9ada-63b6ec9d516e"
    },
    {
      "order": 2
    }
  ]
}

Get a deployment pipeline without its 'stages' expanded example

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
200 
{
  "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
  "displayName": "Marketing Deployment Pipeline",
  "description": "Power BI deployment pipeline to manage marketing reports"
}

Definições

Nome Description
Pipeline

Um pipeline do Power BI
PipelineStage

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

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.