Pipelines - Selective Deploy

Référence

Service:: Power BI REST APIs

API Version:: v1.0

Déploie les éléments spécifiés à partir de l’étape source du pipeline de déploiement spécifié.

Autorisations

L’utilisateur doit au moins être membre des espaces de travail de déploiement source et cible. Pour plus d’informations, consultez Autorisations.

Étendue requise

Pipeline.Deploy

Limites

Maximum 300 éléments déployés par demande.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
pipelineId	path	True	string uuid	ID du pipeline de déploiement

Corps de la demande

Nom	Obligatoire	Type	Description
sourceStageOrder	True	integer	Identificateur numérique de l’étape de déploiement de pipeline à partir de laquelle le contenu doit être déployé. Développement (0), Test (1), Production (2).
dashboards		DeployArtifactRequest[]	Liste des tableaux de bord à déployer
dataflows		DeployArtifactRequest[]	Liste des flux de données à déployer
datamarts		DeployArtifactRequest[]	Liste des datamarts à déployer
datasets		DeployArtifactRequest[]	Liste des jeux de données à déployer
isBackwardDeployment		boolean	Indique si le déploiement sera d’une étape ultérieure du pipeline de déploiement à une étape antérieure. La valeur par défaut est `false`.
newWorkspace		PipelineNewWorkspaceRequest	Détails de configuration pour la création d’un espace de travail. Obligatoire lors du déploiement sur une phase qui n’a aucun espace de travail affecté. Le déploiement échoue si les détails de configuration du nouvel espace de travail ne sont pas fournis lorsque cela est nécessaire.
note		string	Note décrivant le déploiement.
options		DeploymentOptions	Options qui contrôlent le comportement de l’ensemble du déploiement
reports		DeployArtifactRequest[]	Liste des rapports à déployer
updateAppSettings		PipelineUpdateAppSettings	Mettre à jour l’application d’organisation dans les paramètres de l’espace de travail cible

Réponses

Nom	Type	Description
202 Accepted	PipelineOperation	Acceptée

Exemples

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

Définitions

Nom	Description
DeployArtifactRequest	Demande de déploiement d’un élément Power BI (tel qu’un rapport ou un tableau de bord)
DeploymentError	Détails de l’erreur pour l’étape de déploiement
DeploymentExecutionPlan	Un plan d’exécution de déploiement
DeploymentExecutionStep	Étape d’exécution du déploiement
DeploymentExecutionStepPreDeploymentDiffState	Élément nouveau, différent ou identique aux éléments de la phase cible avant le déploiement.
DeploymentOptions	Options de configuration du déploiement. Peut être spécifié pour l’ensemble du déploiement ou pour un élément Power BI spécifique (tel qu’un rapport ou un tableau de bord). Si les deux sont spécifiés, seules les options de déploiement de l’élément Power BI sont utilisées.
DeploymentSourceAndTarget	Éléments sources et cibles
DeploymentStepType	Type d’étape de déploiement
PipelineNewWorkspaceRequest	Détails de configuration pour la création d’un espace de travail. Obligatoire lors du déploiement sur une phase qui n’a aucun espace de travail affecté.
PipelineOperation	Une opération de pipeline de déploiement Power BI
PipelineOperationNote	Note décrivant le déploiement.
PipelineOperationStatus	État de l’opération de pipeline
PipelineOperationType	Type d’opération
PipelineOperationUser	Utilisateur ou principal de service qui a effectué l’opération de pipeline.
PipelineUpdateAppSettings	Application d’organisation de mise à jour de la configuration après le déploiement
PreDeploymentDiffInformation	Quantité d’éléments nouveaux, différents et identiques déployés avant le déploiement.
PrincipalType	Type principal
SelectiveDeployRequest	Demande de déploiement sélectif d’éléments à partir d’une phase de pipeline de déploiement

DeployArtifactRequest

Demande de déploiement d’un élément Power BI (tel qu’un rapport ou un tableau de bord)

Nom	Type	Description
options	DeploymentOptions	Options de configuration de déploiement pour un élément Power BI spécifique (tel qu’un rapport ou un tableau de bord)
sourceId	string	ID de l’élément Power BI (tel qu’un rapport ou un tableau de bord) à déployer

DeploymentError

Détails de l’erreur pour l’étape de déploiement

Nom	Type	Description
errorCode	string	Le code d'erreur
errorDetails	string	Détails supplémentaires sur l’erreur

DeploymentExecutionPlan

Un plan d’exécution de déploiement

Nom	Type	Description
steps	DeploymentExecutionStep[]	Collection d’étapes du plan d’exécution

DeploymentExecutionStep

Étape d’exécution du déploiement

Nom	Type	Description
error	DeploymentError	Détails de l’erreur. Applicable uniquement en cas d’échec de l’opération de pipeline.
index	integer	Index d’étape
preDeploymentDiffState	DeploymentExecutionStepPreDeploymentDiffState	Élément nouveau, différent ou identique aux éléments de la phase cible avant le déploiement.
sourceAndTarget	DeploymentSourceAndTarget	Éléments source et cible de l’étape
status	PipelineOperationStatus	État de l’opération de pipeline
type	DeploymentStepType	Type d’étape de déploiement

DeploymentExecutionStepPreDeploymentDiffState

Élément nouveau, différent ou identique aux éléments de la phase cible avant le déploiement.

Nom	Type	Description
Different	string	Avant le déploiement, l’élément de la phase source n’était pas identique à celui de la phase cible.
New	string	Nouvel élément déployé qui n’existe pas dans la phase cible.
NoDifference	string	Avant le déploiement, l’élément de la phase source était identique à celui de l’étape cible.

DeploymentOptions

Options de configuration du déploiement. Peut être spécifié pour l’ensemble du déploiement ou pour un élément Power BI spécifique (tel qu’un rapport ou un tableau de bord). Si les deux sont spécifiés, seules les options de déploiement de l’élément Power BI sont utilisées.

Nom	Type	Description
allowCreateArtifact	boolean	Indique si la création d’un élément Power BI (tel qu’un rapport ou un tableau de bord) dans l’espace de travail de l’étape cible est autorisée. Si cette option n’est pas définie sur `true` quand elle est requise pour le déploiement, le déploiement échoue.
allowOverwriteArtifact	boolean	Indique si le remplacement d’un élément Power BI (tel qu’un rapport ou un tableau de bord) dans l’espace de travail de l’étape cible est autorisé. Si cette option n’est pas définie sur `true` quand elle est requise pour le déploiement, le déploiement échoue.
allowOverwriteTargetArtifactLabel	boolean	Indique si l’étiquette d’un élément Power BI cible (tel qu’un rapport ou un tableau de bord) peut être modifiée. L’étiquette est modifiée lorsque la source est protégée, mais que la cible ne l’est pas. Si cette option n’est pas définie sur `true` quand elle est requise pour le déploiement, le déploiement échoue.
allowPurgeData	boolean	Indique s’il faut supprimer toutes les données de l’élément Power BI cible (tel qu’un rapport ou un tableau de bord) en cas d’incompatibilité de schéma. Si cette option n’est pas définie sur `true` quand elle est requise pour le déploiement, le déploiement échoue.
allowSkipTilesWithMissingPrerequisites	boolean	Indique s’il faut ignorer les vignettes qui n’ont pas de modèle ou de rapport dans l’espace de travail de l’étape cible. Si cette option n’est pas définie sur `true` quand elle est requise pour le déploiement, le déploiement échoue.
allowTakeOver	boolean	Indique s’il faut autoriser le remplacement du propriétaire du rapport paginé précédent et devenir le propriétaire du rapport paginé. Applicable lors du déploiement d’un rapport paginé sur une phase qui contient déjà une copie du rapport paginé qui ne vous appartient pas. Si cette option n’est pas définie sur `true` quand elle est requise pour le déploiement, le déploiement échoue.

DeploymentSourceAndTarget

Éléments sources et cibles

Nom	Type	Description
source	string	ID de l’élément Power BI déployé à partir de la phase source
sourceDisplayName	string	Nom complet de l’élément Power BI déployé à partir de la phase source
target	string	ID de l’élément Power BI qui sera remplacé à l’étape cible. S’applique uniquement lors du remplacement d’un élément Power BI.
targetDisplayName	string	Nom de l’élément Power BI qui sera remplacé dans la phase cible. S’applique uniquement lors du remplacement d’un élément Power BI.
type	string	Type de l’élément Power BI qui sera remplacé dans la phase cible. S’applique uniquement lors du remplacement d’un élément Power BI.

DeploymentStepType

Type d’étape de déploiement

Nom	Type	Description
DashboardDeployment	string	Étape de déploiement d’un tableau de bord unique
DataflowDeployment	string	Étape de déploiement d’un flux de données unique
DatamartDeployment	string	Étape de déploiement d’un datamart unique
DatasetDeployment	string	Étape de déploiement d’un jeu de données unique
ReportDeployment	string	Étape de déploiement d’un seul rapport

PipelineNewWorkspaceRequest

Détails de configuration pour la création d’un espace de travail. Obligatoire lors du déploiement sur une phase qui n’a aucun espace de travail affecté.

Nom	Type	Description
capacityId	string	ID de la capacité à laquelle le nouvel espace de travail sera affecté. Si non spécifié et que l’appelant d’API dispose d’autorisations pour la capacité de l’espace de travail de l’étape source, cette capacité est utilisée. Sinon, Power BI sélectionne une capacité pour laquelle l’appelant d’API dispose d’autorisations.
name	string	Nom du nouvel espace de travail

PipelineOperation

Une opération de pipeline de déploiement Power BI

Nom	Type	Description
executionEndTime	string	Date et heure auxquelles l’opération s’est terminée
executionPlan	DeploymentExecutionPlan	Plan d’exécution du déploiement. Applicable uniquement à une seule opération de pipeline.
executionStartTime	string	Date et heure de démarrage de l’opération
id	string	ID d’opération
lastUpdatedTime	string	Date et heure de la dernière mise à jour de l’opération
note	PipelineOperationNote	Note représentant une description de l’opération.
performedBy	PipelineOperationUser	Utilisateur ou principal de service qui a effectué l’opération de pipeline.
preDeploymentDiffInformation	PreDeploymentDiffInformation	Quantité d’éléments déployés dans la phase source, qui sont nouveaux, identiques ou différents des éléments de la phase cible, avant le déploiement.
sourceStageOrder	integer	Identificateur numérique d’une étape de déploiement de pipeline source. Développement (0), Test (1), Production (2).
status	PipelineOperationStatus	État de l’opération de pipeline
targetStageOrder	integer	Identificateur numérique d’une étape de déploiement de pipeline cible. Développement (0), Test (1), Production (2).
type	PipelineOperationType	Type d’opération

PipelineOperationNote

Note décrivant le déploiement.

Nom	Type	Description
content	string	Texte décrivant le déploiement.
isTruncated	boolean	Indique si la note est incomplète. True, seule une partie de la note est retournée. False, la note est terminée.

PipelineOperationStatus

État de l’opération de pipeline

Nom	Type	Description
Executing	string	Opération en cours d’exécution
Failed	string	L’opération a échoué
NotStarted	string	Opération non démarrée
Succeeded	string	Opération réussie

PipelineOperationType

Type d’opération

Nom	Type	Description
Deploy	string	Déployer du contenu entre les phases

PipelineOperationUser

Utilisateur ou principal de service qui a effectué l’opération de pipeline.

Nom	Type	Description
principalObjectID	string	ID du principal de service qui a effectué le déploiement.
principalType	PrincipalType	Type d’utilisateur qui a effectué le déploiement.
userPrincipalName	string	UPN de l’utilisateur qui a effectué le déploiement.

PipelineUpdateAppSettings

Application d’organisation de mise à jour de la configuration après le déploiement

Nom	Type	Description
updateAppInTargetWorkspace	boolean	Indique s’il faut mettre à jour l’application dans l’espace de travail cible. Seuls les éléments déployés qui existent déjà dans l’application sont mis à jour. Les nouveaux éléments déployés ne sont pas ajoutés à l’application.

PreDeploymentDiffInformation

Quantité d’éléments nouveaux, différents et identiques déployés avant le déploiement.

Nom	Type	Description
differentArtifactsCount	integer	Nombre d’éléments déployés avec des différences entre les phases source et cible, avant le déploiement.
newArtifactsCount	integer	Nombre de nouveaux éléments déployés sur la phase cible.
noDifferenceArtifactsCount	integer	Nombre d’éléments identiques déployés dans les phases source et cible, avant le déploiement.

PrincipalType

Type principal

Nom	Type	Description
App	string	Type de principal de service
Group	string	Type de principal de groupe
None	string	Aucun type de principal. Utilisez pour l’ensemble de l’accès au niveau de l’organisation.
User	string	Type de principal d’utilisateur

SelectiveDeployRequest

Demande de déploiement sélectif d’éléments à partir d’une phase de pipeline de déploiement

Nom	Type	Description
dashboards	DeployArtifactRequest[]	Liste des tableaux de bord à déployer
dataflows	DeployArtifactRequest[]	Liste des flux de données à déployer
datamarts	DeployArtifactRequest[]	Liste des datamarts à déployer
datasets	DeployArtifactRequest[]	Liste des jeux de données à déployer
isBackwardDeployment	boolean	Indique si le déploiement sera d’une étape ultérieure du pipeline de déploiement à une étape antérieure. La valeur par défaut est `false`.
newWorkspace	PipelineNewWorkspaceRequest	Détails de configuration pour la création d’un espace de travail. Obligatoire lors du déploiement sur une phase qui n’a aucun espace de travail affecté. Le déploiement échoue si les détails de configuration du nouvel espace de travail ne sont pas fournis lorsque cela est nécessaire.
note	string	Note décrivant le déploiement.
options	DeploymentOptions	Options qui contrôlent le comportement de l’ensemble du déploiement
reports	DeployArtifactRequest[]	Liste des rapports à déployer
sourceStageOrder	integer	Identificateur numérique de l’étape de déploiement de pipeline à partir de laquelle le contenu doit être déployé. Développement (0), Test (1), Production (2).
updateAppSettings	PipelineUpdateAppSettings	Mettre à jour l’application d’organisation dans les paramètres de l’espace de travail cible

Pipelines - Selective Deploy

Autorisations

Étendue requise

Limites

Paramètres URI

Corps de la demande

Réponses

Exemples

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

Définitions

DeployArtifactRequest

DeploymentError

DeploymentExecutionPlan

DeploymentExecutionStep

DeploymentExecutionStepPreDeploymentDiffState

DeploymentOptions

DeploymentSourceAndTarget

DeploymentStepType

PipelineNewWorkspaceRequest

PipelineOperation

PipelineOperationNote

PipelineOperationStatus

PipelineOperationType

PipelineOperationUser

PipelineUpdateAppSettings

PreDeploymentDiffInformation

PrincipalType

SelectiveDeployRequest

Ressources supplémentaires