Pipelines - Get Pipeline

Dienst:

Power BI REST APIs

API-Version:

v1.0

Gibt die angegebene Bereitstellungspipeline zurück.

Erforderlicher Bereich

Pipeline.ReadWrite.All oder Pipeline.Read.All

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

Mit optionalen Parametern:

GET https://api.powerbi.com/v1.0/myorg/pipelines/{pipelineId}?$expand={$expand}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
pipelineId	path	True	string uuid	Die Bereitstellungspipeline-ID
$expand	query		string	Akzeptiert eine durch Trennzeichen getrennte Liste von Datentypen, die inline in der Antwort erweitert werden. Unterstützt stages

Antworten

Name	Typ	Beschreibung
200 OK	Pipeline	OK

Beispiele

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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

200

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

Definitionen

Name	Beschreibung
Pipeline	Eine Power BI-Pipeline
PipelineStage	Eine Power BI-Bereitstellungspipelinephase

Pipeline

Object

Eine Power BI-Pipeline

Name	Typ	Beschreibung
description	string	Beschreibung der Bereitstellungspipeline
displayName	string	Anzeigename der Bereitstellungspipeline
id	string	Die Bereitstellungspipeline-ID
stages	PipelineStage[]	Die Sammlung der Bereitstellungspipelinephasen. Wird nur zurückgegeben, wenn $expand in der Anforderung festgelegt stages ist.

PipelineStage

Object

Eine Power BI-Bereitstellungspipelinephase

Name	Typ	Beschreibung
order	integer	Die Phasenreihenfolge, beginnend mit null.
workspaceId	string	Die zugewiesene Arbeitsbereichs-ID. Gilt nur, wenn ein zugewiesener Arbeitsbereich vorhanden ist.
workspaceName	string	Der zugewiesene Arbeitsbereichsname. Gilt nur, wenn ein zugewiesener Arbeitsbereich vorhanden ist und der Benutzer Zugriff auf den Arbeitsbereich hat.