Microsoft Power BI PowerShell

repository·master·Indexed 19 days ago

https://github.com/microsoft/powerbi-powershell

PowerShell interface for managing Power BI resources, including workspaces, reports, datasets, and dashboards. Provides the MicrosoftPowerBIMgmt module for individual user management and tenant-wide administration, including tools for dataflow import/export, workspace restoration, and direct Power BI REST API calls via Invoke-PowerBIRestMethod.

Tokens: 31.5K
Snippets: 130
Records: 163
Agent score: 56%

What's inside microsoft-powerbi-powershell

Overview of the MicrosoftPowerBIMgmt.Data Module
master
The MicrosoftPowerBIMgmt.Data module provides PowerShell cmdlets specifically designed for managing and interacting with Power BI datasets, data sources, dataflows, and tables. It allows for programmatic manipulation of data structures within the Power BI service, including adding rows, creating columns, and exporting dataflow definitions.
https://github.com/microsoft/powerbi-powershell/blob/master/src/Modules/Data/Commands.Data/help/MicrosoftPowerBIMgmt.Data.md
Overview of the MicrosoftPowerBIMgmt.Admin Module
master
The MicrosoftPowerBIMgmt.Admin module provides PowerShell cmdlets designed for performing administrative tasks across the Power BI service. It is primarily used for tenant-level administration, including managing encryption keys for workspaces and capacities, and retrieving audit activity events.
https://github.com/microsoft/powerbi-powershell/blob/master/src/Modules/Admin/Commands.Admin/help/MicrosoftPowerBIMgmt.Admin.md
Manage Power BI reports with MicrosoftPowerBIMgmt.Reports
master
The MicrosoftPowerBIMgmt.Reports module provides PowerShell cmdlets for managing and interacting with Power BI reports, dashboards, tiles, and imports. Use this module to automate tasks such as creating, copying, exporting, and deleting report assets within your Power BI environment.
https://github.com/microsoft/powerbi-powershell/blob/master/src/Modules/Reports/Commands.Reports/help/MicrosoftPowerBIMgmt.Reports.md
Manage Power BI service connections with MicrosoftPowerBIMgmt.Profile
master
The MicrosoftPowerBIMgmt.Profile module provides the core cmdlets required to manage authentication and connectivity to the Power BI service. It handles logging in, logging out, retrieving authentication tokens, and executing direct REST API calls.
https://github.com/microsoft/powerbi-powershell/blob/master/src/Modules/Profile/Commands.Profile/help/MicrosoftPowerBIMgmt.Profile.md
Manage Power BI workspaces with MicrosoftPowerBIMgmt.Workspaces
master
The MicrosoftPowerBIMgmt.Workspaces module provides PowerShell cmdlets specifically designed for managing and interacting with Power BI workspaces. This includes creating new workspaces, retrieving lists of existing workspaces, updating workspace settings, and managing user permissions (adding or removing users, service principals, or groups).
https://github.com/microsoft/powerbi-powershell/blob/master/src/Modules/Workspaces/Commands.Workspaces/help/MicrosoftPowerBIMgmt.Workspaces.md
Manage Power BI capacities with MicrosoftPowerBIMgmt.Capacities
master
The MicrosoftPowerBIMgmt.Capacities module provides PowerShell cmdlets specifically designed for managing and interacting with Power BI capacities. This module allows administrators to programmatically retrieve and manage capacity resources within their Power BI environment.
https://github.com/microsoft/powerbi-powershell/blob/master/src/Modules/Capacities/Commands.Capacities/help/MicrosoftPowerBIMgmt.Capacities.md
Include workspace artifacts (Reports, Dashboards, etc.)
master
When the -Scope is set to Organization, you can use the -Include parameter to retrieve related artifacts associated with the workspaces.
Supported Artifact Types:
- Reports
- Dashboards
- Datasets
- Dataflows
- Workbooks
- All
```
Get-PowerBIWorkspace -Scope Organization -Include All
```
https://github.com/microsoft/powerbi-powershell/blob/master/src/Modules/Workspaces/Commands.Workspaces/help/Get-PowerBIWorkspace.md
Configure the scope for Get-PowerBIImport
master
The -Scope parameter determines the breadth of the search.
- Individual (Default): Returns only imports assigned to the calling user.
- Organization: Returns all imports within the tenant. Note: You must be an administrator to use this scope.
When using -Scope Organization, you can also use the -Filter parameter to apply an OData filter (case-sensitive, element names must start with lowercase).
```
# Get imports for the current user
Get-PowerBIImport -Scope Individual

# Get all imports in the organization (requires admin rights)
Get-PowerBIImport -Scope Organization
```
https://github.com/microsoft/powerbi-powershell/blob/master/src/Modules/Reports/Commands.Reports/help/Get-PowerBIImport.md
Configure the scope of Get-PowerBIReport
master
The -Scope parameter determines the breadth of the report search:
- Individual (Default): Returns only reports assigned to the caller.
- Organization: Returns all reports within the tenant. Note: You must be an administrator to use this scope.
```
Get-PowerBIReport -Scope Organization
```
https://github.com/microsoft/powerbi-powershell/blob/master/src/Modules/Reports/Commands.Reports/help/Get-PowerBIReport.md
Understand Power BI cmdlet scopes: Individual vs Organization
master
Cmdlets that interact with Power BI entities support two primary scopes:
- Individual: Used to access entities that belong to the current authenticated user.
- Organization: Used to access entities across the entire company. This scope is only available to Power BI tenant administrators.
If a cmdlet does not have a -Scope parameter, it means the entity it manages does not support an Administrative API.
https://github.com/microsoft/powerbi-powershell/blob/master/README.md
Configure the scope for Get-PowerBIDashboard
master
The -Scope parameter determines the breadth of the dashboard search:
- Individual (Default): Returns only dashboards assigned to the calling user.
- Organization: Returns all dashboards within the tenant. This requires administrator privileges.
Note: The -Filter parameter is only supported when -Scope is set to Organization.
```
# Returns a dashboard named 'Contoso Sales' within the organization
Get-PowerBIDashboard -Scope Organization -Name 'Contoso Sales'
```
https://github.com/microsoft/powerbi-powershell/blob/master/src/Modules/Reports/Commands.Reports/help/Get-PowerBIDashboard.md
Uninstall MicrosoftPowerBIMgmt module
master
To remove all Power BI PowerShell cmdlets from your system, run the following command in an elevated PowerShell session.
```
Get-Module MicrosoftPowerBIMgmt* -ListAvailable | Uninstall-Module -Force
```
https://github.com/microsoft/powerbi-powershell/blob/master/examples/dataflows/README.md