Pipelines - Get Pipeline Operation

Reference

Service:: Power BI REST APIs

API Version:: v1.0

Vrátí podrobnosti o zadané operaci nasazení provedené v zadaném kanálu nasazení, včetně plánu spuštění nasazení.

Slouží ke sledování stavu operace nasazení.

Požadovaný obor

Pipeline.ReadWrite.All nebo Pipeline.Read.All

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
operationId	path	True	string uuid	ID operace
pipelineId	path	True	string uuid	ID kanálu nasazení

Odpovědi

Name	Typ	Description
200 OK	PipelineOperation	OK

Příklady

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

Definice

Name	Description
DeploymentError	Podrobnosti o chybě pro krok nasazení
DeploymentExecutionPlan	Plán spuštění nasazení
DeploymentExecutionStep	Krok spuštění nasazení
DeploymentExecutionStepPreDeploymentDiffState	Je položka nová, odlišná nebo identická s položkami v cílové fázi před nasazením.
DeploymentSourceAndTarget	Zdrojové a cílové položky
DeploymentStepType	Typ kroku nasazení
PipelineOperation	Operace kanálu nasazení Power BI
PipelineOperationNote	Poznámka popisující nasazení
PipelineOperationStatus	Stav operace kanálu
PipelineOperationType	Typ operace
PipelineOperationUser	Uživatel nebo instanční objekt, který provedl operaci kanálu.
PreDeploymentDiffInformation	Množství nových, různých a identických nasazených položek před nasazením.
PrincipalType	Typ objektu zabezpečení

DeploymentError

Podrobnosti o chybě pro krok nasazení

Name	Typ	Description
errorCode	string	Kód chyby
errorDetails	string	Další podrobnosti o chybě

DeploymentExecutionPlan

Plán spuštění nasazení

Name	Typ	Description
steps	DeploymentExecutionStep[]	Kolekce kroků plánu provádění

DeploymentExecutionStep

Krok spuštění nasazení

Name	Typ	Description
error	DeploymentError	Podrobnosti o chybě Platí pouze v případě, že operace kanálu selhala.
index	integer	Index kroku
preDeploymentDiffState	DeploymentExecutionStepPreDeploymentDiffState	Je položka nová, odlišná nebo identická s položkami v cílové fázi před nasazením.
sourceAndTarget	DeploymentSourceAndTarget	Zdrojové a cílové položky kroku
status	PipelineOperationStatus	Stav operace kanálu
type	DeploymentStepType	Typ kroku nasazení

DeploymentExecutionStepPreDeploymentDiffState

Je položka nová, odlišná nebo identická s položkami v cílové fázi před nasazením.

Name	Typ	Description
Different	string	Před nasazením nebyla položka ve zdrojové fázi identická s položkou v cílové fázi.
New	string	Nová nasazená položka, která v cílové fázi neexistuje.
NoDifference	string	Před nasazením byla položka ve zdrojové fázi identická s položkou v cílové fázi.

DeploymentSourceAndTarget

Zdrojové a cílové položky

Name	Typ	Description
source	string	ID položky Power BI nasazené ze zdrojové fáze
sourceDisplayName	string	Zobrazovaný název položky Power BI nasazené ze zdrojové fáze
target	string	ID položky Power BI, která se přepíše v cílové fázi. Platí jenom při přepsání položky Power BI.
targetDisplayName	string	Název položky Power BI, která se přepíše v cílové fázi. Platí jenom při přepsání položky Power BI.
type	string	Typ položky Power BI, která se přepíše v cílové fázi. Platí jenom při přepsání položky Power BI.

DeploymentStepType

Typ kroku nasazení

Name	Typ	Description
DashboardDeployment	string	Krok pro nasazení jednoho řídicího panelu
DataflowDeployment	string	Krok pro nasazení jednoho toku dat
DatamartDeployment	string	Krok pro nasazení jednoho datového diagramu
DatasetDeployment	string	Krok pro nasazení jedné datové sady
ReportDeployment	string	Krok pro nasazení jedné sestavy

PipelineOperation

Operace kanálu nasazení Power BI

Name	Typ	Description
executionEndTime	string	Datum a čas ukončení operace
executionPlan	DeploymentExecutionPlan	Plán spuštění nasazení. Platí pouze pro jednu operaci kanálu.
executionStartTime	string	Datum a čas zahájení operace
id	string	ID operace
lastUpdatedTime	string	Datum a čas poslední aktualizace operace
note	PipelineOperationNote	Poznámka představující popis operace.
performedBy	PipelineOperationUser	Uživatel nebo instanční objekt, který provedl operaci kanálu.
preDeploymentDiffInformation	PreDeploymentDiffInformation	Množství nasazených položek ve zdrojové fázi, které jsou nové, stejné nebo odlišné od položek v cílové fázi, před nasazením.
sourceStageOrder	integer	Číselný identifikátor fáze nasazení zdrojového kanálu. Vývoj (0), testování (1), produkce (2).
status	PipelineOperationStatus	Stav operace kanálu
targetStageOrder	integer	Číselný identifikátor fáze nasazení cílového kanálu Vývoj (0), testování (1), produkce (2).
type	PipelineOperationType	Typ operace

PipelineOperationNote

Poznámka popisující nasazení

Name	Typ	Description
content	string	Text popisující nasazení
isTruncated	boolean	Označuje, jestli je poznámka neúplná. Ano, vrátí se jenom část poznámky. Nepravda, poznámka je dokončená.

PipelineOperationStatus

Stav operace kanálu

Name	Typ	Description
Executing	string	Provádění operace
Failed	string	Operace se nezdařila
NotStarted	string	Operace se nespustila
Succeeded	string	Operace byla úspěšná.

PipelineOperationType

Typ operace

Name	Typ	Description
Deploy	string	Nasazení obsahu mezi fázemi

PipelineOperationUser

Uživatel nebo instanční objekt, který provedl operaci kanálu.

Name	Typ	Description
principalObjectID	string	ID instančního objektu, který provedl nasazení.
principalType	PrincipalType	Typ uživatele, který provedl nasazení.
userPrincipalName	string	Hlavní název uživatele (UPN) uživatele, který provedl nasazení.

PreDeploymentDiffInformation

Množství nových, různých a identických nasazených položek před nasazením.

Name	Typ	Description
differentArtifactsCount	integer	Počet nasazených položek s rozdíly mezi fází zdroje a cíle před nasazením.
newArtifactsCount	integer	Počet nových položek nasazených do cílové fáze.
noDifferenceArtifactsCount	integer	Počet identických nasazených položek ve zdrojové a cílové fázi před nasazením.

PrincipalType

Typ objektu zabezpečení

Name	Typ	Description
App	string	Typ instančního objektu
Group	string	Typ objektu zabezpečení skupiny
None	string	Žádný typ objektu zabezpečení. Používá se pro přístup na úrovni celé organizace.
User	string	Typ objektu zabezpečení uživatele

Sdílet prostřednictvím