Get-PowerBIDashboard

Reference

Module:: MicrosoftPowerBIMgmt.Reports

Returns a list of Power BI dashboards.

Syntax

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

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

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

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

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

Get-PowerBIDashboard
   [-Scope <PowerBIUserScope>]
   [-Filter <String>]
   [-First <Int32>]
   [-Skip <Int32>]
   -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.

Examples

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.

Parameters

-Filter

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-First

First (top) list of results.

Type:	Int32
Aliases:	Top
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Id

ID of the dashboard to return.

Type:	Guid
Aliases:	ImportId
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

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

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Scope

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.

Type:	PowerBIUserScope
Accepted values:	Individual, Organization
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Skip

Skips the first set of results.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Workspace

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

Type:	Workspace
Aliases:	Group
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-WorkspaceId

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

Type:	Guid
Aliases:	GroupId
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

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

Share via