Pipelines - Get Pipeline Operations

Referência

Service:: Power BI REST APIs

API Version:: v1.0

Retorna uma lista das 20 operações de implantação mais recentes executadas no pipeline de implantação especificado.

Escopo necessário

Pipeline.ReadWrite.All ou Pipeline.Read.All

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
pipelineId	path	True	string uuid	A ID do pipeline de implantação

Respostas

Nome	Tipo	Description
200 OK	PipelineOperations	OK

Exemplos

Get pipeline operations example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/pipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/operations

Sample Response

Status code:: 200

{
  "value": [
    {
      "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,
      "note": {
        "content": "Sample note",
        "isTruncated": false
      },
      "preDeploymentDiffInformation": {
        "newArtifactsCount": 0,
        "differentArtifactsCount": 0,
        "noDifferenceArtifactsCount": 1
      },
      "performedBy": {
        "userPrincipalName": "john@contoso.com",
        "principalType": "User"
      }
    }
  ]
}

Definições

Nome	Description
DeploymentError	Detalhes do erro para a etapa de implantação
DeploymentExecutionPlan	Um plano de execução de implantação
DeploymentExecutionStep	Uma etapa de execução de implantação
DeploymentExecutionStepPreDeploymentDiffState	É um item novo, diferente ou idêntico aos itens no estágio de destino antes da implantação.
DeploymentSourceAndTarget	Itens de origem e de destino
DeploymentStepType	O tipo de etapa de implantação
PipelineOperation	Uma operação de pipeline de implantação do Power BI
PipelineOperationNote	Uma observação que descreve a implantação.
PipelineOperations	Wrapper de resposta OData para uma coleção de operações de pipeline de implantação do Power BI
PipelineOperationStatus	O status da operação do pipeline
PipelineOperationType	O tipo de operação
PipelineOperationUser	Usuário ou entidade de serviço que executou a operação de pipeline.
PreDeploymentDiffInformation	A quantidade de itens novos, diferentes e idênticos implantados antes da implantação.
PrincipalType	O tipo de entidade de segurança

DeploymentError

Detalhes do erro para a etapa de implantação

Nome	Tipo	Description
errorCode	string	O código de erro
errorDetails	string	Detalhes adicionais do erro

DeploymentExecutionPlan

Um plano de execução de implantação

Nome	Tipo	Description
steps	DeploymentExecutionStep[]	A coleção de etapas do plano de execução

DeploymentExecutionStep

Uma etapa de execução de implantação

Nome	Tipo	Description
error	DeploymentError	Os detalhes do erro. Aplicável somente se a operação de pipeline falhou.
index	integer	O índice da etapa
preDeploymentDiffState	DeploymentExecutionStepPreDeploymentDiffState	É um item novo, diferente ou idêntico aos itens no estágio de destino antes da implantação.
sourceAndTarget	DeploymentSourceAndTarget	Os itens de origem e destino da etapa
status	PipelineOperationStatus	O status da operação de pipeline
type	DeploymentStepType	O tipo de etapa de implantação

DeploymentExecutionStepPreDeploymentDiffState

É um item novo, diferente ou idêntico aos itens no estágio de destino antes da implantação.

Nome	Tipo	Description
Different	string	Antes da implantação, o item no estágio de origem não era idêntico ao do estágio de destino.
New	string	Um novo item implantado que não existe no estágio de destino.
NoDifference	string	Antes da implantação, o item no estágio de origem era idêntico ao do estágio de destino.

DeploymentSourceAndTarget

Itens de origem e de destino

Nome	Tipo	Description
source	string	A ID do item do Power BI implantado no estágio de origem
sourceDisplayName	string	O nome de exibição do item do Power BI implantado no estágio de origem
target	string	A ID do item do Power BI que será substituído no estágio de destino. Aplica-se somente ao substituir um item do Power BI.
targetDisplayName	string	O nome do item do Power BI que será substituído no estágio de destino. Aplica-se somente ao substituir um item do Power BI.
type	string	O tipo do item do Power BI que será substituído no estágio de destino. Aplica-se somente ao substituir um item do Power BI.

DeploymentStepType

O tipo de etapa de implantação

Nome	Tipo	Description
DashboardDeployment	string	Uma etapa para implantar um único painel
DataflowDeployment	string	Uma etapa para implantar um único fluxo de dados
DatamartDeployment	string	Uma etapa para implantar um único datamart
DatasetDeployment	string	Uma etapa para implantar um único conjunto de dados
ReportDeployment	string	Uma etapa para implantar um único relatório

PipelineOperation

Uma operação de pipeline de implantação do Power BI

Nome	Tipo	Description
executionEndTime	string	A data e a hora em que a operação terminou
executionPlan	DeploymentExecutionPlan	O plano de execução da implantação. Aplicável somente a uma única operação de pipeline.
executionStartTime	string	A data e a hora em que a operação foi iniciada
id	string	A ID da operação
lastUpdatedTime	string	A data e a hora em que a operação foi atualizada pela última vez
note	PipelineOperationNote	Uma observação que representa uma descrição da operação.
performedBy	PipelineOperationUser	Usuário ou entidade de serviço que executou a operação de pipeline.
preDeploymentDiffInformation	PreDeploymentDiffInformation	A quantidade de itens implantados no estágio de origem, que são novos, idênticos ou diferentes dos itens no estágio de destino, antes da implantação.
sourceStageOrder	integer	O identificador numérico de um estágio de implantação de pipeline de origem. Desenvolvimento (0), Teste (1), Produção (2).
status	PipelineOperationStatus	O status da operação do pipeline
targetStageOrder	integer	O identificador numérico de um estágio de implantação de pipeline de destino. Desenvolvimento (0), Teste (1), Produção (2).
type	PipelineOperationType	O tipo de operação

PipelineOperationNote

Uma observação que descreve a implantação.

Nome	Tipo	Description
content	string	Texto que descreve a implantação.
isTruncated	boolean	Indica se a nota está incompleta. True, apenas parte da nota é retornada. False, a anotação está concluída.

PipelineOperations

Wrapper de resposta OData para uma coleção de operações de pipeline de implantação do Power BI

Nome	Tipo	Description
odata.context	string	Contexto OData
value	PipelineOperation[]	A coleção de operações de pipeline de implantação

PipelineOperationStatus

O status da operação do pipeline

Nome	Tipo	Description
Executing	string	Operação em execução
Failed	string	Falha na operação
NotStarted	string	Operação não iniciada
Succeeded	string	Operação bem-sucedida

PipelineOperationType

O tipo de operação

Nome	Tipo	Description
Deploy	string	Implantar conteúdo entre estágios

PipelineOperationUser

Usuário ou entidade de serviço que executou a operação de pipeline.

Nome	Tipo	Description
principalObjectID	string	A ID da entidade de serviço que executou a implantação.
principalType	PrincipalType	O tipo de usuário que executou a implantação.
userPrincipalName	string	O UPN do usuário que executou a implantação.

PreDeploymentDiffInformation

A quantidade de itens novos, diferentes e idênticos implantados antes da implantação.

Nome	Tipo	Description
differentArtifactsCount	integer	O número de itens implantados com diferenças entre os estágios de origem e de destino, antes da implantação.
newArtifactsCount	integer	O número de novos itens implantados no estágio de destino.
noDifferenceArtifactsCount	integer	O número de itens implantados idênticos nos estágios de origem e destino, antes da implantação.

PrincipalType

O tipo de entidade de segurança

Nome	Tipo	Description
App	string	Tipo de entidade de serviço
Group	string	Tipo de entidade de grupo
None	string	Nenhum tipo de entidade de segurança. Use para acesso em nível de organização inteiro.
User	string	Tipo de entidade de usuário

Compartilhar via