Cmdlets do Microsoft Power BI para Windows PowerShell e PowerShell Core

Bem-vindo à referência do PowerShell para o Microsoft Power BI. Aqui você encontrará recursos para módulos do PowerShell direcionados ao Power BI.

Módulos do PowerShell

Abaixo está uma tabela dos módulos do PowerShell do Power BI abordados nesta referência.

Descrição	Nome do Módulo	Link da Galeria do PowerShell
Módulo de acúmulo para cmdlets do Power BI	NA
Módulo de administração para cmdlets do Power BI	MicrosoftPowerBIMgmt.Admin Module
Módulo Capacidades para Cmdlets do Power BI	MicrosoftPowerBIMgmt.Capacities Module
Módulo de dados para cmdlets do Power BI	MicrosoftPowerBIMgmt.Data Module
Módulo de perfil para cmdlets do Power BI	MicrosoftPowerBIMgmt.Profile Module
Módulo de relatórios para Power BI	MicrosoftPowerBIMgmt.Reports Module
Módulo de espaços de trabalho para Power BI	MicrosoftPowerBIMgmt.Workspaces Module

Ambientes com suporte e versões do PowerShell

• Windows PowerShell v3.0 e superior com .NET 4.7.1 ou superior.
• PowerShell Core (v6) e superior em qualquer plataforma de sistema operacional compatível com o PowerShell Core.

Instalação

Os cmdlets estão disponíveis na Galeria do PowerShell e podem ser instalados em uma sessão do PowerShell com privilégios elevados:

Install-Module -Name MicrosoftPowerBIMgmt

Opcionalmente, você pode instalar módulos individuais (com base em suas necessidades) em vez do módulo cumulativo, por exemplo, se quiser apenas o módulo Workspaces:

Install-Module -Name MicrosoftPowerBIMgmt.Workspaces

Se você tiver uma versão anterior, poderá atualizar para a versão mais recente executando:

Update-Module -Name MicrosoftPowerBIMgmt

Desinstalar

Se você quiser desinstalar todos os cmdlets do PowerShell do Power BI, execute o seguinte em uma sessão do PowerShell com privilégios elevados:

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

Uso

Há suporte para dois escopos por cmdlets que interagem com entidades do Power BI:

• Individual é usado para acessar entidades que pertencem ao usuário atual.
• A organização é usada para acessar entidades em toda a empresa. Somente administradores de locatários do Power BI têm permissão para usar.

Se o parâmetro -Scope não existir no cmdlet, a entidade não dará suporte a uma API Administrativa.

Faça logon no Power BI

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

Obter espaços de trabalho

Obtenha espaços de trabalho para o usuário. Por padrão (ou seja, sem -First parâmetro), ele mostra os primeiros 100 espaços de trabalho atribuídos ao usuário:

Get-PowerBIWorkspace

Use o -All parâmetro para mostrar todos os espaços de trabalho atribuídos ao usuário:

Get-PowerBIWorkspace -All

Se você for um administrador de locatários, poderá exibir todos os workspaces em seu locatário adicionando -Scope Organization:

Get-PowerBIWorkspace -Scope Organization -All

Atualizar um espaço de trabalho

Atualize o nome ou a descrição do espaço de trabalho de um usuário:

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

Adicionar um novo usuário a um workspace

Adicione um usuário a um determinado espaço de trabalho:

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

Remover um usuário de um determinado workspace

Remova as permissões do usuário de um determinado espaço de trabalho:

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

Obter status de migração do workspace

Obtenha o status de migração do espaço de trabalho do Power BI:

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

Restaurar um workspace

Para exibir workspaces excluídos como administrador de locatários:

Get-PowerBIWorkspace -Scope Organization -Deleted -All

Restaurar um espaço de trabalho excluído:

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

Recuperar um espaço de trabalho órfão

Um espaço de trabalho torna-se órfão quando não tem administradores atribuídos. Se você for um administrador de locatários, execute o seguinte para exibir todos os workspaces órfãos:

Get-PowerBIWorkspace -Scope Organization -Orphaned -All

Para corrigir esse problema, use:

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

Obter relatórios

Obtenha todos os relatórios para o usuário:

Get-PowerBIReport

Se você for um administrador de locatários, poderá exibir todos os relatórios em seu locatário usando a atribuição -Scope Organization:

Get-PowerBIReport -Scope Organization

Obter painéis

Obtenha painéis para o usuário:

Get-PowerBIDashboard

Se você for um administrador de locatários, poderá exibir todos os painéis em seu locatário adicionando -Scope Organization:

Get-PowerBIDashboard -Scope Organization

Obter blocos

Obter blocos em um painel:

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

Obter importações

Obtenha importações do Power BI:

Get-PowerBIImport

Criar um relatório

Crie um relatório no Power BI carregando um arquivo *.pbix:

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

Por padrão, o relatório é colocado no Meu Espaço de Trabalho do usuário. Para colocar em um espaço de trabalho diferente, use os -WorkspaceId parâmetros ou -Workspace :

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

Exportar um relatório

Exporte um relatório do Power BI para o arquivo *.pbix:

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

Se o espaço de trabalho existir fora do Meu espaço de trabalho, exporte com o WorkspaceId parâmetro ou -Workspace :

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

Obter conjuntos de dados

Obter conjuntos de dados do Power BI:

Get-PowerBIDataset

Atualizar o modo de armazenamento do conjunto de dados

Defina o conjunto de dados do Power BI para usar Arquivos Premium para o modo de armazenamento:

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

Obter fontes de dados

Obtenha fontes de dados do Power BI para um conjunto de dados:

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

Obter tabelas

Obtenha tabelas do Power BI contidas em um conjunto de dados:

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

Chamar a API REST do Power BI

Para a API do Power BI que não possui cmdlets correspondentes, você pode reutilizar a sessão autenticada para Connect-PowerBIServiceAccount fazer solicitações REST personalizadas:

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)

Se você quiser usar a sessão autenticada fora do PowerShell, obtenha o token de acesso usando:

Get-PowerBIAccessToken -AsString

Solucionando erros

Para obter mais informações sobre um erro retornado dos cmdlets, use:

Resolve-PowerBIError -Last

Essas informações podem ser úteis para abrir tíquetes de suporte para o Power BI.

Problemas e comentários

Se você encontrar algum bug ou quiser ver determinada funcionalidade implementada para os Cmdlets do PowerShell para Power BI, registre um problema.

Se o problema for mais amplo do que apenas os cmdlets do PowerShell, envie seus comentários para a Comunidade do Power BI ou para o site oficial de Suporte do Power BI .