Cmdlets de Microsoft Power BI para Windows PowerShell y PowerShell Core

Artículo
05/12/2023

Bienvenido a la referencia de PowerShell para Microsoft Power BI. Aquí encontrará recursos para los módulos de PowerShell destinados a Power BI.

Módulos de PowerShell

A continuación se muestra una tabla de los módulos de PowerShell de Power BI que se tratan en esta referencia.

Descripción	Nombre del módulo	vínculo de Galería de PowerShell
Módulo acumulativo de cmdlets de Power BI	MicrosoftPowerBIMgmt
módulo Administración para cmdlets de Power BI	MicrosoftPowerBIMgmt.Admin
Módulo Capacidades para cmdlets de Power BI	MicrosoftPowerBIMgmt.Capacities
Módulo de datos para cmdlets de Power BI	MicrosoftPowerBIMgmt.Data
Módulo de perfil para cmdlets de Power BI	MicrosoftPowerBIMgmt.Profile
Módulo de informes para Power BI	MicrosoftPowerBIMgmt.Reports
Módulo Áreas de trabajo para Power BI	MicrosoftPowerBIMgmt.Workspaces

Entornos admitidos y versiones de PowerShell

Windows PowerShell v3.0 y versiones posteriores con .NET 4.7.1 o superior.
PowerShell Core (v6) y versiones posteriores en cualquier plataforma del sistema operativo compatible con PowerShell Core.

Instalación

Los cmdlets están disponibles en Galería de PowerShell y se pueden instalar en una sesión de PowerShell con privilegios elevados:

Install-Module -Name MicrosoftPowerBIMgmt

Opcionalmente, puede instalar módulos individuales (según sus necesidades) en lugar del módulo acumulativo, por ejemplo, si solo quería el módulo Áreas de trabajo:

Install-Module -Name MicrosoftPowerBIMgmt.Workspaces

Si tiene una versión anterior, puede actualizar a la versión más reciente ejecutando:

Update-Module -Name MicrosoftPowerBIMgmt

Desinstalación

Si desea desinstalar todos los cmdlets de PowerShell de Power BI, ejecute lo siguiente en una sesión de PowerShell con privilegios elevados:

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

Uso

Los cmdlets que interactúan con entidades de Power BI admiten dos ámbitos:

Individual se usa para acceder a las entidades que pertenecen al usuario actual.
La organización se usa para acceder a entidades en toda la empresa. Solo los administradores de inquilinos de Power BI pueden usarse.

Si el parámetro -Scope no existe en el cmdlet , la entidad no admite una API administrativa.

Inicio de sesión en Power BI

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

Obtención de áreas de trabajo

Obtenga áreas de trabajo para el usuario. De forma predeterminada (es decir, sin -First parámetro) muestra las 100 primeras áreas de trabajo asignadas al usuario:

Get-PowerBIWorkspace

Use el -All parámetro para mostrar todas las áreas de trabajo asignadas al usuario:

Get-PowerBIWorkspace -All

Si es administrador de inquilinos, puede ver todas las áreas de trabajo del inquilino agregando -Scope Organization:

Get-PowerBIWorkspace -Scope Organization -All

Actualización de un área de trabajo

Actualice el nombre o la descripción del área de trabajo de un usuario:

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

Adición de un nuevo usuario a un área de trabajo

Agregue un usuario a un área de trabajo determinada:

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

Eliminación de un usuario de un área de trabajo determinada

Quite los permisos del usuario de un área de trabajo determinada:

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

Obtención del estado de migración del área de trabajo

Obtenga el estado de migración del área de trabajo de Power BI:

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

Restauración de un área de trabajo

Para ver las áreas de trabajo eliminadas como administrador de inquilinos:

Get-PowerBIWorkspace -Scope Organization -Deleted -All

Restaurar un área de trabajo eliminada:

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

Recuperación de un área de trabajo huérfana

Un área de trabajo se vuelve huérfana cuando no tiene administradores asignados. Si es administrador de inquilinos, ejecute lo siguiente para ver todas las áreas de trabajo huérfanas:

Get-PowerBIWorkspace -Scope Organization -Orphaned -All

Para corregir este problema, use:

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

Obtener informes

Obtenga todos los informes para el usuario:

Get-PowerBIReport

Si es administrador de inquilinos, puede ver todos los informes del inquilino mediante la asignación de -Scope Organization:

Get-PowerBIReport -Scope Organization

Obtención de paneles

Obtenga paneles para el usuario:

Get-PowerBIDashboard

Si es administrador de inquilinos, puede ver todos los paneles del inquilino agregando -Scope Organization:

Get-PowerBIDashboard -Scope Organization

Obtención de iconos

Obtener iconos dentro de un panel:

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

Obtener importaciones

Obtener importaciones de Power BI:

Get-PowerBIImport

Creación de un informe

Cree un informe en Power BI cargando un archivo *.pbix:

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

De forma predeterminada, el informe se coloca en mi área de trabajo del usuario. Para colocar en un área de trabajo diferente, use los -WorkspaceId parámetros o -Workspace :

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

Exportar un informe

Exporte un informe de Power BI al archivo *.pbix:

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

Si el área de trabajo existe fuera de Mi área de trabajo, exporte con el WorkspaceId parámetro o -Workspace :

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

Obtener conjuntos de datos

Obtener conjuntos de datos de Power BI:

Get-PowerBIDataset

Actualizar el modo de almacenamiento del conjunto de datos

Establezca el conjunto de datos de Power BI para usar archivos Premium para el modo de almacenamiento:

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

Obtención de orígenes de datos

Obtenga orígenes de datos de Power BI para un conjunto de datos:

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

Obtener tablas

Obtenga las tablas de Power BI contenidas en un conjunto de datos:

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

Llamada a la API de REST de Power BI

Para API de Power BI que carece de los cmdlets correspondientes, puede reutilizar la sesión autenticada desde Connect-PowerBIServiceAccount para realizar solicitudes 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)

Si desea usar la sesión autenticada fuera de PowerShell, obtenga el token de acceso mediante:

Get-PowerBIAccessToken -AsString

Solucionar errores

Para obtener más información sobre un error devuelto desde los cmdlets, use:

Resolve-PowerBIError -Last

Esta información puede ser útil para abrir incidencias de soporte técnico para Power BI.

Problemas y comentarios

Si encuentra algún error o desea ver ciertas funcionalidades implementadas para los cmdlets de PowerShell para Power BI, envíe un problema.

Si el problema es más amplio que solo los cmdlets de PowerShell, envíe sus comentarios al Comunidad de Power BI o al sitio oficial de soporte técnico de Power BI.

Compartir a través de