Applets de commande Microsoft Power BI pour Windows PowerShell et PowerShell Core

Bienvenue dans la référence PowerShell pour Microsoft Power BI. Vous trouverez ici des ressources pour les modules PowerShell ciblant Power BI.

Modules PowerShell

Vous trouverez ci-dessous un tableau des modules PowerShell Power BI couverts dans cette référence.

Descriptif	Nom du module	Lien vers la galerie PowerShell
Module de cumul pour les applets de commande Power BI	NA
Module d’administration pour les applets de commande Power BI	MicrosoftPowerBIMgmt.Admin Module
Module de capacités pour les applets de commande Power BI	MicrosoftPowerBIMgmt.Capacities Module
Module de données pour les applets de commande Power BI	MicrosoftPowerBIMgmt.Data Module
Module de profil pour les applets de commande Power BI	MicrosoftPowerBIMgmt.Profile Module
Module de rapports pour Power BI	MicrosoftPowerBIMgmt.Reports Module
Module Espaces de travail pour Power BI	MicrosoftPowerBIMgmt.Workspaces Module

Environnements pris en charge et versions de PowerShell

• Windows PowerShell v3.0 et versions ultérieures avec .NET 4.7.1 ou version ultérieure.
• PowerShell Core (v6) et versions ultérieures sur n’importe quelle plate-forme de système d’exploitation prise en charge par PowerShell Core.

Installation

Les applets de commande sont disponibles sur PowerShell Gallery et peuvent être installées dans une session PowerShell avec élévation de privilèges :

Install-Module -Name MicrosoftPowerBIMgmt

En option, vous pouvez installer des modules individuels (en fonction de vos besoins) à la place du module de cumul, par exemple si vous ne vouliez que le module Workspaces :

Install-Module -Name MicrosoftPowerBIMgmt.Workspaces

Si vous disposez d’une version antérieure, vous pouvez effectuer la mise à jour vers la dernière version en exécutant :

Update-Module -Name MicrosoftPowerBIMgmt

Désinstaller

Si vous souhaitez désinstaller toutes les applets de commande PowerShell Power BI, exécutez ce qui suit dans une session PowerShell avec élévation de privilèges :

Get-Module MicrosoftPowerBIMgmt* -ListAvailable | Uninstall-Module -Force

Utilisation

Deux étendues sont prises en charge par les applets de commande qui interagissent avec les entités Power BI :

• Individual est utilisé pour accéder aux entités qui appartiennent à l’utilisateur actuel.
• L’organisation est utilisée pour accéder aux entités de l’ensemble de l’entreprise. Seuls les administrateurs de locataire Power BI sont autorisés à l’utiliser.

Si le paramètre -Scope n’existe pas sur l’applet de commande, l’entité ne prend pas en charge une API d’administration.

Se connecter à Power BI

Connect-PowerBIServiceAccount   # or use aliases: Login-PowerBIServiceAccount, Login-PowerBI

Obtenir des espaces de travail

Obtenez des espaces de travail pour l’utilisateur. Par défaut (c’est-à-dire sans -First paramètre), il affiche les 100 premiers espaces de travail attribués à l’utilisateur :

Get-PowerBIWorkspace

Utilisez le -All paramètre pour afficher tous les espaces de travail attribués à l’utilisateur :

Get-PowerBIWorkspace -All

Si vous êtes administrateur client, vous pouvez afficher tous les espaces de travail de votre locataire en ajoutant -Scope Organization:

Get-PowerBIWorkspace -Scope Organization -All

Mettre à jour un espace de travail

Mettre à jour le nom ou la description de l’espace de travail d’un utilisateur :

Set-PowerBIWorkspace -Scope Organization -Id "3244f1c1-01cf-457f-9383-6035e4950fdc" -Name "Test Name" -Description "Test Description"

Ajouter un nouvel utilisateur à un espace de travail

Ajouter un utilisateur à un espace de travail donné :

Add-PowerBIWorkspaceUser -Scope Organization -Id 3244f1c1-01cf-457f-9383-6035e4950fdc -UserEmailAddress john@contoso.com -AccessRight Admin

Supprimer un utilisateur d’un espace de travail donné

Supprimez les autorisations de l’utilisateur d’un espace de travail donné :

Remove-PowerBIWorkspaceUser -Scope Organization -Id 3244f1c1-01cf-457f-9383-6035e4950fdc -UserEmailAddress john@contoso.com

Obtenir l’état de migration de l’espace de travail

Obtenir l’état de migration de l’espace de travail Power BI :

Get-PowerBIWorkspaceMigrationStatus -Id 038f9a64-1fcd-42f2-957a-13a63b3d3235

Restaurer un espace de travail

Pour afficher les espaces de travail supprimés en tant qu’administrateur de locataire :

Get-PowerBIWorkspace -Scope Organization -Deleted -All

Restaurer un espace de travail supprimé :

Restore-PowerBIWorkspace -Id "3244f1c1-01cf-457f-9383-6035e4950fdc" -RestoredName "TestWorkspace" -AdminEmailAddress "john@contoso.com"

Récupérer un espace de travail orphelin

Un espace de travail devient orphelin lorsqu’aucun administrateur n’lui est attribué. Si vous êtes un administrateur de locataire, exécutez ce qui suit pour afficher tous les espaces de travail orphelins :

Get-PowerBIWorkspace -Scope Organization -Orphaned -All

Pour corriger ce problème, utilisez :

Add-PowerBIWorkspaceUser -Scope Organization -Id f2a0fae5-1c37-4ee6-97da-c9d31851fe17 -UserPrincipalName 'john@contoso.com' -AccessRight Admin

Obtenir des états

Obtenir tous les rapports de l’utilisateur :

Get-PowerBIReport

Si vous êtes un administrateur de locataire, vous pouvez afficher tous les rapports de votre locataire à l’aide de l’attribution de -Scope Organization:

Get-PowerBIReport -Scope Organization

Obtenir des tableaux de bord

Obtenez des tableaux de bord pour l’utilisateur :

Get-PowerBIDashboard

Si vous êtes administrateur client, vous pouvez afficher tous les tableaux de bord de votre client en ajoutant -Scope Organization:

Get-PowerBIDashboard -Scope Organization

Obtenir des tuiles

Obtenir des vignettes dans un tableau de bord :

Get-PowerBITile -DashboardId 9a58d5e5-61bc-447c-86c4-e221128b1c99

Obtenir des importations

Obtenez des importations Power BI :

Get-PowerBIImport

Créer un rapport

Créez un rapport dans Power BI en chargeant un fichier *.pbix :

New-PowerBIReport -Path .\newReport.pbix -Name 'New Report'

Par défaut, le rapport est placé dans Mon espace de travail de l’utilisateur. Pour placer dans un autre espace de travail, utilisez les -WorkspaceId paramètres ou -Workspace :

New-PowerBIReport -Path .\newReport.pbix -Name 'New Report' -WorkspaceId f95755a1-950c-46bd-a912-5aab4012a06d

Exporter un rapport

Exportez un rapport Power BI dans un fichier *.pbix :

Export-PowerBIReport -Id b48c088c-6f4e-4b7a-b015-d844ab534b2a -OutFile .\exportedReport.pbix

Si l’espace de travail existe en dehors de Mon espace de travail, exportez avec le WorkspaceId paramètre ou -Workspace :

Export-PowerBIReport -Id b48c088c-6f4e-4b7a-b015-d844ab534b2a -OutFile .\exportedReport.pbix -WorkspaceId 3bdd9735-0ab5-4f21-bd5d-87e7f1d7fb84

Obtenir des ensembles de données

Obtenez des jeux de données Power BI :

Get-PowerBIDataset

Mettre à jour le mode de stockage du jeu de données

Définissez le jeu de données Power BI pour utiliser les fichiers Premium pour le mode de stockage :

Set-PowerBIDataset -Id 038f9a64-1fcd-42f2-957a-13a63b3d3235 -TargetStorageMode PremiumFiles

Obtenir des sources de données

Obtenez des sources de données Power BI pour un jeu de données :

Get-PowerBIDatasource -DatasetId 65d7d7e5-8af0-4e94-b20b-50a882ae15e1

Obtenir des tables

Obtenez les tables Power BI contenues dans un jeu de données :

Get-PowerBITable -DatasetId 65d7d7e5-8af0-4e94-b20b-50a882ae15e1

Appeler l’API REST Power BI

Pour l’API Power BI qui ne dispose pas d’applets de commande correspondantes, vous pouvez réutiliser la session authentifiée à partir de pour effectuer des Connect-PowerBIServiceAccount requêtes REST personnalisées :

Invoke-PowerBIRestMethod -Url 'reports/4eb4c303-d5ac-4a2d-bf1e-39b35075d983/Clone' -Method Post -Body ([pscustomobject]@{name='Cloned report'; targetModelId='adf823b5-a0de-4b9f-bcce-b17d774d2961'; targetWorkspaceId='45ee15a7-0e8e-45b0-8111-ea304ada8d7d'} | ConvertTo-Json -Depth 2 -Compress)

Si vous souhaitez utiliser la session authentifiée en dehors de PowerShell, obtenez le jeton d’accès à l’aide de :

Get-PowerBIAccessToken -AsString

Dépannage des erreurs

Pour obtenir plus d’informations sur une erreur renvoyée par les applets de commande, utilisez :

Resolve-PowerBIError -Last

Ces informations peuvent être utiles pour ouvrir des tickets de support pour Power BI.

Problèmes et commentaires

Si vous trouvez des bogues ou si vous souhaitez que certaines fonctionnalités soient implémentées pour les applets de commande PowerShell pour Power BI, signalez un problème.

Si votre problème va au-delà des applets de commande PowerShell, envoyez vos commentaires à la communauté Power BI ou au site officiel de support Power BI .