Rediger

Del via

Get-PowerBIDataflow

Module:
MicrosoftPowerBIMgmt.Data Module

Returns a list of Power BI dataflows.

Syntax

List (Default) 

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

Id 

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

WorkspaceAndId 

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

Name 

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

WorkspaceAndName 

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

WorkspaceAndList 

Get-PowerBIDataflow
    -Workspace <Workspace>
    [-Scope <PowerBIUserScope>]
    [-Filter <String>]
    [-First <Int32>]
    [-Skip <Int32>]
    [<CommonParameters>]

Description

Retrieves a list of Power BI dataflows that match the specified search criteria and scope. For -Scope Individual, dataflows are returned only from the specified workspace, using the given -Workspace or -WorkspaceId parameters. For -Scope Organization, dataflows could be returned from the entire user's organization. Before you run this command, make sure you log in using Connect-PowerBIServiceAccount.

Examples

Example 1

PS C:\> Get-PowerBIDataflow -WorkspaceId ed451706-2b02-430c-b25c-20c0842c6375

Returns a list of all Power BI dataflows in workpsace with ID ed451706-2b02-430c-b25c-20c0842c6375 that the user has access to.

Example 2

PS C:\> Get-PowerBIDataflow -Scope Organization

Returns a list of all Power BI dataflows within a user's organization.

Example 3

PS C:\> Get-PowerBIDataflow -Name "MyDataflow" -Scope Organization

Returns a dataflow with the Name "MyDataflow" from within all the organization.

Example 4

PS C:\> Get-PowerBIDataflow -WorkspaceId ed451706-2b02-430c-b25c-20c0842c6375 -First 20

Returns a list of the first 20 dataflows in a workspace with ID ed451706-2b02-430c-b25c-20c0842c6375 that the user has access to.

Example 5

PS C:\> Get-PowerBIDataflow -WorkspaceId ed451706-2b02-430c-b25c-20c0842c6375 -Id 672403a7-34b7-493c-8ab1-3f1066573dc5

Returns a dataflow with ID 672403a7-34b7-493c-8ab1-3f1066573dc5 in a workspace with ID ed451706-2b02-430c-b25c-20c0842c6375.

Example 6

PS C:\> Get-PowerBIDataflow -Scope Organization -Filter "configuredBy eq 'john@contoso.com'"

Returns all dataflows configured by 'john@contoso.com' 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
WorkspaceAndList
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
WorkspaceAndList
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

ID of the dataflow to return.

Parameter properties

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

Parameter sets

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

-Name

Name of the dataflow 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
WorkspaceAndName
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 scope must be run with -Workspace or -WorkspaceId parameters. Organization scope returns all dataflows within a tenant (must be an administrator to initiate). Individual is the default.

Parameter properties

Type:PowerBIUserScope
Default value:Individual
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
WorkspaceAndList
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 dataflows belonging to that workspace are shown. Supports pipelining of Cmdlets that return Workspace objects.

Parameter properties

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

Parameter sets

WorkspaceAndId
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
WorkspaceAndName
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
WorkspaceAndList
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 dataflows belonging 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

System.Object