Edit

Share via

Get-PowerBIDashboard

Module:
MicrosoftPowerBIMgmt.Reports Module

Returns a list of Power BI dashboards.

Syntax

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>
    -Workspace <Workspace>
    [-Scope <PowerBIUserScope>]
    [<CommonParameters>]

Name 

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

ObjectAndName 

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

ObjectAndList 

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ObjectAndList
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-First

First (top) list of results.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Top

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ObjectAndList
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

ID of the dashboard to return.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ImportId

Parameter sets

Id
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ObjectAndId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Name
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ObjectAndName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:PowerBIUserScope
Default value:None
Accepted values:Individual, Organization
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Skip

Skips the first set of results.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ObjectAndList
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Workspace

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

Parameter properties

Type:Workspace
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Group

Parameter sets

ObjectAndId
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
ObjectAndName
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
ObjectAndList
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-WorkspaceId

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

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False
Aliases:GroupId

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Id
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Name
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

Microsoft.PowerBI.Common.Api.Reports.Dashboard