Pipelines - Selective Deploy

Servicio:: Power BI REST APIs

Versión de la API:: v1.0

Implementa los elementos especificados desde la fase de origen de la canalización de implementación especificada.

Permissions

El usuario debe ser al menos colaborador en las áreas de trabajo de implementación de origen y de destino. Para obtener más información, consulte Permisos.

Ámbito requerido

Pipeline.Deploy

Limitaciones

Máximo de 300 elementos implementados por solicitud.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
pipelineId	path	True	string (uuid)	Identificador de canalización de implementación

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
sourceStageOrder	True	integer	Identificador numérico de la fase de implementación de canalización desde la que se debe implementar el contenido. Desarrollo (0), Prueba (1), Producción (2).
dashboards		DeployArtifactRequest[]	Lista de paneles que se van a implementar
dataflows		DeployArtifactRequest[]	Lista de flujos de datos que se van a implementar
datamarts		DeployArtifactRequest[]	Lista de datamarts que se van a implementar
datasets		DeployArtifactRequest[]	Lista de conjuntos de datos que se van a implementar
isBackwardDeployment		boolean	Si la implementación será de una fase posterior en la canalización de implementación, a una anterior. El valor predeterminado es `false`.
newWorkspace		PipelineNewWorkspaceRequest	Los detalles de configuración para crear un área de trabajo. Necesario al implementar en una fase que no tenga áreas de trabajo asignadas. Se producirá un error en la implementación si los nuevos detalles de configuración del área de trabajo no se proporcionan cuando sea necesario.
note		string	Nota que describe la implementación.
options		DeploymentOptions	Opciones que controlan el comportamiento de toda la implementación
reports		DeployArtifactRequest[]	Lista de informes que se van a implementar
updateAppSettings		PipelineUpdateAppSettings	Actualización de la aplicación de organización en la configuración del área de trabajo de destino

Respuestas

Nombre	Tipo	Description
202 Accepted	PipelineOperation	Aceptado

Ejemplos

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

Solicitud de ejemplo

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

Cuerpo de la solicitud

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

Respuesta de muestra

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

Solicitud de ejemplo

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

Cuerpo de la solicitud

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

Respuesta de muestra

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

Definiciones

Nombre	Description
DeployArtifactRequest	Solicitud para implementar un elemento de Power BI (por ejemplo, un informe o un panel)
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.
DeploymentOptions	Opciones de configuración de implementación. Se puede especificar para toda la implementación o para un elemento específico de Power BI (por ejemplo, un informe o un panel). Si se especifican ambos, solo se usan las opciones de implementación para el elemento de Power BI.
DeploymentSourceAndTarget	Elementos de origen y destino
DeploymentStepType	Tipo de paso de implementación
PipelineNewWorkspaceRequest	Los detalles de configuración para crear un área de trabajo. Necesario al implementar en una fase que no tenga áreas de trabajo asignadas.
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.
PipelineUpdateAppSettings	Aplicación de organización de actualización de configuración después de la implementación
PreDeploymentDiffInformation	Cantidad de elementos nuevos, diferentes e idénticos implementados antes de la implementación.
PrincipalType	El tipo de entidad de seguridad
SelectiveDeployRequest	Una solicitud para implementar elementos de forma selectiva desde una fase de canalización de implementación

DeployArtifactRequest

Object

Solicitud para implementar un elemento de Power BI (por ejemplo, un informe o un panel)

Nombre	Tipo	Description
options	DeploymentOptions	Opciones de configuración de implementación para un elemento específico de Power BI (por ejemplo, un informe o un panel)
sourceId	string (uuid)	Identificador del elemento de Power BI (por ejemplo, un informe o un panel) que se va a implementar.

DeploymentError

Object

Detalles del error para el paso de implementación

Nombre	Tipo	Description
errorCode	string	El código de error
errorDetails	string	Detalles adicionales del error

DeploymentExecutionPlan

Object

Un plan de ejecución de implementación

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

DeploymentExecutionStep

Object

Un paso de ejecución de implementación

Nombre	Tipo	Description
error	DeploymentError	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	Los 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

Enumeración

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

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

DeploymentOptions

Object

Opciones de configuración de implementación. Se puede especificar para toda la implementación o para un elemento específico de Power BI (por ejemplo, un informe o un panel). Si se especifican ambos, solo se usan las opciones de implementación para el elemento de Power BI.

Nombre	Tipo	Description
allowCreateArtifact	boolean	Indica si se permite crear un nuevo elemento de Power BI (por ejemplo, un informe o un panel) en el área de trabajo de la fase de destino. Si esta opción no está establecida `true` en cuando se requiere para la implementación, se producirá un error en la implementación.
allowOverwriteArtifact	boolean	Indica si se permite sobrescribir un elemento de Power BI (por ejemplo, un informe o un panel) en el área de trabajo de la fase de destino. Si esta opción no está establecida `true` en cuando se requiere para la implementación, se producirá un error en la implementación.
allowOverwriteTargetArtifactLabel	boolean	Si se puede cambiar la etiqueta de un elemento de Power BI de destino (por ejemplo, un informe o un panel). La etiqueta se cambia cuando el origen está protegido, pero el destino no. Si esta opción no está establecida `true` en cuando se requiere para la implementación, se producirá un error en la implementación.
allowPurgeData	boolean	Si se van a eliminar todos los datos del elemento de Power BI de destino (por ejemplo, un informe o un panel) cuando hay un error de coincidencia de esquema. Si esta opción no está establecida `true` en cuando se requiere para la implementación, se producirá un error en la implementación.
allowSkipTilesWithMissingPrerequisites	boolean	Si se omiten los iconos que no tienen un modelo o un informe en el área de trabajo de la fase de destino. Si esta opción no está establecida `true` en cuando se requiere para la implementación, se producirá un error en la implementación.
allowTakeOver	boolean	Si se va a permitir reemplazar el propietario del informe paginado anterior y convertirse en el propietario del informe paginado. Aplicable al implementar un informe paginado en una fase que ya contiene una copia del informe paginado que no es propiedad de usted. Si esta opción no está establecida `true` en cuando se requiere para la implementación, se producirá un error en la implementación.

DeploymentSourceAndTarget

Object

Elementos de origen y destino

Nombre	Tipo	Description
source	string (uuid)	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 (uuid)	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

Enumeración

Tipo de paso de implementación

Valor	Description
DatasetDeployment	Paso para implementar un único conjunto de datos
ReportDeployment	Paso para implementar un único informe
DashboardDeployment	Paso para implementar un único panel
DataflowDeployment	Paso para implementar un único flujo de datos
DatamartDeployment	Paso para implementar un único datamart

PipelineNewWorkspaceRequest

Object

Los detalles de configuración para crear un área de trabajo. Necesario al implementar en una fase que no tenga áreas de trabajo asignadas.

Nombre	Tipo	Description
capacityId	string (uuid)	Identificador de la capacidad a la que se asignará el nuevo área de trabajo. Si no se especifica y el llamador de API tiene permisos para la capacidad del área de trabajo de la fase de origen, se usará esa capacidad. De lo contrario, Power BI seleccionará una capacidad para la que el autor de la llamada de API tenga permisos.
name	string	Nombre del nuevo área de trabajo

PipelineOperation

Object

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

Nombre	Tipo	Description
executionEndTime	string (date-time)	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 (date-time)	Fecha y hora en que se inició la operación
id	string (uuid)	El identificador de la operación
lastUpdatedTime	string (date-time)	Fecha y hora en que se actualizó la operación por última vez
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

Object

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

Enumeración

Estado de la operación de canalización

Valor	Description
NotStarted	Operación no iniciada
Executing	Ejecución de la operación
Succeeded	Operación correcta
Failed	Error en la operación

PipelineOperationType

Enumeración

Tipo de operación

Valor	Description
Deploy	Implementación de contenido entre fases

PipelineOperationUser

Object

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

Nombre	Tipo	Description
principalObjectID	string (uuid)	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.

PipelineUpdateAppSettings

Object

Aplicación de organización de actualización de configuración después de la implementación

Nombre	Tipo	Description
updateAppInTargetWorkspace	boolean	Si se va a actualizar la aplicación en el área de trabajo de destino. Solo se actualizan los elementos implementados que ya existen en la aplicación. Los nuevos elementos implementados no se agregan a la aplicación.

PreDeploymentDiffInformation

Object

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 destino, antes de la implementación.
newArtifactsCount	integer	Número de elementos nuevos 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

Enumeración

El tipo de entidad de seguridad

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

SelectiveDeployRequest

Object

Una solicitud para implementar elementos de forma selectiva desde una fase de canalización de implementación

Nombre	Tipo	Description
dashboards	DeployArtifactRequest[]	Lista de paneles que se van a implementar
dataflows	DeployArtifactRequest[]	Lista de flujos de datos que se van a implementar
datamarts	DeployArtifactRequest[]	Lista de datamarts que se van a implementar
datasets	DeployArtifactRequest[]	Lista de conjuntos de datos que se van a implementar
isBackwardDeployment	boolean	Si la implementación será de una fase posterior en la canalización de implementación, a una anterior. El valor predeterminado es `false`.
newWorkspace	PipelineNewWorkspaceRequest	Los detalles de configuración para crear un área de trabajo. Necesario al implementar en una fase que no tenga áreas de trabajo asignadas. Se producirá un error en la implementación si los nuevos detalles de configuración del área de trabajo no se proporcionan cuando sea necesario.
note	string	Nota que describe la implementación.
options	DeploymentOptions	Opciones que controlan el comportamiento de toda la implementación
reports	DeployArtifactRequest[]	Lista de informes que se van a implementar
sourceStageOrder	integer	Identificador numérico de la fase de implementación de canalización desde la que se debe implementar el contenido. Desarrollo (0), Prueba (1), Producción (2).
updateAppSettings	PipelineUpdateAppSettings	Actualización de la aplicación de organización en la configuración del área de trabajo de destino

Compartir a través de

Pipelines - Selective Deploy

Permissions

Ámbito requerido

Limitaciones

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

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

Solicitud de ejemplo

Respuesta de muestra

Example of deploying specific Power BI items with custom options

Solicitud de ejemplo

Respuesta de muestra

Definiciones

DeployArtifactRequest

DeploymentError

DeploymentExecutionPlan

DeploymentExecutionStep

DeploymentExecutionStepPreDeploymentDiffState

DeploymentOptions

DeploymentSourceAndTarget

DeploymentStepType

PipelineNewWorkspaceRequest

PipelineOperation

PipelineOperationNote

PipelineOperationStatus

PipelineOperationType

PipelineOperationUser

PipelineUpdateAppSettings

PreDeploymentDiffInformation

PrincipalType

SelectiveDeployRequest