Командлеты Microsoft Power BI для Windows PowerShell и PowerShell Core

Статья
05/12/2023

Добро пожаловать в справочник по PowerShell для Microsoft Power BI. Здесь вы найдете ресурсы для модулей PowerShell, предназначенных для Power BI.

Модули PowerShell

Ниже приведена таблица модулей PowerShell Power BI, описанных в этом справочнике.

Описание	Имя модуля	ссылка коллекция PowerShell
Модуль свертки для командлетов Power BI	MicrosoftPowerBIMgmt
модуль Администратор для командлетов Power BI	MicrosoftPowerBIMgmt.Admin
Модуль емкости для командлетов Power BI	MicrosoftPowerBIMgmt.Capacities
Модуль данных для командлетов Power BI	MicrosoftPowerBIMgmt.Data
Модуль профиля для командлетов Power BI	MicrosoftPowerBIMgmt.Profile
Модуль отчетов для Power BI	MicrosoftPowerBIMgmt.Reports
Модуль рабочих областей для Power BI	MicrosoftPowerBIMgmt.Workspaces

Поддерживаемые среды и версии PowerShell

Windows PowerShell версии 3.0 и выше с .NET 4.7.1 или более поздней версии.
PowerShell Core (версия 6) и на любой платформе ОС, поддерживаемой PowerShell Core.

Установка

Командлеты доступны в коллекция PowerShell и могут быть установлены в сеансе PowerShell с повышенными привилегиями:

Install-Module -Name MicrosoftPowerBIMgmt

При необходимости можно установить отдельные модули (в зависимости от ваших потребностей) вместо модуля свертки, например если требуется только модуль Workspaces:

Install-Module -Name MicrosoftPowerBIMgmt.Workspaces

Если у вас более ранняя версия, можно обновить до последней версии, выполнив следующую команду:

Update-Module -Name MicrosoftPowerBIMgmt

Удаление

Если вы хотите удалить все командлеты PowerShell Power BI, выполните следующие действия в сеансе PowerShell с повышенными привилегиями:

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

Использование

Две области поддерживаются командлетами, взаимодействующими с сущностями Power BI:

Отдельный используется для доступа к сущностям, принадлежащим текущему пользователю.
Организация используется для доступа к сущностям всей компании. Использовать могут только администраторы клиента Power BI.

Если параметр -Scope не существует в командлете, сущность не поддерживает API администрирования.

Вход в Power BI

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

Получение рабочих областей

Получение рабочих областей для пользователя. По умолчанию (т. е. без -First параметра) отображаются первые 100 рабочих областей, назначенных пользователю:

Get-PowerBIWorkspace

-All Используйте параметр для отображения всех рабочих областей, назначенных пользователю:

Get-PowerBIWorkspace -All

Если вы являетесь администратором клиента, вы можете просмотреть все рабочие области в клиенте, добавив -Scope Organization:

Get-PowerBIWorkspace -Scope Organization -All

Обновление рабочей области

Обновите имя или описание рабочей области пользователя:

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

Добавление нового пользователя в рабочую область

Добавьте пользователя в определенную рабочую область:

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

Удаление пользователя из заданной рабочей области

Удалите разрешения пользователя из заданной рабочей области:

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

Получение состояния миграции рабочей области

Получите состояние миграции рабочей области Power BI:

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

Восстановление рабочей области

Чтобы просмотреть удаленные рабочие области в качестве администратора клиента, выполните следующие действия.

Get-PowerBIWorkspace -Scope Organization -Deleted -All

Восстановите удаленную рабочую область:

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

Восстановление потерянной рабочей области

Рабочая область становится потерянной, если у нее нет назначенных администраторов. Если вы являетесь администратором клиента, выполните следующую команду, чтобы просмотреть все потерянные рабочие области:

Get-PowerBIWorkspace -Scope Organization -Orphaned -All

Чтобы устранить эту проблему, используйте:

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

Получение отчетов

Получите все отчеты для пользователя:

Get-PowerBIReport

Если вы являетесь администратором клиента, вы можете просматривать все отчеты в клиенте с помощью назначения -Scope Organization:

Get-PowerBIReport -Scope Organization

Получение панелей мониторинга

Получите панели мониторинга для пользователя:

Get-PowerBIDashboard

Если вы являетесь администратором клиента, вы можете просмотреть все панели мониторинга в клиенте, добавив -Scope Organization:

Get-PowerBIDashboard -Scope Organization

Получение плиток

Получение плиток на панели мониторинга:

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

Получение импорта

Получите импорт Power BI:

Get-PowerBIImport

Создание отчета

Создайте отчет в Power BI, отправив файл *.pbix:

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

По умолчанию отчет помещается в мою рабочую область пользователя. Чтобы разместить в другой рабочей области, используйте -WorkspaceId или -Workspace параметры:

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

экспорт отчета;

Экспорт отчета Power BI в файл *.pbix:

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

Если рабочая область существует за пределами "Моя рабочая область", экспортируйте с помощью WorkspaceId или -Workspace параметра:

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

Получение наборов данных

Получите наборы данных Power BI:

Get-PowerBIDataset

Обновление режима хранения набора данных

Задайте для набора данных Power BI использование файлов класса Premium для режима хранения:

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

Получение источников данных

Получите источники данных Power BI для набора данных:

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

Получение таблиц

Получение таблиц Power BI, содержащихся в наборе данных:

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

Вызов REST API в Power BI

Для API Power BI, не имеющих соответствующих командлетов, можно повторно использовать сеанс, прошедший проверку подлинности, для Connect-PowerBIServiceAccount выполнения пользовательских запросов REST:

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)

Если вы хотите использовать сеанс с проверкой подлинности за пределами PowerShell, получите маркер доступа с помощью:

Get-PowerBIAccessToken -AsString

Устранение ошибок

Чтобы получить дополнительные сведения об ошибке, возвращенной командлетами, используйте следующую команду:

Resolve-PowerBIError -Last

Эти сведения могут быть полезны для открытия запросов в службу поддержки для Power BI.

Проблемы и отзывы

Если вы обнаружите какие-либо ошибки или хотите увидеть определенные функциональные возможности, реализованные для командлетов PowerShell для Power BI, сообщите о проблеме.

Если проблема шире, чем только командлеты PowerShell, отправьте свой отзыв на Сообщество Power BI или официальный сайт поддержки Power BI.

Поделиться через