< Back

Get-PowerBIDataflow

Sat Jan 18, 2020 4:12 pm

NAME Get-PowerBIDataflow



SYNOPSIS

Returns a list of Power BI dataflows.





SYNTAX

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

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



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

-Workspace <Workspace> [<CommonParameters>]



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



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



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



Get-PowerBIDataflow -Name <String> [-Scope {Individual | Organization}] -Workspace <Workspace> [<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.





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 dataflow to return.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

Name of the dataflow 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 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.



Required? false

Position? named

Default value Individual

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 dataflows belonging to that workspace are shown. Supports pipelining of

Cmdlets that return Workspace objects.



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 dataflows belonging 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.Object







NOTES









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



RELATED LINKS

Online Version:

https://docs.microsoft.com/en-us/powers ... powerbi-ps