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

Article
05/12/2023

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 abordés dans cette référence.

Description	Nom du module	lien PowerShell Gallery
Module cumulatif pour les applets de commande Power BI	MicrosoftPowerBIMgmt
Module d’administration pour les applets de commande Power BI	MicrosoftPowerBIMgmt.Admin
Module Capacités pour les applets de commande Power BI	MicrosoftPowerBIMgmt.Capacities
Module de données pour les applets de commande Power BI	MicrosoftPowerBIMgmt.Data
Module de profil pour les applets de commande Power BI	MicrosoftPowerBIMgmt.Profile
Module Rapports pour Power BI	MicrosoftPowerBIMgmt.Reports
Module Espaces de travail pour Power BI	MicrosoftPowerBIMgmt.Workspaces

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 plateforme 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

Si vous le souhaitez, vous pouvez installer des modules individuels (en fonction de vos besoins) au lieu du module cumulatif, par exemple si vous souhaitez uniquement le module Espaces de travail :

Install-Module -Name MicrosoftPowerBIMgmt.Workspaces

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

Update-Module -Name MicrosoftPowerBIMgmt

Désinstaller l’interface

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

Usage

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

Une personne est utilisée pour accéder aux entités qui appartiennent à l’utilisateur actuel.
L’organisation est utilisée pour accéder aux entités dans l’ensemble de l’entreprise. Seuls les administrateurs de locataire Power BI sont autorisés à 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 les espaces de travail de l’utilisateur. Par défaut (c’est-à-dire sans -First paramètre), il affiche les 100 premiers espaces de travail affectés à l’utilisateur :

Get-PowerBIWorkspace

Utilisez le -All paramètre pour afficher tous les espaces de travail affecté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

Mettez à 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

Ajoutez 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

Obtenez 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 client :

Get-PowerBIWorkspace -Scope Organization -Deleted -All

Restaurez 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’il n’a pas d’administrateur affecté. Si vous êtes administrateur client, exécutez la commande suivante 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 rapports

Obtenez tous les rapports pour l’utilisateur :

Get-PowerBIReport

Si vous êtes administrateur client, vous pouvez afficher tous les rapports de votre locataire à l’aide de l’attribution -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 locataire en ajoutant -Scope Organization:

Get-PowerBIDashboard -Scope Organization

Obtenir des vignettes

Obtenir des vignettes dans un tableau de bord :

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

Obtenir des importations

Obtenir 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 le ou -Workspace les -WorkspaceId paramètres :

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 ou -Workspace le WorkspaceId paramètre :

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

Obtenir des jeux de données

Obtenir 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

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

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

Obtenir des tables

Obtenir des tables Power BI contenues dans un jeu de données :

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

Appelez l’API Rest Power BI

Pour API Power BI qui ne dispose pas d’applets de commande correspondantes, vous pouvez réutiliser la session authentifiée à partir de Connect-PowerBIServiceAccount laquelle effectuer des 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 retourné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 souhaitez voir certaines fonctionnalités implémentées pour les applets de commande PowerShell pour Power BI, envoyez un problème.

Si votre problème est plus large que les applets de commande PowerShell, envoyez vos commentaires au Communauté Power BI ou au site de support Power BI officiel.

Partager via