Skip to content

Latest commit

 

History

History
276 lines (181 loc) · 7.93 KB

reference-dataflow.md

File metadata and controls

276 lines (181 loc) · 7.93 KB
Raw
uid title documentId
reference/dataflow
pbicli dataflow
fd97c470-7d26-4337-a604-cdd27a0106bf

pbicli dataflow

Commands
pbicli dataflow datasource Get the datasources of a Power BI dataflow
pbicli dataflow delete Deletes a Power BI dataflow from a group
pbicli dataflow list List Power BI dataflows in a group
pbicli dataflow refresh start Start a refresh of a Power BI dataflow
pbicli dataflow refresh update Update a Power BI refresh schedule
pbicli dataflow show Get the details of a Power BI dataflow
pbicli dataflow storage assign Assign a Power BI group to a dataflow storage account
pbicli dataflow storage list List Power BI dataflow storage accounts
pbicli dataflow storage unassign Unassign a Power BI group to a dataflow storage account
pbicli dataflow transaction cancel Attempts to cancel a Power BI group dataflow transaction
pbicli dataflow transaction list List Power BI dataflow Transactions
pbicli dataflow update Update dataflow properties, capabilities and settings
pbicli dataflow upstream Get the upstream dataflows of a Power BI dataflow

pbicli dataflow datasource

Get the datasources of a Power BI dataflow

pbicli dataflow datasource [--workspace] [-w]
                           [--dataflow] [-f]

Parameters

  • --workspace -w <name>
    Name or ID of the Power BI workspace

  • --dataflow -f <dataflow>
    Name or ID of the Power BI dataflow

[!div class="global-parameters"]

Global Parameters

pbicli dataflow delete

Deletes a Power BI dataflow from a group

pbicli dataflow delete [--workspace] [-w]
                       [--dataflow] [-f]

Parameters

  • --workspace -w <name>
    Name or ID of the Power BI workspace. If not provided it uses 'My workspace'

  • --dataflow -f <dataflow>
    Name or ID of the Power BI dataflow

[!div class="global-parameters"]

Global Parameters

pbicli dataflow list

List Power BI dataflows in a group

pbicli dataflow list [--workspace] [-w]

Parameters

  • --workspace -w <name>
    Name or ID of the Power BI workspace

[!div class="global-parameters"]

Global Parameters

pbicli dataflow refresh start

Start a refresh of a Power BI dataflow

pbicli dataflow refresh start [--workspace] [-w]
                              [--dataflow] [-f]
                              [--notify]

Parameters

  • --workspace -w <name>
    Name or ID of the Power BI workspace. If not provided it uses 'My workspace'

  • --dataflow -f <dataflow>
    Name or ID of the Power BI dataflow

  • --notify <option>
    Allowed values: always, failure, none

[!div class="global-parameters"]

Global Parameters

pbicli dataflow refresh update

Update a Power BI refresh schedule

pbicli dataflow refresh update [--workspace] [-w]
                               [--dataflow] [-f]
                               [--refresh-schedule]
                               [--refresh-schedule-file]

Parameters

  • --workspace -w <name>
    Name or ID of the Power BI workspace. If not provided it uses 'My workspace'

  • --dataflow -f <dataflow>
    Name or ID of the Power BI dataflow

  • --refresh-schedule <data>
    String with the refresh schedule in JSON format. Use @{file} to load from a file

  • --refresh-schedule-file <file>
    File with the refresh schedule in JSON format. Deprecated: use --refresh-schedule @{file}

[!div class="global-parameters"]

Global Parameters

pbicli dataflow show

Get the details of a Power BI dataflow

pbicli dataflow show [--workspace] [-w]
                     [--dataflow] [-f]

Parameters

  • --workspace -w <name>
    Name or ID of the Power BI workspace

  • --dataflow -f <dataflow>
    Name or ID of the Power BI dataflow

[!div class="global-parameters"]

Global Parameters

pbicli dataflow storage assign

Assign a Power BI group to a dataflow storage account

pbicli dataflow storage assign [--workspace] [-w]
                               [--storage-account]

Parameters

  • --workspace -w <name>
    Name or ID of the Power BI workspace

  • --storage-account <storage>
    ID of the Power BI dataflow storage account

[!div class="global-parameters"]

Global Parameters

pbicli dataflow storage list

List Power BI dataflow storage accounts

pbicli dataflow storage list

[!div class="global-parameters"]

Global Parameters

pbicli dataflow storage unassign

Unassign a Power BI group to a dataflow storage account

pbicli dataflow storage unassign [--workspace] [-w]

Parameters

  • --workspace -w <name>
    Name or ID of the Power BI workspace

[!div class="global-parameters"]

Global Parameters

pbicli dataflow transaction cancel

Attempts to cancel a Power BI group dataflow transaction

pbicli dataflow transaction cancel [--workspace] [-w]
                                   [--transaction]

Parameters

  • --workspace -w <name>
    Name or ID of the Power BI workspace

  • --transaction <transaction>
    ID of the Power BI dataflow transaction

[!div class="global-parameters"]

Global Parameters

pbicli dataflow transaction list

List Power BI dataflow Transactions

pbicli dataflow transaction list [--workspace] [-w]
                                 [--dataflow] [-f]

Parameters

  • --workspace -w <name>
    Name or ID of the Power BI workspace. If not provided it uses 'My workspace'

  • --dataflow -f <dataflow>
    Name or ID of the Power BI dataflow

[!div class="global-parameters"]

Global Parameters

pbicli dataflow update

Update dataflow properties, capabilities and settings

pbicli dataflow update [--workspace] [-w]
                       [--dataflow] [-f]
                       [--update]
                       [--update-file]

Parameters

  • --workspace -w <name>
    Name or ID of the Power BI workspace. If not provided it uses 'My workspace'

  • --dataflow -f <dataflow>
    Name or ID of the Power BI dataflow

  • --update <data>
    String with the update dataflow settings in JSON format. Use @{file} to load from a file

  • --update-file <file>
    File with the update dataflow settings in JSON format. Deprecated: use --update @{file}

[!div class="global-parameters"]

Global Parameters

pbicli dataflow upstream

Get the upstream dataflows of a Power BI dataflow

pbicli dataflow upstream [--workspace] [-w]
                         [--dataflow] [-f]

Parameters

  • --workspace -w <name>
    Name or ID of the Power BI workspace

  • --dataflow -f <dataflow>
    Name or ID of the Power BI dataflow

[!div class="global-parameters"]

Global Parameters

Feedback