Pipelines - Selective Deploy

Referência

Service:: Power BI REST APIs

API Version:: v1.0

Implanta os itens especificados do estágio de origem do pipeline de implantação especificado.

Permissões

O usuário deve ser pelo menos um membro em workspaces de implantação de origem e de destino. Para obter mais informações, consulte Permissões.

Escopo necessário

Pipeline.Deploy

Limitações

Máximo de 300 itens implantados por solicitação.

POST https://api.powerbi.com/v1.0/myorg/pipelines/{pipelineId}/deploy

Parâmetros de URI

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

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
sourceStageOrder	True	integer	O identificador numérico do estágio de implantação do pipeline do qual o conteúdo deve ser implantado. Desenvolvimento (0), Teste (1), Produção (2).
dashboards		DeployArtifactRequest[]	Uma lista de painéis a serem implantados
dataflows		DeployArtifactRequest[]	Uma lista de fluxos de dados a serem implantados
datamarts		DeployArtifactRequest[]	Uma lista de datamarts a serem implantados
datasets		DeployArtifactRequest[]	Uma lista de conjuntos de dados a serem implantados
isBackwardDeployment		boolean	Se a implantação será de um estágio posterior no pipeline de implantação para um anterior. O valor padrão é `false`.
newWorkspace		PipelineNewWorkspaceRequest	Os detalhes de configuração para criar um novo workspace. Necessário ao implantar em um estágio que não tem workspaces atribuídos. A implantação falhará se os novos detalhes de configuração do workspace não forem fornecidos quando necessário.
note		string	Uma observação que descreve a implantação.
options		DeploymentOptions	Opções que controlam o comportamento de toda a implantação
reports		DeployArtifactRequest[]	Uma lista de relatórios a serem implantados
updateAppSettings		PipelineUpdateAppSettings	Atualizar o aplicativo da organização nas configurações do workspace de destino

Respostas

Nome	Tipo	Description
202 Accepted	PipelineOperation	Aceita

Exemplos

Example of deploying specific Power BI items (such as reports or dashboards) from the 'Development' stage

Example of deploying specific Power BI items with custom options

Example of deploying specific Power BI items (such as reports or dashboards) from the 'Development' stage

Sample Request

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

Request Body

{
  "sourceStageOrder": 0,
  "dataflows": [
    {
      "sourceId": "29efcfb0-0063-44af-a4ed-6c0bee3417d3"
    }
  ],
  "datamarts": [
    {
      "sourceId": "6bfe235c-6d7b-41b7-98a6-2b8276b3e82b"
    }
  ],
  "datasets": [
    {
      "sourceId": "1a201f2a-d1d8-45c0-8c61-1676338517de"
    }
  ],
  "reports": [
    {
      "sourceId": "2d225191-65f8-4ec3-b77d-06100602b1f7"
    }
  ],
  "dashboards": [
    {
      "sourceId": "9046e4cc-8aea-4a7a-a3b5-1a78b1447d82"
    },
    {
      "sourceId": "7f08923c-8f57-49d6-a010-8335bb9cbd1b"
    }
  ],
  "options": {
    "allowOverwriteArtifact": true,
    "allowCreateArtifact": true
  },
  "note": "Deploying business ready items"
}

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "1065e6a3-a020-4c0c-ada7-92b5fe99eec5",
      "type": "Deploy",
      "status": "NotStarted",
      "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
    }
  ]
}

Example of deploying specific Power BI items with custom options

Sample Request

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

Request Body

{
  "sourceStageOrder": 0,
  "datamarts": [
    {
      "sourceId": "6bfe235c-6d7b-41b7-98a6-2b8276b3e82b",
      "options": {
        "allowOverwriteArtifact": true,
        "allowCreateArtifact": true
      }
    }
  ],
  "reports": [
    {
      "sourceId": "2d225191-65f8-4ec3-b77d-06100602b1f7",
      "options": {
        "allowOverwriteArtifact": true
      }
    }
  ],
  "note": "Deploying business ready items"
}

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "1065e6a3-a020-4c0c-ada7-92b5fe99eec5",
      "type": "Deploy",
      "status": "NotStarted",
      "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
    }
  ]
}

Definições

Nome	Description
DeployArtifactRequest	Uma solicitação para implantar um item do Power BI (como um relatório ou um painel)
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.
DeploymentOptions	Opções de configuração de implantação. Pode ser especificado para toda a implantação ou para um item específico do Power BI (como um relatório ou painel). Se ambos forem especificados, somente as opções de implantação para o item do Power BI serão usadas.
DeploymentSourceAndTarget	Itens de origem e de destino
DeploymentStepType	O tipo de etapa de implantação
PipelineNewWorkspaceRequest	Os detalhes de configuração para criar um novo workspace. Necessário ao implantar em um estágio que não tem workspaces atribuídos.
PipelineOperation	Uma operação de pipeline de implantação do Power BI
PipelineOperationNote	Uma observação que descreve a implantação.
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.
PipelineUpdateAppSettings	Aplicativo da organização de atualização de configuração após a implantação
PreDeploymentDiffInformation	A quantidade de itens novos, diferentes e idênticos implantados antes da implantação.
PrincipalType	O tipo de entidade de segurança
SelectiveDeployRequest	Uma solicitação para implantar seletivamente itens de um estágio de pipeline de implantação

DeployArtifactRequest

Uma solicitação para implantar um item do Power BI (como um relatório ou um painel)

Nome	Tipo	Description
options	DeploymentOptions	As opções de configuração de implantação para um item específico do Power BI (como um relatório ou um painel)
sourceId	string	A ID do item do Power BI (como um relatório ou um painel) a ser implantada

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.

DeploymentOptions

Opções de configuração de implantação. Pode ser especificado para toda a implantação ou para um item específico do Power BI (como um relatório ou painel). Se ambos forem especificados, somente as opções de implantação para o item do Power BI serão usadas.

Nome	Tipo	Description
allowCreateArtifact	boolean	Se a criação de um novo item do Power BI (como um relatório ou um painel) no workspace de estágio de destino é permitida. Se essa opção não estiver definida como `true` quando for necessário para implantação, a implantação falhará.
allowOverwriteArtifact	boolean	Se a substituição de um item do Power BI (como um relatório ou um painel) no workspace de estágio de destino é permitida. Se essa opção não estiver definida como `true` quando for necessário para implantação, a implantação falhará.
allowOverwriteTargetArtifactLabel	boolean	Se o rótulo de um item do Power BI de destino (como um relatório ou um painel) pode ser alterado. O rótulo é alterado quando a origem é protegida, mas o destino não é. Se essa opção não estiver definida como `true` quando for necessário para implantação, a implantação falhará.
allowPurgeData	boolean	Se todos os dados devem ser excluídos do item do Power BI de destino (como um relatório ou um painel) quando há uma incompatibilidade de esquema. Se essa opção não estiver definida como `true` quando for necessário para implantação, a implantação falhará.
allowSkipTilesWithMissingPrerequisites	boolean	Se é necessário ignorar blocos que não têm um modelo ou um relatório no workspace de estágio de destino. Se essa opção não estiver definida como `true` quando for necessário para implantação, a implantação falhará.
allowTakeOver	boolean	Se deseja permitir substituir o proprietário do relatório paginado anterior e se tornar o proprietário do relatório paginado. Aplicável ao implantar um relatório paginado em um estágio que já contém uma cópia do relatório paginado que não pertence a você. Se essa opção não estiver definida como `true` quando for necessário para implantação, a implantação falhará.

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

PipelineNewWorkspaceRequest

Os detalhes de configuração para criar um novo workspace. Necessário ao implantar em um estágio que não tem workspaces atribuídos.

Nome	Tipo	Description
capacityId	string	A ID da capacidade à qual o novo workspace será atribuído. Se não for especificado e o chamador de API tiver permissões para a capacidade do workspace do estágio de origem, essa capacidade será usada. Caso contrário, o Power BI selecionará uma capacidade para a qual o chamador de API tem permissões.
name	string	O nome do novo workspace

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.

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.

PipelineUpdateAppSettings

Aplicativo da organização de atualização de configuração após a implantação

Nome	Tipo	Description
updateAppInTargetWorkspace	boolean	Se o aplicativo deve ser atualizado no workspace de destino. Somente os itens implantados que já existem no aplicativo são atualizados. Novos itens implantados não são adicionados ao aplicativo.

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

SelectiveDeployRequest

Uma solicitação para implantar seletivamente itens de um estágio de pipeline de implantação

Nome	Tipo	Description
dashboards	DeployArtifactRequest[]	Uma lista de painéis a serem implantados
dataflows	DeployArtifactRequest[]	Uma lista de fluxos de dados a serem implantados
datamarts	DeployArtifactRequest[]	Uma lista de datamarts a serem implantados
datasets	DeployArtifactRequest[]	Uma lista de conjuntos de dados a serem implantados
isBackwardDeployment	boolean	Se a implantação será de um estágio posterior no pipeline de implantação para um anterior. O valor padrão é `false`.
newWorkspace	PipelineNewWorkspaceRequest	Os detalhes de configuração para criar um novo workspace. Necessário ao implantar em um estágio que não tem workspaces atribuídos. A implantação falhará se os novos detalhes de configuração do workspace não forem fornecidos quando necessário.
note	string	Uma observação que descreve a implantação.
options	DeploymentOptions	Opções que controlam o comportamento de toda a implantação
reports	DeployArtifactRequest[]	Uma lista de relatórios a serem implantados
sourceStageOrder	integer	O identificador numérico do estágio de implantação do pipeline do qual o conteúdo deve ser implantado. Desenvolvimento (0), Teste (1), Produção (2).
updateAppSettings	PipelineUpdateAppSettings	Atualizar o aplicativo da organização nas configurações do workspace de destino

Pipelines - Selective Deploy

Permissões

Escopo necessário

Limitações

Parâmetros de URI

Corpo da solicitação

Respostas

Exemplos

Example of deploying specific Power BI items (such as reports or dashboards) from the 'Development' stage

Sample Request

Sample Response

Example of deploying specific Power BI items with custom options

Sample Request

Sample Response

Definições

DeployArtifactRequest

DeploymentError

DeploymentExecutionPlan

DeploymentExecutionStep

DeploymentExecutionStepPreDeploymentDiffState

DeploymentOptions

DeploymentSourceAndTarget

DeploymentStepType

PipelineNewWorkspaceRequest

PipelineOperation

PipelineOperationNote

PipelineOperationStatus

PipelineOperationType

PipelineOperationUser

PipelineUpdateAppSettings

PreDeploymentDiffInformation

PrincipalType

SelectiveDeployRequest

Recursos adicionais