Pipelines - Get Pipeline

Service:

Power BI REST APIs

API Version:

v1.0

Vrátí zadaný kanál nasazení.

Požadovaný obor

Pipeline.ReadWrite.All nebo 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 identifikátoru URI

Name	V	Vyžadováno	Typ	Description
pipelineId	path	True	string uuid	ID kanálu nasazení
$expand	query		string	Přijímá seznam datových typů oddělených čárkami, který se v odpovědi rozbalí. Podporuje stages.

Odpovědi

Name	Typ	Description
200 OK	Pipeline	OK

Příklady

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

Definice

Name	Description
Pipeline	Kanál Power BI
PipelineStage	Fáze kanálu nasazení Power BI

Pipeline

Kanál Power BI

Name	Typ	Description
description	string	Popis kanálu nasazení
displayName	string	Zobrazovaný název kanálu nasazení
id	string	ID kanálu nasazení
stages	PipelineStage[]	Kolekce fází kanálu nasazení. Vráceno pouze v případě, že $expand je v požadavku nastaveno stages .

PipelineStage

Fáze kanálu nasazení Power BI

Name	Typ	Description
order	integer	Pořadí fází počínaje nulou.
workspaceId	string	ID přiřazeného pracovního prostoru. Platí jenom v případě, že je přiřazený pracovní prostor.
workspaceName	string	Název přiřazeného pracovního prostoru. Platí jenom v případě, že je přiřazený pracovní prostor a uživatel má přístup k pracovnímu prostoru.