Pipelines - Get Pipeline Operation
Restituisce i dettagli dell'operazione di distribuzione specificata eseguita nella pipeline di distribuzione specificata, incluso il piano di esecuzione della distribuzione.
Usare per tenere traccia dello stato di un'operazione di distribuzione.
Ambito obbligatorio
Pipeline.ReadWrite.All o Pipeline.Read.All
GET https://api.powerbi.com/v1.0/myorg/pipelines/{pipelineId}/operations/{operationId}
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
operation
|
path | True |
string uuid |
ID operazione |
pipeline
|
path | True |
string uuid |
ID della pipeline di distribuzione |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
OK |
Esempio
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
{
"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"
}
}
Definizioni
Nome | Descrizione |
---|---|
Deployment |
Dettagli dell'errore per il passaggio di distribuzione |
Deployment |
Piano di esecuzione della distribuzione |
Deployment |
Passaggio di esecuzione della distribuzione |
Deployment |
Elemento nuovo, diverso o identico agli elementi nella fase di destinazione prima della distribuzione. |
Deployment |
Elementi di origine e destinazione |
Deployment |
Tipo di passaggio della distribuzione |
Pipeline |
Operazione della pipeline di distribuzione di Power BI |
Pipeline |
Nota che descrive la distribuzione. |
Pipeline |
Stato dell'operazione della pipeline |
Pipeline |
Tipo di operazione |
Pipeline |
Entità servizio o utente che ha eseguito l'operazione della pipeline. |
Pre |
Quantità di nuovi elementi distribuiti diversi e identici prima della distribuzione. |
Principal |
Tipo principale |
DeploymentError
Dettagli dell'errore per il passaggio di distribuzione
Nome | Tipo | Descrizione |
---|---|---|
errorCode |
string |
Il codice di errore |
errorDetails |
string |
Dettagli di errore aggiuntivi |
DeploymentExecutionPlan
Piano di esecuzione della distribuzione
Nome | Tipo | Descrizione |
---|---|---|
steps |
Raccolta dei passaggi del piano di esecuzione |
DeploymentExecutionStep
Passaggio di esecuzione della distribuzione
Nome | Tipo | Descrizione |
---|---|---|
error |
Dettagli dell'errore. Applicabile solo se l'operazione della pipeline non è riuscita. |
|
index |
integer |
Indice passaggio |
preDeploymentDiffState |
Elemento nuovo, diverso o identico agli elementi nella fase di destinazione prima della distribuzione. |
|
sourceAndTarget |
Elementi di origine e destinazione del passaggio |
|
status |
Stato dell'operazione della pipeline |
|
type |
Tipo di passaggio della distribuzione |
DeploymentExecutionStepPreDeploymentDiffState
Elemento nuovo, diverso o identico agli elementi nella fase di destinazione prima della distribuzione.
Nome | Tipo | Descrizione |
---|---|---|
Different |
string |
Prima della distribuzione, l'elemento nella fase di origine non era identico a quello nella fase di destinazione. |
New |
string |
Nuovo elemento distribuito che non esiste nella fase di destinazione. |
NoDifference |
string |
Prima della distribuzione, l'elemento nella fase di origine era identico a quello nella fase di destinazione. |
DeploymentSourceAndTarget
Elementi di origine e destinazione
Nome | Tipo | Descrizione |
---|---|---|
source |
string |
ID dell'elemento di Power BI distribuito dalla fase di origine |
sourceDisplayName |
string |
Nome visualizzato dell'elemento di Power BI distribuito dalla fase di origine |
target |
string |
ID dell'elemento di Power BI sovrascritto nella fase di destinazione. Si applica solo quando si sovrascrive un elemento di Power BI. |
targetDisplayName |
string |
Nome dell'elemento di Power BI sovrascritto nella fase di destinazione. Si applica solo quando si sovrascrive un elemento di Power BI. |
type |
string |
Tipo dell'elemento di Power BI sovrascritto nella fase di destinazione. Si applica solo quando si sovrascrive un elemento di Power BI. |
DeploymentStepType
Tipo di passaggio della distribuzione
Nome | Tipo | Descrizione |
---|---|---|
DashboardDeployment |
string |
Passaggio per la distribuzione di un singolo dashboard |
DataflowDeployment |
string |
Passaggio per la distribuzione di un singolo flusso di dati |
DatamartDeployment |
string |
Passaggio per la distribuzione di un singolo datamart |
DatasetDeployment |
string |
Passaggio per la distribuzione di un singolo set di dati |
ReportDeployment |
string |
Passaggio per la distribuzione di un singolo report |
PipelineOperation
Operazione della pipeline di distribuzione di Power BI
Nome | Tipo | Descrizione |
---|---|---|
executionEndTime |
string |
Data e ora di fine dell'operazione |
executionPlan |
Piano di esecuzione della distribuzione. Applicabile solo a una singola operazione della pipeline. |
|
executionStartTime |
string |
Data e ora di avvio dell'operazione |
id |
string |
ID operazione |
lastUpdatedTime |
string |
Data e ora dell'ultimo aggiornamento dell'operazione |
note |
Nota che rappresenta una descrizione dell'operazione. |
|
performedBy |
Entità servizio o utente che ha eseguito l'operazione della pipeline. |
|
preDeploymentDiffInformation |
Quantità di elementi distribuiti nella fase di origine, nuovi, identici o diversi agli elementi nella fase di destinazione, prima della distribuzione. |
|
sourceStageOrder |
integer |
Identificatore numerico di una fase di distribuzione della pipeline di origine. Sviluppo (0), Test (1), Produzione (2). |
status |
Stato dell'operazione della pipeline |
|
targetStageOrder |
integer |
Identificatore numerico di una fase di distribuzione della pipeline di destinazione. Sviluppo (0), Test (1), Produzione (2). |
type |
Tipo di operazione |
PipelineOperationNote
Nota che descrive la distribuzione.
Nome | Tipo | Descrizione |
---|---|---|
content |
string |
Testo che descrive la distribuzione. |
isTruncated |
boolean |
Indica se la nota è incompleta. True, viene restituita solo una parte della nota. False, la nota è completa. |
PipelineOperationStatus
Stato dell'operazione della pipeline
Nome | Tipo | Descrizione |
---|---|---|
Executing |
string |
Operazione in esecuzione |
Failed |
string |
Operazione non riuscita |
NotStarted |
string |
Operazione non avviata |
Succeeded |
string |
Operazione riuscita |
PipelineOperationType
Tipo di operazione
Nome | Tipo | Descrizione |
---|---|---|
Deploy |
string |
Distribuire il contenuto tra le fasi |
PipelineOperationUser
Entità servizio o utente che ha eseguito l'operazione della pipeline.
Nome | Tipo | Descrizione |
---|---|---|
principalObjectID |
string |
ID dell'entità servizio che ha eseguito la distribuzione. |
principalType |
Tipo di utente che ha eseguito la distribuzione. |
|
userPrincipalName |
string |
UPN dell'utente che ha eseguito la distribuzione. |
PreDeploymentDiffInformation
Quantità di nuovi elementi distribuiti diversi e identici prima della distribuzione.
Nome | Tipo | Descrizione |
---|---|---|
differentArtifactsCount |
integer |
Numero di elementi distribuiti con differenze tra le fasi di origine e di destinazione, prima della distribuzione. |
newArtifactsCount |
integer |
Numero di nuovi elementi distribuiti nella fase di destinazione. |
noDifferenceArtifactsCount |
integer |
Numero di elementi distribuiti identici nelle fasi di origine e destinazione, prima della distribuzione. |
PrincipalType
Tipo principale
Nome | Tipo | Descrizione |
---|---|---|
App |
string |
Tipo di entità servizio |
Group |
string |
Tipo di entità gruppo |
None |
string |
Nessun tipo di entità. Usare per l'accesso a livello di organizzazione intero. |
User |
string |
Tipo di entità utente |