Pipelines - Get Pipeline Operation

Odwołanie

Service:: Power BI REST APIs

API Version:: v1.0

Zwraca szczegóły określonej operacji wdrażania wykonanej w określonym potoku wdrażania, w tym plan wykonania wdrożenia.

Służy do śledzenia stanu operacji wdrażania.

Wymagany zakres

Pipeline.ReadWrite.All lub Pipeline.Read.All

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
operationId	path	True	string uuid	Identyfikator operacji
pipelineId	path	True	string uuid	Identyfikator potoku wdrażania

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PipelineOperation	OK

Przykłady

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

Definicje

Nazwa	Opis
DeploymentError	Szczegóły błędu dla kroku wdrażania
DeploymentExecutionPlan	Plan wykonania wdrożenia
DeploymentExecutionStep	Krok wykonywania wdrożenia
DeploymentExecutionStepPreDeploymentDiffState	Jest elementem nowym, innym lub identycznym z elementami na etapie docelowym przed wdrożeniem.
DeploymentSourceAndTarget	Elementy źródłowe i docelowe
DeploymentStepType	Typ kroku wdrożenia
PipelineOperation	Operacja potoku wdrażania usługi Power BI
PipelineOperationNote	Notatka opisująca wdrożenie.
PipelineOperationStatus	Stan operacji potoku
PipelineOperationType	Typ operacji
PipelineOperationUser	Użytkownik lub jednostka usługi, która wykonała operację potoku.
PreDeploymentDiffInformation	Ilość nowych, różnych i identycznych wdrożonych elementów przed wdrożeniem.
PrincipalType	Typ podmiotu zabezpieczeń

DeploymentError

Szczegóły błędu dla kroku wdrażania

Nazwa	Typ	Opis
errorCode	string	Kod błędu
errorDetails	string	Dodatkowe szczegóły błędu

DeploymentExecutionPlan

Plan wykonania wdrożenia

Nazwa	Typ	Opis
steps	DeploymentExecutionStep[]	Kolekcja kroków planu wykonania

DeploymentExecutionStep

Krok wykonywania wdrożenia

Nazwa	Typ	Opis
error	DeploymentError	Szczegóły błędu. Dotyczy tylko wtedy, gdy operacja potoku nie powiodła się.
index	integer	Indeks kroku
preDeploymentDiffState	DeploymentExecutionStepPreDeploymentDiffState	Jest elementem nowym, innym lub identycznym z elementami na etapie docelowym przed wdrożeniem.
sourceAndTarget	DeploymentSourceAndTarget	Elementy źródłowe i docelowe kroku
status	PipelineOperationStatus	Stan operacji potoku
type	DeploymentStepType	Typ kroku wdrożenia

DeploymentExecutionStepPreDeploymentDiffState

Jest elementem nowym, innym lub identycznym z elementami na etapie docelowym przed wdrożeniem.

Nazwa	Typ	Opis
Different	string	Przed wdrożeniem element na etapie źródłowym nie był identyczny z elementem na etapie docelowym.
New	string	Nowy wdrożony element, który nie istnieje na etapie docelowym.
NoDifference	string	Przed wdrożeniem element na etapie źródłowym był identyczny z elementem na etapie docelowym.

DeploymentSourceAndTarget

Elementy źródłowe i docelowe

Nazwa	Typ	Opis
source	string	Identyfikator elementu usługi Power BI wdrożonego na etapie źródłowym
sourceDisplayName	string	Nazwa wyświetlana elementu usługi Power BI wdrożonego na etapie źródłowym
target	string	Identyfikator elementu usługi Power BI, który zostanie zastąpiony na etapie docelowym. Ma zastosowanie tylko w przypadku zastępowania elementu usługi Power BI.
targetDisplayName	string	Nazwa elementu usługi Power BI, który zostanie zastąpiony na etapie docelowym. Ma zastosowanie tylko w przypadku zastępowania elementu usługi Power BI.
type	string	Typ elementu usługi Power BI, który zostanie zastąpiony na etapie docelowym. Ma zastosowanie tylko w przypadku zastępowania elementu usługi Power BI.

DeploymentStepType

Typ kroku wdrożenia

Nazwa	Typ	Opis
DashboardDeployment	string	Krok wdrażania pojedynczego pulpitu nawigacyjnego
DataflowDeployment	string	Krok wdrażania pojedynczego przepływu danych
DatamartDeployment	string	Krok wdrażania pojedynczego elementu datamart
DatasetDeployment	string	Krok wdrażania pojedynczego zestawu danych
ReportDeployment	string	Krok wdrażania pojedynczego raportu

PipelineOperation

Operacja potoku wdrażania usługi Power BI

Nazwa	Typ	Opis
executionEndTime	string	Data i godzina zakończenia operacji
executionPlan	DeploymentExecutionPlan	Plan wykonania wdrożenia. Dotyczy tylko jednej operacji potoku.
executionStartTime	string	Data i godzina rozpoczęcia operacji
id	string	Identyfikator operacji
lastUpdatedTime	string	Data i godzina ostatniej aktualizacji operacji
note	PipelineOperationNote	Notatka reprezentująca opis operacji.
performedBy	PipelineOperationUser	Użytkownik lub jednostka usługi, która wykonała operację potoku.
preDeploymentDiffInformation	PreDeploymentDiffInformation	Ilość wdrożonych elementów na etapie źródłowym, które są nowe, identyczne lub inne niż elementy na etapie docelowym, przed wdrożeniem.
sourceStageOrder	integer	Identyfikator liczbowy etapu wdrażania potoku źródłowego. Programowanie (0), Testowanie (1), Produkcja (2).
status	PipelineOperationStatus	Stan operacji potoku
targetStageOrder	integer	Identyfikator liczbowy etapu wdrażania potoku docelowego. Programowanie (0), Testowanie (1), Produkcja (2).
type	PipelineOperationType	Typ operacji

PipelineOperationNote

Notatka opisująca wdrożenie.

Nazwa	Typ	Opis
content	string	Tekst opisujący wdrożenie.
isTruncated	boolean	Wskazuje, czy notatka jest niekompletna. Prawda, zwracana jest tylko część notatki. Fałsz, notatka jest kompletna.

PipelineOperationStatus

Stan operacji potoku

Nazwa	Typ	Opis
Executing	string	Wykonywanie operacji
Failed	string	Operacja nie powiodła się
NotStarted	string	Operacja nie została uruchomiona
Succeeded	string	Operacja powiodła się

PipelineOperationType

Typ operacji

Nazwa	Typ	Opis
Deploy	string	Wdrażanie zawartości między etapami

PipelineOperationUser

Użytkownik lub jednostka usługi, która wykonała operację potoku.

Nazwa	Typ	Opis
principalObjectID	string	Identyfikator jednostki usługi, która wykonała wdrożenie.
principalType	PrincipalType	Typ użytkownika, który wykonał wdrożenie.
userPrincipalName	string	Nazwa UPN użytkownika, który wykonał wdrożenie.

PreDeploymentDiffInformation

Ilość nowych, różnych i identycznych wdrożonych elementów przed wdrożeniem.

Nazwa	Typ	Opis
differentArtifactsCount	integer	Liczba wdrożonych elementów z różnicami między etapami źródłowymi i docelowymi przed wdrożeniem.
newArtifactsCount	integer	Liczba nowych elementów wdrożonych na etapie docelowym.
noDifferenceArtifactsCount	integer	Liczba identycznych wdrożonych elementów na etapach źródłowych i docelowych przed wdrożeniem.

PrincipalType

Typ podmiotu zabezpieczeń

Nazwa	Typ	Opis
App	string	Typ jednostki usługi
Group	string	Typ podmiotu zabezpieczeń grupy
None	string	Brak typu podmiotu zabezpieczeń. Służy do uzyskiwania dostępu na poziomie całej organizacji.
User	string	Typ podmiotu zabezpieczeń użytkownika

Share via