Search Results for

    Show / Hide Table of Contents

    pbicli dataset

    Commands

    pbicli dataset dataflow Get the dataflows uplinks of a Power BI dataset
    pbicli dataset datasource gateway List the datasource of a gateways linked to a Power BI dataset
    pbicli dataset datasource list List the datasources of a Power BI dataset
    pbicli dataset datasource update Update the datasources of a Power BI dataset
    pbicli dataset delete Deletes a Power BI dataset from a group
    pbicli dataset gateway datasource List the datasource of a gateways linked to a Power BI dataset
    pbicli dataset gateway list List the gateways of a Power BI dataset
    pbicli dataset gateway update Bind a gatweay of a Power BI dataset
    pbicli dataset list List Power BI datasets in a group
    pbicli dataset parameter list List the parameters of a Power BI dataset
    pbicli dataset parameter update Update the parameters of a Power BI dataset
    pbicli dataset query Execute an DAX query against the Power BI XMLA endpoint
    pbicli dataset refresh cancel Cancels the refresh operation for the specified Power BI dataset
    pbicli dataset refresh detail Returns execution details of the refresh operation for the specified Power BI dataset
    pbicli dataset refresh history Get the history of a Power BI refresh schedule
    pbicli dataset refresh show Get the details of a Power BI refresh schedule
    pbicli dataset refresh start Triggers a Power BI dataset refresh
    pbicli dataset refresh update Update a Power BI refresh schedule
    pbicli dataset set-owner Set the owner of a Power BI dataset to the current user / service principal
    pbicli dataset show Get the details of a Power BI dataset
    pbicli dataset update Updates the properties for the specified dataset
    pbicli dataset user update Update access of a user or service pricipal

    pbicli dataset dataflow

    Get the dataflows uplinks of a Power BI dataset

    pbicli dataset dataflow [--workspace] [-w]
                            [--dataset] [-d]
    

    Parameters

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

    • --dataset -d <dataset>
      Name or ID of the Power BI dataset

    Global Parameters

    pbicli dataset datasource gateway

    List the datasource of a gateways linked to a Power BI dataset

    pbicli dataset datasource gateway [--workspace] [-w]
                                      [--dataset] [-d]
    

    Parameters

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

    • --dataset -d <dataset>
      Name or ID of the Power BI dataset

    Global Parameters

    pbicli dataset datasource list

    List the datasources of a Power BI dataset

    pbicli dataset datasource list [--workspace] [-w]
                                   [--dataset] [-d]
    

    Parameters

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

    • --dataset -d <dataset>
      Name or ID of the Power BI dataset

    Global Parameters

    pbicli dataset datasource update

    Update the datasources of a Power BI dataset

    pbicli dataset datasource update [--workspace] [-w]
                                     [--dataset] [-d]
                                     [--update-details]
                                     [--update-details-file]
    

    Parameters

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

    • --dataset -d <dataset>
      Name or ID of the Power BI dataset

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

    • --update-details-file <file>
      File with the connection server details in JSON format. Deprecated: use --update-details @{file}

    Global Parameters

    pbicli dataset delete

    Deletes a Power BI dataset from a group

    pbicli dataset delete [--workspace] [-w]
                          [--dataset] [-d]
    

    Parameters

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

    • --dataset -d <dataset>
      Name or ID of the Power BI dataset

    Global Parameters

    pbicli dataset gateway datasource

    List the datasource of a gateways linked to a Power BI dataset

    pbicli dataset gateway datasource [--workspace] [-w]
                                      [--dataset] [-d]
    

    Parameters

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

    • --dataset -d <dataset>
      Name or ID of the Power BI dataset

    Global Parameters

    pbicli dataset gateway list

    List the gateways of a Power BI dataset

    pbicli dataset gateway list [--workspace] [-w]
                                [--dataset] [-d]
    

    Parameters

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

    • --dataset -d <dataset>
      Name or ID of the Power BI dataset

    Global Parameters

    pbicli dataset gateway update

    Bind a gatweay of a Power BI dataset

    pbicli dataset gateway update [--workspace] [-w]
                                  [--dataset] [-d]
                                  [--gatewayId]
                                  [--datasourceIds]
    

    Parameters

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

    • --dataset -d <dataset>
      Name or ID of the Power BI dataset

    • --gatewayId <gatewayId>
      Name or ID of the Power BI gateway

    • --datasourceIds <data>
      Set of datasource Ids. Comma seperated

    Global Parameters

    pbicli dataset list

    List Power BI datasets in a group

    pbicli dataset list [--workspace] [-w]
    

    Parameters

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

    Global Parameters

    pbicli dataset parameter list

    List the parameters of a Power BI dataset

    pbicli dataset parameter list [--workspace] [-w]
                                  [--dataset] [-d]
    

    Parameters

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

    • --dataset -d <dataset>
      Name or ID of the Power BI dataset

    Global Parameters

    pbicli dataset parameter update

    Update the parameters of a Power BI dataset

    pbicli dataset parameter update [--workspace] [-w]
                                    [--dataset] [-d]
                                    [--parameter]
                                    [--parameter-file]
    

    Parameters

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

    • --dataset -d <dataset>
      Name or ID of the Power BI dataset

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

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

    Global Parameters

    pbicli dataset query

    Execute an DAX query against the Power BI XMLA endpoint

    pbicli dataset query [--workspace] [-w]
                         [--dataset] [-d]
                         [--dax]
                         [--dax-file]
                         [--script]
                         [--script-file]
    

    Parameters

    • --workspace -w <name>
      Name or ID of the Power BI workspace. Optional if dataset is provided as ID.

    • --dataset -d <dataset>
      Name or ID of the Power BI dataset

    • --dax <query>
      String with the DAX query to be executed. Use @{file} to load from a file

    • --dax-file <file>
      File with the DAX query to be executed. Deprecated: use --dax @{file}

    • --script <script>
      String with the raw query statement in JSON format. Use @{file} to load from a file

    • --script-file <file>
      File with the raw query statement in JSON format. Deprecated: use --script @{file}

    Global Parameters

    pbicli dataset refresh cancel

    Cancels the refresh operation for the specified Power BI dataset

    pbicli dataset refresh cancel [--workspace] [-w]
                                  [--dataset] [-d]
                                  [--refresh] [-r]
    

    Parameters

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

    • --dataset -d <dataset>
      Name or ID of the Power BI dataset

    • --refresh -r <refresh>
      ID of the refresh id

    Global Parameters

    pbicli dataset refresh detail

    Returns execution details of the refresh operation for the specified Power BI dataset

    pbicli dataset refresh detail [--workspace] [-w]
                                  [--dataset] [-d]
                                  [--refresh] [-r]
    

    Parameters

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

    • --dataset -d <dataset>
      Name or ID of the Power BI dataset

    • --refresh -r <refresh>
      ID of the refresh id

    Global Parameters

    pbicli dataset refresh history

    Get the history of a Power BI refresh schedule

    pbicli dataset refresh history [--workspace] [-w]
                                   [--dataset] [-d]
    

    Parameters

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

    • --dataset -d <dataset>
      Name or ID of the Power BI dataset

    Global Parameters

    pbicli dataset refresh show

    Get the details of a Power BI refresh schedule

    pbicli dataset refresh show [--workspace] [-w]
                                [--dataset] [-d]
                                [--direct-query]
    

    Parameters

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

    • --dataset -d <dataset>
      Name or ID of the Power BI dataset

    • --direct-query
      Dataset is a direct query or live connection

    Global Parameters

    pbicli dataset refresh start

    Triggers a Power BI dataset refresh

    pbicli dataset refresh start [--workspace] [-w]
                                 [--dataset] [-d]
                                 [--notify]
    

    Parameters

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

    • --dataset -d <dataset>
      Name or ID of the Power BI dataset

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

    Global Parameters

    pbicli dataset refresh update

    Update a Power BI refresh schedule

    pbicli dataset refresh update [--workspace] [-w]
                                  [--dataset] [-d]
                                  [--refresh-schedule]
                                  [--refresh-schedule-file]
                                  [--direct-query]
    

    Parameters

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

    • --dataset -d <dataset>
      Name or ID of the Power BI dataset

    • --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}

    • --direct-query
      Dataset is a direct query or live connection

    Global Parameters

    pbicli dataset set-owner

    Set the owner of a Power BI dataset to the current user / service principal

    pbicli dataset set-owner [--workspace] [-w]
                             [--dataset] [-d]
    

    Parameters

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

    • --dataset -d <dataset>
      Name or ID of the Power BI dataset

    Global Parameters

    pbicli dataset show

    Get the details of a Power BI dataset

    pbicli dataset show [--workspace] [-w]
                        [--dataset] [-d]
    

    Parameters

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

    • --dataset -d <dataset>
      Name or ID of the Power BI dataset

    Global Parameters

    pbicli dataset update

    Updates the properties for the specified dataset

    pbicli dataset update [--workspace] [-w]
                          [--dataset] [-d]
                          [--large]
    

    Parameters

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

    • --dataset -d <dataset>
      Name or ID of the Power BI dataset

    • --large
      Set dataset storage mode to support large datasets

    Global Parameters

    pbicli dataset user update

    Update access of a user or service pricipal

    pbicli dataset user update [--workspace] [-w]
                               [--dataset] [-d]
                               [--identifier]
                               [--access-right]
                               [--principal-type]
    

    Parameters

    • --workspace -w <name>
      Name or ID of the Power BI workspace. Optional if dataset is provided as ID.

    • --dataset -d <name>
      Name or ID of the Power BI dataset

    • --identifier <identifier>
      Identifier of the user or principal

    • --access-right <right>
      Access right. Allowed values: Read, ReadExplore, ReadReshare, ReadReshareExplore

    • --principal-type <type>
      Type of pricipal. Allowed values: App, User, Group, None

    Global Parameters

    Feedback

    • Improve this Doc
    In This Article
    Back to top Generated by DocFX