Cmdlets Microsoft Power BI para Windows PowerShell e PowerShell Core

Artigo
05/12/2023

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

Módulos do PowerShell

Abaixo está uma tabela dos módulos PowerShell PowerShell de potência cobertos nesta referência.

Description	Nome do Módulo	Galeria do PowerShell link
Módulo rollup para cmdlets Power BI	MicrosoftPowerBIMgmt
Administração módulo para Cmdlets Power BI	MicrosoftPowerBIMgmt.Admin
Módulo de capacidades para cmdlets Power BI	MicrosoftPowerBIMgmt.Capacities
Módulo de dados para Cmdlets Power BI	MicrosoftPowerBIMgmt.Data
Módulo de perfil para Cmdlets Power BI	MicrosoftPowerBIMgmt.Profile
Módulo de relatórios para Power BI	MicrosoftPowerBIMgmt.Reports
Módulo de espaços de trabalho para Power BI	MicrosoftPowerBIMgmt.Workspaces

Ambientes suportados e versões PowerShell

Windows PowerShell v3.0 e até .NET 4.7.1 ou superior.
PowerShell Core (v6) e em qualquer plataforma DES suportada pelo PowerShell Core.

Instalação

Os cmdlets estão disponíveis em Galeria do PowerShell e podem ser instalados numa sessão elevada da PowerShell:

Install-Module -Name MicrosoftPowerBIMgmt

Opcionalmente, pode instalar módulos individuais (com base nas suas necessidades) em vez do módulo rollup, por exemplo, se quisesse apenas o módulo Workspaces:

Install-Module -Name MicrosoftPowerBIMgmt.Workspaces

Se tiver uma versão anterior, pode atualizar para a versão mais recente executando:

Update-Module -Name MicrosoftPowerBIMgmt

Desinstalar

Se pretender desinstalar todos os cmdlets PowerShell powershell powershell, execute o seguinte numa sessão powerShell elevada:

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

Utilização

Dois âmbitos são suportados por cmdlets que interagem com entidades do Power BI:

O indivíduo é utilizado para aceder a entidades que pertencem ao utilizador atual.
A organização é usada para aceder a entidades em toda a empresa. Apenas os administradores inquilinos do Power BI podem ser utilizados.

Se o parâmetro -Âmbito não existir no cmdlet, a entidade não suporta uma API Administrativa.

Iniciar sessão no Power BI

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

Obtenha espaços de trabalho

Obtenha espaços de trabalho para o utilizador. Por padrão (isto é, sem -First parâmetro) mostra os primeiros 100 espaços de trabalho atribuídos ao utilizador:

Get-PowerBIWorkspace

Utilize o -All parâmetro para mostrar todos os espaços de trabalho atribuídos ao utilizador:

Get-PowerBIWorkspace -All

Se você é um administrador de inquilino, você pode ver todos os espaços de trabalho no seu inquilino adicionando -Scope Organization:

Get-PowerBIWorkspace -Scope Organization -All

Atualizar um espaço de trabalho

Atualizar o nome ou descrição do espaço de trabalho de um utilizador:

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

Adicione um novo utilizador a um espaço de trabalho

Adicione um utilizador a um determinado espaço de trabalho:

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

Remova um utilizador de um determinado espaço de trabalho

Remova as permissões do utilizador de um determinado espaço de trabalho:

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

Obtenha o estado de migração do espaço de trabalho

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

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

Restaurar um espaço de trabalho

Para ver espaços de trabalho apagados como administrador de inquilinos:

Get-PowerBIWorkspace -Scope Organization -Deleted -All

Restaurar um espaço de trabalho eliminado:

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 fica órfão quando não tem administradores designados. Se você é um administrador de inquilino, executar o seguinte para ver todos os espaços de trabalho órfãos:

Get-PowerBIWorkspace -Scope Organization -Orphaned -All

Para corrigir esta questão, utilize:

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

Obtenha relatórios

Obtenha todos os relatórios para o utilizador:

Get-PowerBIReport

Se você é um administrador de inquilino, você pode ver todos os relatórios no seu inquilino usando a -Scope Organizationatribuição :

Get-PowerBIReport -Scope Organization

Obter painéis

Obtenha dashboards para o utilizador:

Get-PowerBIDashboard

Se você é um administrador de inquilino, você pode ver todos os dashboards no seu inquilino adicionando -Scope Organization:

Get-PowerBIDashboard -Scope Organization

Obter azulejos

Obter azulejos dentro de um painel:

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

Obter importações

Obtenha importações de Power BI:

Get-PowerBIImport

Criar um relatório

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

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

Por predefinição, o relatório é colocado no Espaço de Trabalho do utilizador. Para colocar num espaço de trabalho diferente, utilize os -WorkspaceId parâmetros ou -Workspace parâmetros:

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

Exportar um relatório

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

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

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

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

Obter conjuntos de dados

Obtenha conjuntos de dados power bi:

Get-PowerBIDataset

Atualizar o modo de armazenamento de conjuntos de dados

Defina o conjunto de dados power bi para utilizar ficheiros Premium para o modo de armazenamento:

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

Obter fontes de dados

Obtenha fontes de dados power bi para um conjunto de dados:

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

Obter mesas

Obtenha as tabelas Power BI contidas num conjunto de dados:

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

Chamar a API REST do Power BI

Para API Power BI que não tenha cmdlets correspondentes, pode reutilizar a sessão Connect-PowerBIServiceAccount autenticada para fazer pedidos de DESCANSO personalizados:

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 pretender utilizar a sessão autenticada fora do PowerShell, obtenha o token de acesso utilizando:

Get-PowerBIAccessToken -AsString

Resolução de erros

Para obter mais informações sobre um erro devolvido dos cmdlets, utilize:

Resolve-PowerBIError -Last

Estas informações podem ser úteis para abrir bilhetes de apoio para o Power BI.

Questões e feedback

Se encontrar algum bug ou quiser ver certas funcionalidades implementadas para os Cmdlets PowerShell para Power BI, por favor , preencha um problema.

Se o seu problema for mais amplo do que apenas os cmdlets PowerShell, por favor envie o seu feedback para o Comunidade do Power BI ou para o site oficial de Suporte do BI de Energia.

Partilhar via