Get-PowerBIDashboard

NAME Get-PowerBIDashboard



SYNOPSIS

Returns a list of Power BI dashboards.





SYNTAX

Get-PowerBIDashboard [-Filter <String>] [-First <Int32>] [-Scope {Individual | Organization}] [-Skip <Int32>]

[-WorkspaceId <Guid>] [<CommonParameters>]



Get-PowerBIDashboard [-Filter <String>] [-First <Int32>] [-Scope {Individual | Organization}] [-Skip <Int32>]

-Workspace <Workspace> [<CommonParameters>]



Get-PowerBIDashboard -Id <Guid> [-Scope {Individual | Organization}] [-WorkspaceId <Guid>] [<CommonParameters>]



Get-PowerBIDashboard -Id <Guid> [-Scope {Individual | Organization}] -Workspace <Workspace> [<CommonParameters>]



Get-PowerBIDashboard -Name <String> [-Scope {Individual | Organization}] [-WorkspaceId <Guid>] [<CommonParameters>]



Get-PowerBIDashboard -Name <String> [-Scope {Individual | Organization}] -Workspace <Workspace>

[<CommonParameters>]





DESCRIPTION

Retrieves a list of Power BI dashboards that match the specified search criteria and scope. Before you run this

command, make sure you log in using Connect-PowerBIServiceAccount.





PARAMETERS

-Filter <String>

OData filter, case-sensitive (element names start lowercase). Only supported when -Scope Organization is

specified.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-First <Int32>

First (top) list of results.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Id <Guid>

ID of the dashboard to return.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

Name of the dashboard to return if one exists with that name. Case insensitive search.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Skip <Int32>

Skips the first set of results.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Workspace <Workspace>

Workspace to filter results to; only dashboards that belong to that workspace are shown.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-WorkspaceId <Guid>

ID of the workspace to filter results to; only dashboards that belong to that workspace are shown.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None







OUTPUTS

System.Collections.Generic.IEnumerable`1[[Microsoft.PowerBI.Common.Api.Reports.Dashboard,

Microsoft.PowerBI.Common.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]







NOTES









-------------------------- Example 1 --------------------------



PS C:\\> Get-PowerBIDashboard



Returns all Power BI dashboards that the calling user is assigned to (-Scope Individual).

-------------------------- Example 2 --------------------------



PS C:\\> Get-PowerBIDashboard -Scope Organization -Name 'Contoso Sales'



Returns a workspace named 'Contoso Sales' (case insensitive) within the user's organization.



RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... bidashboar

d?view=powerbi-ps