Commands › Power BI

Get-PowerBIDashboard

Power BI MicrosoftPowerBIMgmt Get-*

Returns a list of Power BI dashboards.

Quick start script

# Get-PowerBIDashboard — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-PowerBIServiceAccount -ServicePrincipal -CertificateThumbprint $thumb -ApplicationId $appId -Tenant $tenantId

# 2. Run and inspect
Get-PowerBIDashboard -Id <Guid> -Name <String> -Workspace <Workspace> | Format-List

# 3. Export for evidence / drift tracking
Get-PowerBIDashboard | Export-Clixml .\PowerBIDashboard-$(Get-Date -Format yyyyMMdd).xml

Syntax — 6 parameter sets

List (Default)

Get-PowerBIDashboard [-Scope <PowerBIUserScope>] [-Filter <String>] [-First <Int32>] [-Skip <Int32>]
 [-WorkspaceId <Guid>] [<CommonParameters>]

Id

Get-PowerBIDashboard -Id <Guid> [-Scope <PowerBIUserScope>] [-WorkspaceId <Guid>] [<CommonParameters>]

ObjectAndId

Get-PowerBIDashboard -Id <Guid> [-Scope <PowerBIUserScope>] -Workspace <Workspace> [<CommonParameters>]

Name

Get-PowerBIDashboard -Name <String> [-Scope <PowerBIUserScope>] [-WorkspaceId <Guid>] [<CommonParameters>]

2 more parameter sets — see the parameter table below.

Parameters (8)

ParameterTypeRequiredWhat it controls
-Filter String OData filter, case-sensitive (element names start lowercase). Only supported when -Scope Organization is specified.
-First Int32 First (top) list of results.
-Id Guid yes ID of the dashboard to return.
-Name String yes Name of the dashboard to return if one exists with that name. Case insensitive search.
-Scope PowerBIUserScope Indicates the scope of the call. Individual returns only dashboards assigned to the caller; Organization returns all dashboards within a tenant (must be an administrator to initiate). Individual is the default.
-Skip Int32 Skips the first set of results.
-Workspace Workspace yes Workspace to filter results to; only dashboards that belong to that workspace are shown.
-WorkspaceId Guid ID of the workspace to filter results to; only dashboards that belong to that workspace are shown.

Reference facts derived from Microsoft documentation, © Microsoft, licensed MIT; restructured with original guidance by serv365.ai.