Pipelines - Get Pipeline

Service:

Power BI REST APIs

API Version:

v1.0

Zwraca określony potok wdrażania.

Zakres wymagany

Pipeline.ReadWrite.All lub 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}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
pipelineId	path	True	string uuid	Identyfikator potoku wdrażania
$expand	query		string	Akceptuje rozdzielaną przecinkami listę typów danych, które zostaną rozwinięte w tekście w odpowiedzi. Obsługuje funkcję stages.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Pipeline	OK

Przykłady

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"
}

Definicje

Nazwa	Opis
Pipeline	Potok usługi Power BI
PipelineStage	Etap potoku wdrażania usługi Power BI

Pipeline

Potok usługi Power BI

Nazwa	Typ	Opis
description	string	Opis potoku wdrażania
displayName	string	Nazwa wyświetlana potoku wdrażania
id	string	Identyfikator potoku wdrażania
stages	PipelineStage[]	Kolekcja etapów potoku wdrażania. Zwracane tylko wtedy, gdy $expand jest ustawiona na stages wartość w żądaniu.

PipelineStage

Etap potoku wdrażania usługi Power BI

Nazwa	Typ	Opis
order	integer	Kolejność etapu, począwszy od zera.
workspaceId	string	Identyfikator przypisanego obszaru roboczego. Ma zastosowanie tylko wtedy, gdy istnieje przypisany obszar roboczy.
workspaceName	string	Przypisana nazwa obszaru roboczego. Ma zastosowanie tylko wtedy, gdy istnieje przypisany obszar roboczy, a użytkownik ma dostęp do obszaru roboczego.