Pipelines - Get Pipeline Operation

Referenz

Service:: Power BI REST APIs

API Version:: v1.0

Gibt die Details des angegebenen Bereitstellungsvorgangs zurück, der für die angegebene Bereitstellungspipeline ausgeführt wird, einschließlich des Bereitstellungsausführungsplans.

Verwenden Sie, um den Status eines Bereitstellungsvorgangs nachzuverfolgen.

Erforderlicher Bereich

Pipeline.ReadWrite.All oder Pipeline.Read.All

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
operationId	path	True	string uuid	Die Vorgangs-ID
pipelineId	path	True	string uuid	Die Bereitstellungspipeline-ID

Antworten

Name	Typ	Beschreibung
200 OK	PipelineOperation	OK

Beispiele

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

Definitionen

Name	Beschreibung
DeploymentError	Fehlerdetails für den Bereitstellungsschritt
DeploymentExecutionPlan	Ein Bereitstellungsausführungsplan
DeploymentExecutionStep	Ein Bereitstellungsausführungsschritt
DeploymentExecutionStepPreDeploymentDiffState	Ist ein Element neu, anders oder identisch mit Elementen in der Zielphase vor der Bereitstellung.
DeploymentSourceAndTarget	Quell- und Zielelemente
DeploymentStepType	Art des Bereitstellungsschritts
PipelineOperation	Ein Power BI-Bereitstellungspipeline-Vorgang
PipelineOperationNote	Ein Hinweis, der die Bereitstellung beschreibt.
PipelineOperationStatus	Der Pipelinevorgangsstatus
PipelineOperationType	Vorgangstyp
PipelineOperationUser	Benutzer- oder Dienstprinzipal, der den Pipelinevorgang ausgeführt hat.
PreDeploymentDiffInformation	Die Menge neuer, unterschiedlicher und identischer bereitgestellter Elemente vor der Bereitstellung.
PrincipalType	Der Prinzipaltyp

DeploymentError

Fehlerdetails für den Bereitstellungsschritt

Name	Typ	Beschreibung
errorCode	string	Den Fehlercode
errorDetails	string	Zusätzliche Fehlerdetails

DeploymentExecutionPlan

Ein Bereitstellungsausführungsplan

Name	Typ	Beschreibung
steps	DeploymentExecutionStep[]	Die Auflistung der Ausführungsplanschritte

DeploymentExecutionStep

Ein Bereitstellungsausführungsschritt

Name	Typ	Beschreibung
error	DeploymentError	Die Fehlerdetails. Gilt nur, wenn beim Pipelinevorgang ein Fehler aufgetreten ist.
index	integer	Der Schrittindex
preDeploymentDiffState	DeploymentExecutionStepPreDeploymentDiffState	Ist ein Element neu, anders oder identisch mit Elementen in der Zielphase vor der Bereitstellung.
sourceAndTarget	DeploymentSourceAndTarget	Die Quell- und Zielelemente des Schritts
status	PipelineOperationStatus	Der Status des Pipelinevorgangs
type	DeploymentStepType	Art des Bereitstellungsschritts

DeploymentExecutionStepPreDeploymentDiffState

Ist ein Element neu, anders oder identisch mit Elementen in der Zielphase vor der Bereitstellung.

Name	Typ	Beschreibung
Different	string	Vor der Bereitstellung war das Element in der Quellphase nicht mit dem Element in der Zielphase identisch.
New	string	Ein neues bereitgestelltes Element, das in der Zielphase nicht vorhanden ist.
NoDifference	string	Vor der Bereitstellung war das Element in der Quellphase mit dem Element in der Zielphase identisch.

DeploymentSourceAndTarget

Quell- und Zielelemente

Name	Typ	Beschreibung
source	string	Die ID des Power BI-Elements, das aus der Quellphase bereitgestellt wird
sourceDisplayName	string	Der Anzeigename des Power BI-Elements, das in der Quellphase bereitgestellt wird
target	string	Die ID des Power BI-Elements, das in der Zielphase überschrieben wird. Gilt nur, wenn ein Power BI-Element überschrieben wird.
targetDisplayName	string	Der Name des Power BI-Elements, das in der Zielphase überschrieben wird. Gilt nur, wenn ein Power BI-Element überschrieben wird.
type	string	Der Typ des Power BI-Elements, das in der Zielphase überschrieben wird. Gilt nur, wenn ein Power BI-Element überschrieben wird.

DeploymentStepType

Art des Bereitstellungsschritts

Name	Typ	Beschreibung
DashboardDeployment	string	Ein Schritt für die Bereitstellung eines einzelnen Dashboards
DataflowDeployment	string	Ein Schritt zum Bereitstellen eines einzelnen Dataflows
DatamartDeployment	string	Ein Schritt zum Bereitstellen eines einzelnen datamart
DatasetDeployment	string	Ein Schritt zum Bereitstellen eines einzelnen Datasets
ReportDeployment	string	Ein Schritt zum Bereitstellen eines einzelnen Berichts

PipelineOperation

Ein Power BI-Bereitstellungspipeline-Vorgang

Name	Typ	Beschreibung
executionEndTime	string	Datum und Uhrzeit des Vorgangsendes
executionPlan	DeploymentExecutionPlan	Der Bereitstellungsausführungsplan. Gilt nur für einen einzelnen Pipelinevorgang.
executionStartTime	string	Datum und Uhrzeit des Startvorgangs
id	string	Die Vorgangs-ID
lastUpdatedTime	string	Datum und Uhrzeit der letzten Aktualisierung des Vorgangs
note	PipelineOperationNote	Eine Notiz, die eine Beschreibung des Vorgangs darstellt.
performedBy	PipelineOperationUser	Benutzer- oder Dienstprinzipal, der den Pipelinevorgang ausgeführt hat.
preDeploymentDiffInformation	PreDeploymentDiffInformation	Die Menge der bereitgestellten Elemente in der Quellphase, die vor der Bereitstellung neu, identisch oder sich von Elementen in der Zielphase unterscheiden.
sourceStageOrder	integer	Der numerische Bezeichner einer Bereitstellungsphase der Quellpipeline. Entwicklung (0), Test (1), Produktion (2).
status	PipelineOperationStatus	Der Pipelinevorgangsstatus
targetStageOrder	integer	Der numerische Bezeichner einer Bereitstellungsphase einer Zielpipeline. Entwicklung (0), Test (1), Produktion (2).
type	PipelineOperationType	Vorgangstyp

PipelineOperationNote

Ein Hinweis, der die Bereitstellung beschreibt.

Name	Typ	Beschreibung
content	string	Text, der die Bereitstellung beschreibt.
isTruncated	boolean	Gibt an, ob die Notiz unvollständig ist. True, nur ein Teil der Notiz wird zurückgegeben. False, die Notiz ist abgeschlossen.

PipelineOperationStatus

Der Pipelinevorgangsstatus

Name	Typ	Beschreibung
Executing	string	Vorgang, der ausgeführt wird
Failed	string	Fehler beim Vorgang
NotStarted	string	Vorgang wurde nicht gestartet
Succeeded	string	Vorgang erfolgreich

PipelineOperationType

Vorgangstyp

Name	Typ	Beschreibung
Deploy	string	Bereitstellen von Inhalten zwischen Phasen

PipelineOperationUser

Benutzer- oder Dienstprinzipal, der den Pipelinevorgang ausgeführt hat.

Name	Typ	Beschreibung
principalObjectID	string	Die ID des Dienstprinzipals, der die Bereitstellung ausgeführt hat.
principalType	PrincipalType	Der Typ des Benutzers, der die Bereitstellung ausgeführt hat.
userPrincipalName	string	Der UPN des Benutzers, der die Bereitstellung ausgeführt hat.

PreDeploymentDiffInformation

Die Menge neuer, unterschiedlicher und identischer bereitgestellter Elemente vor der Bereitstellung.

Name	Typ	Beschreibung
differentArtifactsCount	integer	Die Anzahl der bereitgestellten Elemente mit Unterschieden zwischen Quell- und Zielphasen vor der Bereitstellung.
newArtifactsCount	integer	Die Anzahl der in der Zielphase bereitgestellten neuen Elemente.
noDifferenceArtifactsCount	integer	Die Anzahl identischer bereitgestellter Elemente in der Quell- und Zielphase vor der Bereitstellung.

PrincipalType

Der Prinzipaltyp

Name	Typ	Beschreibung
App	string	Dienstprinzipaltyp
Group	string	Gruppenprinzipaltyp
None	string	Kein Prinzipaltyp. Verwenden Sie dies für den gesamten Zugriff auf Organisationsebene.
User	string	Benutzerprinzipaltyp