Pipelines - Get Pipeline

Service:

Power BI REST APIs

API Version:

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}

With optional parameters:

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. Dá suporte a stages.

Respostas

Nome	Tipo	Description
200 OK	Pipeline	OK

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

Sample Request

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

Sample Response

Status code:

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

Sample Request

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

Sample Response

Status code:

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

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 é definido stages como na solicitação.

PipelineStage

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

Nome	Tipo	Description
order	integer	A ordem de 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.