Microsoft Power BI-cmdletar för Windows PowerShell och PowerShell Core
Välkommen till PowerShell-referensen för Microsoft Power BI. Här hittar du resurser för PowerShell-moduler som är inriktade på Power BI.
PowerShell-moduler
Nedan visas en tabell över Power BI PowerShell-modulerna som beskrivs i den här referensen.
Description | Modulnamn | PowerShell-galleriet länk |
---|---|---|
Sammanslagningsmodul för Power BI-cmdletar | MicrosoftPowerBIMgmt | |
Admin modul för Power BI-cmdletar | MicrosoftPowerBIMgmt.Admin | |
Kapacitetsmodul för Power BI-cmdletar | MicrosoftPowerBIMgmt.Capacities | |
Datamodul för Power BI-cmdletar | MicrosoftPowerBIMgmt.Data | |
Profilmodul för Power BI-cmdletar | MicrosoftPowerBIMgmt.Profile | |
Rapportmodul för Power BI | MicrosoftPowerBIMgmt.Reports | |
Modulen Arbetsytor för Power BI | MicrosoftPowerBIMgmt.Workspaces |
Miljöer som stöds och PowerShell-versioner
- Windows PowerShell v3.0 och upp med .NET 4.7.1 eller senare.
- PowerShell Core (v6) och upp på valfri os-plattform som stöds av PowerShell Core.
Installation
Cmdletarna är tillgängliga på PowerShell-galleriet och kan installeras i en upphöjd PowerShell-session:
Install-Module -Name MicrosoftPowerBIMgmt
Du kan också installera enskilda moduler (baserat på dina behov) i stället för sammanslagningsmodulen, till exempel om du bara vill ha modulen Arbetsytor:
Install-Module -Name MicrosoftPowerBIMgmt.Workspaces
Om du har en tidigare version kan du uppdatera till den senaste versionen genom att köra:
Update-Module -Name MicrosoftPowerBIMgmt
Avinstallera
Om du vill avinstallera alla Power BI PowerShell-cmdletar kör du följande i en upphöjd PowerShell-session:
Get-Module MicrosoftPowerBIMgmt* -ListAvailable | Uninstall-Module -Force
Användning
Två omfång stöds av cmdletar som interagerar med Power BI-entiteter:
- Enskilda används för att komma åt entiteter som tillhör den aktuella användaren.
- Organisationen används för att komma åt entiteter i hela företaget. Endast Power BI-klientadministratörer får använda.
Om parametern -Scope inte finns på cmdleten stöder inte entiteten något administrativt API.
Logga in på Power BI
Connect-PowerBIServiceAccount # or use aliases: Login-PowerBIServiceAccount, Login-PowerBI
Hämta arbetsytor
Hämta arbetsytor för användaren. Som standard (dvs. utan -First
parameter) visas de första 100 arbetsytorna som tilldelats användaren:
Get-PowerBIWorkspace
Använd parametern -All
för att visa alla arbetsytor som tilldelats användaren:
Get-PowerBIWorkspace -All
Om du är innehavaradministratör kan du visa alla arbetsytor i klientorganisationen genom att lägga till -Scope Organization
:
Get-PowerBIWorkspace -Scope Organization -All
Uppdatera en arbetsyta
Uppdatera namnet eller beskrivningen av en användares arbetsyta:
Set-PowerBIWorkspace -Scope Organization -Id "3244f1c1-01cf-457f-9383-6035e4950fdc" -Name "Test Name" -Description "Test Description"
Lägga till en ny användare i en arbetsyta
Lägg till en användare i en viss arbetsyta:
Add-PowerBIWorkspaceUser -Scope Organization -Id 3244f1c1-01cf-457f-9383-6035e4950fdc -UserEmailAddress john@contoso.com -AccessRight Admin
Ta bort en användare från en viss arbetsyta
Ta bort användarens behörigheter från en viss arbetsyta:
Remove-PowerBIWorkspaceUser -Scope Organization -Id 3244f1c1-01cf-457f-9383-6035e4950fdc -UserEmailAddress john@contoso.com
Hämta status för migrering av arbetsyta
Hämta migreringsstatus för Power BI-arbetsytan:
Get-PowerBIWorkspaceMigrationStatus -Id 038f9a64-1fcd-42f2-957a-13a63b3d3235
Återställa en arbetsyta
Så här visar du borttagna arbetsytor som innehavaradministratör:
Get-PowerBIWorkspace -Scope Organization -Deleted -All
Återställa en borttagen arbetsyta:
Restore-PowerBIWorkspace -Id "3244f1c1-01cf-457f-9383-6035e4950fdc" -RestoredName "TestWorkspace" -AdminEmailAddress "john@contoso.com"
Återställa en överbliven arbetsyta
En arbetsyta blir överbliven när den inte har några tilldelade administratörer. Om du är klientadministratör kör du följande för att visa alla överblivna arbetsytor:
Get-PowerBIWorkspace -Scope Organization -Orphaned -All
Åtgärda problemet genom att använda:
Add-PowerBIWorkspaceUser -Scope Organization -Id f2a0fae5-1c37-4ee6-97da-c9d31851fe17 -UserPrincipalName 'john@contoso.com' -AccessRight Admin
Hämta rapporter
Hämta alla rapporter för användaren:
Get-PowerBIReport
Om du är innehavaradministratör kan du visa alla rapporter i din klientorganisation genom att -Scope Organization
tilldela :
Get-PowerBIReport -Scope Organization
Hämta instrumentpaneler
Hämta instrumentpaneler för användaren:
Get-PowerBIDashboard
Om du är innehavaradministratör kan du visa alla instrumentpaneler i din klient genom att lägga till -Scope Organization
:
Get-PowerBIDashboard -Scope Organization
Hämta paneler
Hämta paneler på en instrumentpanel:
Get-PowerBITile -DashboardId 9a58d5e5-61bc-447c-86c4-e221128b1c99
Hämta importer
Hämta Power BI-importer:
Get-PowerBIImport
Skapa en rapport
Skapa en rapport i Power BI genom att ladda upp en *.pbix-fil:
New-PowerBIReport -Path .\newReport.pbix -Name 'New Report'
Som standard placeras rapporten i användarens Min arbetsyta. Om du vill placera på en annan arbetsyta använder du parametrarna -WorkspaceId
eller -Workspace
:
New-PowerBIReport -Path .\newReport.pbix -Name 'New Report' -WorkspaceId f95755a1-950c-46bd-a912-5aab4012a06d
Exportera en rapport
Exportera en Power BI-rapport till *.pbix-filen:
Export-PowerBIReport -Id b48c088c-6f4e-4b7a-b015-d844ab534b2a -OutFile .\exportedReport.pbix
Om arbetsytan finns utanför Min arbetsyta exporterar du med parametern WorkspaceId
eller -Workspace
:
Export-PowerBIReport -Id b48c088c-6f4e-4b7a-b015-d844ab534b2a -OutFile .\exportedReport.pbix -WorkspaceId 3bdd9735-0ab5-4f21-bd5d-87e7f1d7fb84
Hämta datauppsättningar
Hämta Power BI-datauppsättningar:
Get-PowerBIDataset
Uppdatera lagringsläge för datauppsättning
Ange att Power BI-datauppsättningen ska använda Premium Files för lagringsläge:
Set-PowerBIDataset -Id 038f9a64-1fcd-42f2-957a-13a63b3d3235 -TargetStorageMode PremiumFiles
Hämta datakällor
Hämta Power BI-datakällor för en datauppsättning:
Get-PowerBIDatasource -DatasetId 65d7d7e5-8af0-4e94-b20b-50a882ae15e1
Hämta tabeller
Hämta Power BI-tabeller som finns i en datauppsättning:
Get-PowerBITable -DatasetId 65d7d7e5-8af0-4e94-b20b-50a882ae15e1
Anropa REST-API:et för Power BI
För Power BI-API som saknar motsvarande cmdletar kan du återanvända den autentiserade sessionen från Connect-PowerBIServiceAccount
för att göra anpassade REST-begäranden:
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)
Om du vill använda den autentiserade sessionen utanför PowerShell hämtar du åtkomsttoken med hjälp av:
Get-PowerBIAccessToken -AsString
Felsöka fel
Om du vill få mer information om ett fel som returneras från cmdletarna använder du:
Resolve-PowerBIError -Last
Den här informationen kan vara användbar för att öppna supportärenden för Power BI.
Problem och feedback
Om du hittar några buggar eller vill se vissa funktioner implementerade för PowerShell-cmdletar för Power BI kan du skapa ett problem.
Om problemet är bredare än bara PowerShell-cmdletarna skickar du feedback till Power BI Community eller den officiella Power BI-supportwebbplatsen.