Pipelines - Get Pipeline Operation

Référence

Service:: Power BI REST APIs

API Version:: v1.0

Retourne les détails de l’opération de déploiement spécifiée effectuée sur le pipeline de déploiement spécifié, y compris le plan d’exécution du déploiement.

Permet de suivre l’état d’une opération de déploiement.

Étendue requise

Pipeline.ReadWrite.All ou Pipeline.Read.All

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
operationId	path	True	string uuid	ID d’opération
pipelineId	path	True	string uuid	ID du pipeline de déploiement

Réponses

Nom	Type	Description
200 OK	PipelineOperation	Ok

Exemples

Get a pipeline operation example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/pipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/operations/1065e6a3-a020-4c0c-ada7-92b5fe99eec5

Sample Response

Status code:: 200

{
  "id": "1065e6a3-a020-4c0c-ada7-92b5fe99eec5",
  "type": "Deploy",
  "status": "Succeeded",
  "lastUpdatedTime": "2020-12-13T09:26:43.153",
  "executionStartTime": "2020-12-13T09:25:43.153Z",
  "executionEndTime": "2020-12-13T09:26:43.153Z",
  "sourceStageOrder": 0,
  "targetStageOrder": 1,
  "executionPlan": {
    "Steps": [
      {
        "index": 0,
        "type": "DataflowDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "New",
        "sourceAndTarget": {
          "source": "29efcfb0-0063-44af-a4ed-6c0bee3417d3",
          "sourceDisplayName": "Source dataflow",
          "type": "dataflow"
        }
      },
      {
        "index": 1,
        "type": "DatamartDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "New",
        "sourceAndTarget": {
          "source": "645cd81f-1b21-4006-82b6-54cc7ec0352e",
          "sourceDisplayName": "Source datamart",
          "type": "datamart"
        }
      },
      {
        "index": 2,
        "type": "DatasetDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "NoDifference",
        "sourceAndTarget": {
          "source": "1a201f2a-d1d8-45c0-8c61-1676338517de",
          "sourceDisplayName": "Source dataset",
          "target": "dd3b6aa1-4d40-405c-a19b-48314a27e8ee",
          "targetDisplayName": "Target dataset",
          "type": "dataset"
        }
      },
      {
        "index": 3,
        "type": "ReportDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "Different",
        "sourceAndTarget": {
          "source": "2d225191-65f8-4ec3-b77d-06100602b1f7",
          "sourceDisplayName": "Source report",
          "target": "9d5c1f0f-f85c-48f4-8a8e-4c77547116b3",
          "targetDisplayName": "Target report",
          "type": "report"
        }
      },
      {
        "index": 4,
        "type": "DashboardDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "New",
        "sourceAndTarget": {
          "source": "9046e4cc-8aea-4a7a-a3b5-1a78b1447d82",
          "sourceDisplayName": "Source dashboard",
          "type": "dashboard"
        }
      }
    ]
  },
  "note": {
    "content": "Sample note",
    "isTruncated": false
  },
  "preDeploymentDiffInformation": {
    "newArtifactsCount": 3,
    "differentArtifactsCount": 1,
    "noDifferenceArtifactsCount": 1
  },
  "performedBy": {
    "userPrincipalName": "john@contoso.com",
    "principalType": "User"
  }
}

Définitions

Nom	Description
DeploymentError	Détails de l’erreur pour l’étape de déploiement
DeploymentExecutionPlan	Plan d’exécution de déploiement
DeploymentExecutionStep	Étape d’exécution du déploiement
DeploymentExecutionStepPreDeploymentDiffState	Élément nouveau, différent ou identique aux éléments de la phase cible avant le déploiement.
DeploymentSourceAndTarget	Éléments source et cible
DeploymentStepType	Type d’étape de déploiement
PipelineOperation	Une opération de pipeline de déploiement Power BI
PipelineOperationNote	Note décrivant le déploiement.
PipelineOperationStatus	État de l’opération de pipeline
PipelineOperationType	Type d’opération
PipelineOperationUser	Utilisateur ou principal de service qui a effectué l’opération de pipeline.
PreDeploymentDiffInformation	Quantité d’éléments nouveaux, différents et identiques déployés avant le déploiement.
PrincipalType	Type principal

DeploymentError

Détails de l’erreur pour l’étape de déploiement

Nom	Type	Description
errorCode	string	Le code d'erreur
errorDetails	string	Détails supplémentaires de l’erreur

DeploymentExecutionPlan

Plan d’exécution de déploiement

Nom	Type	Description
steps	DeploymentExecutionStep[]	Collection d’étapes du plan d’exécution

DeploymentExecutionStep

Étape d’exécution du déploiement

Nom	Type	Description
error	DeploymentError	Détails de l’erreur. Applicable uniquement en cas d’échec de l’opération de pipeline.
index	integer	Index d’étape
preDeploymentDiffState	DeploymentExecutionStepPreDeploymentDiffState	Élément nouveau, différent ou identique aux éléments de la phase cible avant le déploiement.
sourceAndTarget	DeploymentSourceAndTarget	Éléments source et cible de l’étape
status	PipelineOperationStatus	État de l’opération de pipeline
type	DeploymentStepType	Type d’étape de déploiement

DeploymentExecutionStepPreDeploymentDiffState

Élément nouveau, différent ou identique aux éléments de la phase cible avant le déploiement.

Nom	Type	Description
Different	string	Avant le déploiement, l’élément de la phase source n’était pas identique à celui de la phase cible.
New	string	Nouvel élément déployé qui n’existe pas dans la phase cible.
NoDifference	string	Avant le déploiement, l’élément de la phase source était identique à celui de la phase cible.

DeploymentSourceAndTarget

Éléments source et cible

Nom	Type	Description
source	string	ID de l’élément Power BI déployé à partir de la phase source
sourceDisplayName	string	Nom d’affichage de l’élément Power BI déployé à partir de la phase source
target	string	ID de l’élément Power BI qui sera remplacé dans la phase cible. S’applique uniquement lors du remplacement d’un élément Power BI.
targetDisplayName	string	Nom de l’élément Power BI qui sera remplacé dans la phase cible. S’applique uniquement lors du remplacement d’un élément Power BI.
type	string	Type de l’élément Power BI qui sera remplacé dans la phase cible. S’applique uniquement lors du remplacement d’un élément Power BI.

DeploymentStepType

Type d’étape de déploiement

Nom	Type	Description
DashboardDeployment	string	Étape de déploiement d’un tableau de bord unique
DataflowDeployment	string	Étape de déploiement d’un flux de données unique
DatamartDeployment	string	Étape de déploiement d’un datamart unique
DatasetDeployment	string	Étape de déploiement d’un jeu de données unique
ReportDeployment	string	Étape de déploiement d’un rapport unique

PipelineOperation

Une opération de pipeline de déploiement Power BI

Nom	Type	Description
executionEndTime	string	Date et heure auxquelles l’opération s’est terminée
executionPlan	DeploymentExecutionPlan	Plan d’exécution du déploiement. Applicable uniquement à une seule opération de pipeline.
executionStartTime	string	Date et heure auxquelles l’opération a démarré
id	string	ID d’opération
lastUpdatedTime	string	Date et heure de la dernière mise à jour de l’opération
note	PipelineOperationNote	Note représentant une description de l’opération.
performedBy	PipelineOperationUser	Utilisateur ou principal de service qui a effectué l’opération de pipeline.
preDeploymentDiffInformation	PreDeploymentDiffInformation	Quantité d’éléments déployés dans la phase source, qui sont nouveaux, identiques ou différents aux éléments de la phase cible, avant le déploiement.
sourceStageOrder	integer	Identificateur numérique d’une étape de déploiement de pipeline source. Développement (0), Test (1), Production (2).
status	PipelineOperationStatus	État de l’opération de pipeline
targetStageOrder	integer	Identificateur numérique d’une phase de déploiement de pipeline cible. Développement (0), Test (1), Production (2).
type	PipelineOperationType	Type d’opération

PipelineOperationNote

Note décrivant le déploiement.

Nom	Type	Description
content	string	Texte décrivant le déploiement.
isTruncated	boolean	Indique si la note est incomplète. True, seule une partie de la note est retournée. False, la note est terminée.

PipelineOperationStatus

État de l’opération de pipeline

Nom	Type	Description
Executing	string	Opération en cours d’exécution
Failed	string	L’opération a échoué
NotStarted	string	Opération non démarrée
Succeeded	string	Opération réussie

PipelineOperationType

Type d’opération

Nom	Type	Description
Deploy	string	Déployer du contenu entre les étapes

PipelineOperationUser

Utilisateur ou principal de service qui a effectué l’opération de pipeline.

Nom	Type	Description
principalObjectID	string	ID du principal de service qui a effectué le déploiement.
principalType	PrincipalType	Type d’utilisateur qui a effectué le déploiement.
userPrincipalName	string	UPN de l’utilisateur qui a effectué le déploiement.

PreDeploymentDiffInformation

Quantité d’éléments nouveaux, différents et identiques déployés avant le déploiement.

Nom	Type	Description
differentArtifactsCount	integer	Nombre d’éléments déployés avec des différences entre les phases source et cible, avant le déploiement.
newArtifactsCount	integer	Nombre de nouveaux éléments déployés à la phase cible.
noDifferenceArtifactsCount	integer	Nombre d’éléments déployés identiques aux phases source et cible, avant le déploiement.

PrincipalType

Type principal

Nom	Type	Description
App	string	Type de principal de service
Group	string	Type de principal de groupe
None	string	Aucun type principal. Utilisez pour l’accès au niveau de l’organisation entière.
User	string	Type de principal d’utilisateur