Pipelines - Get Pipeline Operation

Usługa:: Power BI REST APIs

Wersja interfejsu API:: v1.0

Zwraca szczegóły określonej operacji wdrażania wykonywanej 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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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 wykonywania 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 wdrażania
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

Objekt

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

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

DeploymentExecutionPlan

Objekt

Plan wykonywania wdrożenia

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

DeploymentExecutionStep

Objekt

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 wdrażania

DeploymentExecutionStepPreDeploymentDiffState

Wyliczanie

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

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

DeploymentSourceAndTarget

Objekt

Elementy źródłowe i docelowe

Nazwa	Typ	Opis
source	string (uuid)	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 (uuid)	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

Wyliczanie

Typ kroku wdrażania

Wartość	Opis
DatasetDeployment	Krok wdrażania pojedynczego zestawu danych
ReportDeployment	Krok wdrażania pojedynczego raportu
DashboardDeployment	Krok wdrażania pojedynczego pulpitu nawigacyjnego
DataflowDeployment	Krok wdrażania pojedynczego przepływu danych
DatamartDeployment	Krok wdrażania pojedynczego elementu datamart

PipelineOperation

Objekt

Operacja potoku wdrażania usługi Power BI

Nazwa	Typ	Opis
executionEndTime	string (date-time)	Data i godzina zakończenia operacji
executionPlan	DeploymentExecutionPlan	Plan wykonania wdrożenia. Dotyczy tylko jednej operacji potoku.
executionStartTime	string (date-time)	Data i godzina rozpoczęcia operacji
id	string (uuid)	Identyfikator operacji
lastUpdatedTime	string (date-time)	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 docelowego etapu wdrażania potoku. Programowanie (0), testowanie (1), produkcja (2).
type	PipelineOperationType	Typ operacji

PipelineOperationNote

Objekt

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

Wyliczanie

Stan operacji potoku

Wartość	Opis
NotStarted	Operacja nie została uruchomiona
Executing	Wykonywanie operacji
Succeeded	Operacja powiodła się
Failed	Operacja nie powiodła się

PipelineOperationType

Wyliczanie

Typ operacji

Wartość	Opis
Deploy	Wdrażanie zawartości między etapami

PipelineOperationUser

Objekt

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

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

PreDeploymentDiffInformation

Objekt

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

Wyliczanie

Typ podmiotu zabezpieczeń

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

Udostępnij przez

Pipelines - Get Pipeline Operation

Wymagany zakres

Parametry identyfikatora URI

Odpowiedzi

Przykłady

Get a pipeline operation example

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

DeploymentError

DeploymentExecutionPlan

DeploymentExecutionStep

DeploymentExecutionStepPreDeploymentDiffState

DeploymentSourceAndTarget

DeploymentStepType

PipelineOperation

PipelineOperationNote

PipelineOperationStatus

PipelineOperationType

PipelineOperationUser

PreDeploymentDiffInformation

PrincipalType