Compartir a través de

Pipelines - Get Pipeline

  • Referencia
Servicio:
Power BI REST APIs
Versión de la API:
v1.0

Devuelve la canalización de implementación especificada.

Ámbito requerido

Pipeline.ReadWrite.All o Pipeline.Read.All

GET https://api.powerbi.com/v1.0/myorg/pipelines/{pipelineId}
Con parámetros opcionales: 
GET https://api.powerbi.com/v1.0/myorg/pipelines/{pipelineId}?$expand={$expand}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
pipelineId
 path True

string

uuid

Identificador de canalización de implementación
$expand
 query

string

Acepta una lista separada por comas de tipos de datos, que se expandirán en línea en la respuesta. admite stages.

Respuestas

Nombre Tipo Description
200 OK

Pipeline

Aceptar

Ejemplos

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

Solicitud de ejemplo

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

Respuesta de muestra

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

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre Description
Pipeline

Una canalización de Power BI
PipelineStage

Una fase de canalización de implementación de Power BI

Pipeline

Object

Una canalización de Power BI

Nombre Tipo Description
description

string

Descripción de la canalización de implementación
displayName

string

El nombre para mostrar de la canalización de implementación
id

string

Identificador de canalización de implementación
stages

PipelineStage[]

Colección de fases de canalización de implementación. Solo se devuelve cuando $expand se establece stages en en la solicitud.

PipelineStage

Object

Una fase de canalización de implementación de Power BI

Nombre Tipo Description
order

integer

Orden de fase, a partir de cero.
workspaceId

string

Identificador del área de trabajo asignada. Solo es aplicable cuando hay un área de trabajo asignada.
workspaceName

string

Nombre del área de trabajo asignada. Solo es aplicable cuando hay un área de trabajo asignada y el usuario tiene acceso al área de trabajo.