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

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

Модули PowerShell

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

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

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

• Windows PowerShell v3.0 и более поздних версий с .NET 4.7.1 или более поздней версии.
• PowerShell Core (v6) и более поздних версий на любой платформе ОС, поддерживаемой 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, поддерживают две области:

• Individual используется для доступа к сущностям, принадлежащим текущему пользователю.
• Организация используется для доступа к сущностям в масштабах всей компании. Использовать могут только администраторы клиентов 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 параметры or -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

Если рабочая область существует за пределами раздела "Моя рабочая область", выполните экспорт с параметром or 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 .