Pipelines - Get Pipeline Operation

Dienst:: Power BI REST APIs

API-Version:: v1.0

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

Dient zum Nachverfolgen des Status eines Bereitstellungsvorgangs.

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	OKAY

Beispiele

Get a pipeline operation example

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 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 Zielstufe vor der Bereitstellung.
DeploymentSourceAndTarget	Quell- und Zielelemente
DeploymentStepType	Der Typ des Bereitstellungsschritts
PipelineOperation	Ein Power BI-Bereitstellungspipelinevorgang
PipelineOperationNote	Eine Notiz, die die Bereitstellung beschreibt.
PipelineOperationStatus	Der Status des Pipelinevorgangs
PipelineOperationType	Der Vorgangstyp
PipelineOperationUser	Benutzer- oder Dienstprinzipal, der den Pipelinevorgang ausgeführt hat.
PreDeploymentDiffInformation	Die Menge an neuen, unterschiedlichen und identischen bereitgestellten Elementen vor der Bereitstellung.
PrincipalType	Der Prinzipaltyp

DeploymentError

Objekt

Fehlerdetails für den Bereitstellungsschritt

Name	Typ	Beschreibung
errorCode	string	Der Fehlercode
errorDetails	string	Weitere Fehlerdetails

DeploymentExecutionPlan

Objekt

Ein Bereitstellungsausführungsplan

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

DeploymentExecutionStep

Objekt

Ein Bereitstellungsausführungsschritt

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

DeploymentExecutionStepPreDeploymentDiffState

Enumeration

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

Wert	Beschreibung
New	Ein neues bereitgestelltes Element, das in der Zielphase nicht vorhanden ist.
Different	Vor der Bereitstellung war das Element in der Quellstufe nicht mit dem Element in der Zielstufe identisch.
NoDifference	Vor der Bereitstellung war das Element in der Quellstufe mit dem Element in der Zielstufe identisch.

DeploymentSourceAndTarget

Objekt

Quell- und Zielelemente

Name	Typ	Beschreibung
source	string (uuid)	Die ID des Power BI-Elements, das aus der Quellstufe bereitgestellt wird
sourceDisplayName	string	Der Anzeigename des Power BI-Elements, das aus der Quellstufe bereitgestellt wird
target	string (uuid)	Die ID des Power BI-Elements, das in der Zielphase überschrieben wird. Gilt nur beim Überschreiben eines Power BI-Elements.
targetDisplayName	string	Der Name des Power BI-Elements, das in der Zielphase überschrieben wird. Gilt nur beim Überschreiben eines Power BI-Elements.
type	string	Der Typ des Power BI-Elements, das in der Zielstufe überschrieben wird. Gilt nur beim Überschreiben eines Power BI-Elements.

DeploymentStepType

Enumeration

Der Typ des Bereitstellungsschritts

Wert	Beschreibung
DatasetDeployment	Ein Schritt für die Bereitstellung eines einzelnen Datasets
ReportDeployment	Ein Schritt für die Bereitstellung eines einzelnen Berichts
DashboardDeployment	Ein Schritt für die Bereitstellung eines einzelnen Dashboards
DataflowDeployment	Ein Schritt für die Bereitstellung eines einzelnen Datenflusses
DatamartDeployment	Ein Schritt für die Bereitstellung eines einzelnen Datamart-Objekts

PipelineOperation

Objekt

Ein Power BI-Bereitstellungspipelinevorgang

Name	Typ	Beschreibung
executionEndTime	string (date-time)	Datum und Uhrzeit, zu dem der Vorgang beendet wurde
executionPlan	DeploymentExecutionPlan	Der Bereitstellungsausführungsplan. Gilt nur für einen einzelnen Pipelinevorgang.
executionStartTime	string (date-time)	Datum und Uhrzeit, zu dem der Vorgang gestartet wurde
id	string (uuid)	Die Vorgangs-ID
lastUpdatedTime	string (date-time)	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 Quellstufe, die vor der Bereitstellung neu, identisch oder anders als Elemente in der Zielstufe sind.
sourceStageOrder	integer	Der numerische Bezeichner einer Bereitstellungsphase der Quellpipeline. Entwicklung (0), Test (1), Produktion (2).
status	PipelineOperationStatus	Der Status des Pipelinevorgangs
targetStageOrder	integer	Der numerische Bezeichner einer Zielpipelinebereitstellungsphase. Entwicklung (0), Test (1), Produktion (2).
type	PipelineOperationType	Der Vorgangstyp

PipelineOperationNote

Objekt

Eine Notiz, die 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

Enumeration

Der Status des Pipelinevorgangs

Wert	Beschreibung
NotStarted	Vorgang nicht gestartet
Executing	Ausführen des Vorgangs
Succeeded	Vorgang erfolgreich
Failed	Fehler beim Vorgang.

PipelineOperationType

Enumeration

Der Vorgangstyp

Wert	Beschreibung
Deploy	Inhalte zwischen den Phasen bereitstellen

PipelineOperationUser

Objekt

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

Name	Typ	Beschreibung
principalObjectID	string (uuid)	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

Objekt

Die Menge an neuen, unterschiedlichen und identischen bereitgestellten Elementen 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 neuen Elemente, die in der Zielphase bereitgestellt wurden.
noDifferenceArtifactsCount	integer	Die Anzahl identischer bereitgestellter Elemente in den Quell- und Zielphasen vor der Bereitstellung.

PrincipalType

Enumeration

Der Prinzipaltyp

Wert	Beschreibung
None	Kein Prinzipaltyp. Wird für den Zugriff auf ganze Organisationsebene verwendet.
User	Benutzerprinzipaltyp
Group	Gruppenprinzipaltyp
App	Dienstprinzipaltyp

Freigeben über

Pipelines - Get Pipeline Operation

Erforderlicher Bereich

URI-Parameter

Antworten

Beispiele

Get a pipeline operation example

Beispielanforderung

Beispiel für eine Antwort

Definitionen

DeploymentError

DeploymentExecutionPlan

DeploymentExecutionStep

DeploymentExecutionStepPreDeploymentDiffState

DeploymentSourceAndTarget

DeploymentStepType

PipelineOperation

PipelineOperationNote

PipelineOperationStatus

PipelineOperationType

PipelineOperationUser

PreDeploymentDiffInformation

PrincipalType