Get-PowerBIDataset

Reference

Module:: MicrosoftPowerBIMgmt.Data

Returns a list of Power BI datasets.

Syntax

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

Get-PowerBIDataset
   -Id <Guid>
   [-Scope <PowerBIUserScope>]
   [-Include <String>]
   [-WorkspaceId <Guid>]
   [<CommonParameters>]

Get-PowerBIDataset
   -Id <Guid>
   [-Scope <PowerBIUserScope>]
   [-Include <String>]
   -Workspace <Workspace>
   [<CommonParameters>]

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

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

Get-PowerBIDataset
   [-Scope <PowerBIUserScope>]
   [-First <Int32>]
   [-Include <String>]
   [-Skip <Int32>]
   -Workspace <Workspace>
   [<CommonParameters>]

Description

Retrieves a list of Power BI datasets that match the specified search criteria and scope. Before you run this command, make sure you log in using Connect-PowerBIServiceAccount. For -Scope Individual, datasets are returned from "My Workspace" unless -Workspace or -WorkspaceId is specified.

Examples

Example 1

PS C:\> Get-PowerBIDataset

Returns a list of all Power BI datasets a user has access to.

Example 2

PS C:\> Get-PowerBIDataset -Scope Organization

Returns a list of all Power BI datasets within a 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 dataset to return.

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

-Include

OData expand, case-sensitive (element names start lowercase).

Type:	String
Aliases:	Expand
Accepted values:	actualStorage
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Name of the dataset 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 scope of the call. Individual returns datasets from "My Workspace" by default. With -Workspace or -WorkspaceId, datasets under the workspace assigned to the caller are returned; Organization returns all datasets 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, datasets only belonging 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, datasets only belonging 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.Object