Edit

Share via


Export-PowerBIDataflow

Exports a Power BI dataflow to the .json file format.

Syntax

Id (Default)

Export-PowerBIDataflow
    -Id <Guid>
    -OutFile <String>
    [-WorkspaceId <Guid>]
    [-Scope <PowerBIUserScope>]
    [<CommonParameters>]

Dataflow

Export-PowerBIDataflow
    -Dataflow <Dataflow>
    -OutFile <String>
    [-WorkspaceId <Guid>]
    [-Scope <PowerBIUserScope>]
    [<CommonParameters>]

Description

Export a Power BI dataflow from the Power BI service into a .json file that represents a Dataflow object. For -Scope Individual, user must specify the dataflow's workspace, using the given -WorkspaceId value. Before you run this command, make sure you log in using Connect-PowerBIServiceAccount.

Examples

Example 1

PS C:\> Export-PowerBIDataflow -WorkspaceId ed451706-2b02-430c-b25c-20c0842c6375 -Id 9b519499-5ba1-4f1c-878b-be3a69f1791f -OutFile .\Sales.json

Export dataflow with ID 9b519499-5ba1-4f1c-878b-be3a69f1791f from a workspace with Id ed451706-2b02-430c-b25c-20c0842c6375 into a file named Sales.json in your current working directory ($PWD).

Example 2

PS C:\> Export-PowerBIDataflow -Id 9b519499-5ba1-4f1c-878b-be3a69f1791f -Scope Organization -OutFile .\Sales.json

Export dataflow with ID 9b519499-5ba1-4f1c-878b-be3a69f1791f from within the user's organization into a file named Sales.json in the current working directory ($PWD).

Parameters

-Dataflow

Dataflow for exporting.

Parameter properties

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

Parameter sets

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

-Id

ID of the dataflow to export.

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

-OutFile

Output file to save the exported dataflow to. Path must not already exist.

Parameter properties

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

Parameter sets

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

-Scope

Indicates scope of the call. Individual works only with the -WorkspaceId parameter, which indicates the Workspace of the requested Dataflow. Organization exports the requested dataflow from 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

-WorkspaceId

ID of the workspace containing the Power BI dataflow to export.

Parameter properties

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

Parameter sets

(All)
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

Microsoft.PowerBI.Common.Api.Dataflows.Dataflow

Outputs

System.Object