Pipelines - Get Pipeline

Servizio:

Power BI REST APIs

Versione API:

v1.0

Restituisce la pipeline di distribuzione specificata.

Ambito obbligatorio

Pipeline.ReadWrite.All o Pipeline.Read.All

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
pipelineId	path	True	string uuid	ID della pipeline di distribuzione
$expand	query		string	Accetta un elenco delimitato da virgole dei tipi di dati, che verrà espanso inline nella risposta. Supporta stages.

Risposte

Nome	Tipo	Descrizione
200 OK	Pipeline	OK

Esempio

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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

200

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

Definizioni

Nome	Descrizione
Pipeline	Pipeline di Power BI
PipelineStage	Fase della pipeline di distribuzione di Power BI

Pipeline

Object

Pipeline di Power BI

Nome	Tipo	Descrizione
description	string	Descrizione della pipeline di distribuzione
displayName	string	Nome visualizzato della pipeline di distribuzione
id	string	ID della pipeline di distribuzione
stages	PipelineStage[]	Raccolta di fasi della pipeline di distribuzione. Restituito solo quando $expand è impostato su stages nella richiesta.

PipelineStage

Object

Fase della pipeline di distribuzione di Power BI

Nome	Tipo	Descrizione
order	integer	Ordine di fase, a partire da zero.
workspaceId	string	ID area di lavoro assegnata. Applicabile solo quando è presente un'area di lavoro assegnata.
workspaceName	string	Nome dell'area di lavoro assegnato. Applicabile solo quando è presente un'area di lavoro assegnata e l'utente ha accesso all'area di lavoro.