Pipelines - Get Pipeline

Service:

Power BI REST APIs

API Version:

v1.0

Retourne le pipeline de déploiement spécifié.

Étendue requise

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
pipelineId	path	True	string uuid	ID du pipeline de déploiement
$expand	query		string	Accepte une liste séparée par des virgules de types de données, qui sera développée en ligne dans la réponse. Prise en charge de stages.

Réponses

Nom	Type	Description
200 OK	Pipeline	Ok

Exemples

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

Définitions

Nom	Description
Pipeline	Un pipeline Power BI
PipelineStage	Étape de pipeline de déploiement Power BI

Pipeline

Un pipeline Power BI

Nom	Type	Description
description	string	Description du pipeline de déploiement
displayName	string	Nom complet du pipeline de déploiement
id	string	ID du pipeline de déploiement
stages	PipelineStage[]	Collection d’étapes de pipeline de déploiement. Retourné uniquement lorsqu’il $expand est défini stages dans la requête.

PipelineStage

Étape de pipeline de déploiement Power BI

Nom	Type	Description
order	integer	Ordre d’étape, à partir de zéro.
workspaceId	string	ID d’espace de travail affecté. Applicable uniquement lorsqu’il existe un espace de travail affecté.
workspaceName	string	Nom de l’espace de travail affecté. Applicable uniquement lorsqu’il existe un espace de travail affecté et que l’utilisateur a accès à l’espace de travail.