Pipelines - Get Pipeline Operation

Referencia

Service:: Power BI REST APIs

API Version:: v1.0

Devuelve los detalles de la operación de implementación especificada realizada en la canalización de implementación especificada, incluido el plan de ejecución de implementación.

Use para realizar un seguimiento del estado de una operación de implementación.

Ámbito requerido

Pipeline.ReadWrite.All o Pipeline.Read.All

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
operationId	path	True	string uuid	Identificador de la operación
pipelineId	path	True	string uuid	Identificador de canalización de implementación

Respuestas

Nombre	Tipo	Description
200 OK	PipelineOperation	Aceptar

Ejemplos

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

Definiciones

Nombre	Description
DeploymentError	Detalles del error para el paso de implementación
DeploymentExecutionPlan	Un plan de ejecución de implementación
DeploymentExecutionStep	Un paso de ejecución de implementación
DeploymentExecutionStepPreDeploymentDiffState	Es un elemento nuevo, diferente o idéntico a los elementos de la fase de destino antes de la implementación.
DeploymentSourceAndTarget	Elementos de origen y destino
DeploymentStepType	Tipo de paso de implementación
PipelineOperation	Una operación de canalización de implementación de Power BI
PipelineOperationNote	Nota que describe la implementación.
PipelineOperationStatus	Estado de la operación de canalización
PipelineOperationType	Tipo de operación
PipelineOperationUser	Usuario o entidad de servicio que realizó la operación de canalización.
PreDeploymentDiffInformation	Cantidad de elementos nuevos, diferentes e idénticos implementados antes de la implementación.
PrincipalType	Tipo de entidad de seguridad

DeploymentError

Detalles del error para el paso de implementación

Nombre	Tipo	Description
errorCode	string	Código de error.
errorDetails	string	Detalles adicionales del error

DeploymentExecutionPlan

Un plan de ejecución de implementación

Nombre	Tipo	Description
steps	DeploymentExecutionStep[]	La colección de pasos del plan de ejecución

DeploymentExecutionStep

Un paso de ejecución de implementación

Nombre	Tipo	Description
error	DeploymentError	Los detalles del error. Solo es aplicable si se produjo un error en la operación de canalización.
index	integer	Índice del paso
preDeploymentDiffState	DeploymentExecutionStepPreDeploymentDiffState	Es un elemento nuevo, diferente o idéntico a los elementos de la fase de destino antes de la implementación.
sourceAndTarget	DeploymentSourceAndTarget	Elementos de origen y destino del paso
status	PipelineOperationStatus	Estado de la operación de canalización
type	DeploymentStepType	Tipo de paso de implementación

DeploymentExecutionStepPreDeploymentDiffState

Es un elemento nuevo, diferente o idéntico a los elementos de la fase de destino antes de la implementación.

Nombre	Tipo	Description
Different	string	Antes de la implementación, el elemento de la fase de origen no era idéntico al de la fase de destino.
New	string	Nuevo elemento implementado que no existe en la fase de destino.
NoDifference	string	Antes de la implementación, el elemento de la fase de origen era idéntico al de la fase de destino.

DeploymentSourceAndTarget

Elementos de origen y destino

Nombre	Tipo	Description
source	string	Identificador del elemento de Power BI que se implementa desde la fase de origen
sourceDisplayName	string	Nombre para mostrar del elemento de Power BI que se implementa desde la fase de origen
target	string	Identificador del elemento de Power BI que se sobrescribirá en la fase de destino. Solo se aplica al sobrescribir un elemento de Power BI.
targetDisplayName	string	Nombre del elemento de Power BI que se sobrescribirá en la fase de destino. Solo se aplica al sobrescribir un elemento de Power BI.
type	string	Tipo del elemento de Power BI que se sobrescribirá en la fase de destino. Solo se aplica al sobrescribir un elemento de Power BI.

DeploymentStepType

Tipo de paso de implementación

Nombre	Tipo	Description
DashboardDeployment	string	Un paso para implementar un único panel
DataflowDeployment	string	Un paso para implementar un único flujo de datos
DatamartDeployment	string	Un paso para implementar un único datamart
DatasetDeployment	string	Un paso para implementar un único conjunto de datos
ReportDeployment	string	Un paso para implementar un único informe

PipelineOperation

Una operación de canalización de implementación de Power BI

Nombre	Tipo	Description
executionEndTime	string	Fecha y hora en que finalizó la operación
executionPlan	DeploymentExecutionPlan	Plan de ejecución de implementación. Solo se aplica a una sola operación de canalización.
executionStartTime	string	Fecha y hora en que se inició la operación
id	string	Identificador de la operación
lastUpdatedTime	string	Fecha y hora en que se actualizó por última vez la operación
note	PipelineOperationNote	Nota que representa una descripción de la operación.
performedBy	PipelineOperationUser	Usuario o entidad de servicio que realizó la operación de canalización.
preDeploymentDiffInformation	PreDeploymentDiffInformation	Cantidad de elementos implementados en la fase de origen, que son nuevos, idénticos o diferentes a los elementos de la fase de destino, antes de la implementación.
sourceStageOrder	integer	Identificador numérico de una fase de implementación de canalización de origen. Desarrollo (0), Prueba (1), Producción (2).
status	PipelineOperationStatus	Estado de la operación de canalización
targetStageOrder	integer	Identificador numérico de una fase de implementación de canalización de destino. Desarrollo (0), Prueba (1), Producción (2).
type	PipelineOperationType	Tipo de operación

PipelineOperationNote

Nota que describe la implementación.

Nombre	Tipo	Description
content	string	Texto que describe la implementación.
isTruncated	boolean	Indica si la nota está incompleta. True, solo se devuelve parte de la nota. False, la nota está completa.

PipelineOperationStatus

Estado de la operación de canalización

Nombre	Tipo	Description
Executing	string	Operación que se ejecuta
Failed	string	Error en la operación.
NotStarted	string	Operación no iniciada
Succeeded	string	Operación correcta

PipelineOperationType

Tipo de operación

Nombre	Tipo	Description
Deploy	string	Implementación de contenido entre fases

PipelineOperationUser

Usuario o entidad de servicio que realizó la operación de canalización.

Nombre	Tipo	Description
principalObjectID	string	Identificador de la entidad de servicio que realizó la implementación.
principalType	PrincipalType	Tipo de usuario que realizó la implementación.
userPrincipalName	string	UPN del usuario que realizó la implementación.

PreDeploymentDiffInformation

Cantidad de elementos nuevos, diferentes e idénticos implementados antes de la implementación.

Nombre	Tipo	Description
differentArtifactsCount	integer	Número de elementos implementados con diferencias entre las fases de origen y de destino, antes de la implementación.
newArtifactsCount	integer	Número de nuevos elementos implementados en la fase de destino.
noDifferenceArtifactsCount	integer	Número de elementos implementados idénticos en las fases de origen y destino, antes de la implementación.

PrincipalType

Tipo de entidad de seguridad

Nombre	Tipo	Description
App	string	Tipo de entidad de servicio
Group	string	Tipo de entidad de seguridad de grupo
None	string	No hay ningún tipo de entidad de seguridad. Use para el acceso de nivel de organización completo.
User	string	Tipo de entidad de seguridad de usuario

Compartir a través de