pbicli admin
Commands
| pbicli admin activity | Returns a list of audit activity events for a tenant |
| pbicli admin app list | Returns a list of apps in the organization |
| pbicli admin app list-user | Returns a list of users that have access to the specified app |
| pbicli admin capacity assign | Assigns the provided workspaces to the specified capacity |
| pbicli admin capacity list | Returns a list of capacities for the organization |
| pbicli admin capacity list-user | Returns a list of users that have access to the specified dashboard |
| pbicli admin capacity unassign | Unassigns the provided workspaces from capacity |
| pbicli admin capacity update | Changes the specific capacity information. |
| pbicli admin dashboard list | Returns a list of dashboards for the organization |
| pbicli admin dashboard list-user | Returns a list of users that have access to the specified dashboard |
| pbicli admin dashboard subscription | Returns a list of subscriptions within the specified dashboard |
| pbicli admin dashboard tile | Returns a list of tiles within the specified dashboard |
| pbicli admin dataflow datasource | Returns a list of datasources for the specified dataflow |
| pbicli admin dataflow export | Exports the specified dataflow definition |
| pbicli admin dataflow list | Returns a list of dataflows for the organization |
| pbicli admin dataflow list-user | Returns a list of users that have access to the specified dataflow |
| pbicli admin dataflow upstream | Returns a list of upstream dataflows for the specified dataflow in a Power BI workspace |
| pbicli admin dataset dataflow | Returns a list of upstream dataflows in a Power BI workspace |
| pbicli admin dataset datasource | Returns a list of datasources for the specified dataset |
| pbicli admin dataset list | Returns a list of datasets for the organization |
| pbicli admin dataset list-user | Returns a list of users that have access to the specified dataset |
| pbicli admin import | Returns a list of imports for the organization |
| pbicli admin key add | Adds an encryption key for Power BI workspaces assigned to a capacity |
| pbicli admin key list | Returns the encryption keys for the tenant |
| pbicli admin key rotate | Adds an encryption key for Power BI workspaces assigned to a capacity |
| pbicli admin label remove | Remove sensitivity labels from artifacts |
| pbicli admin label set | Set sensitivity labels from artifacts |
| pbicli admin pipeline delete-user | Removes user permissions to the specified workspace |
| pbicli admin pipeline list | Returns a list of workspaces for the organization |
| pbicli admin pipeline list-user | Returns a list of users that have access to the specified workspace |
| pbicli admin pipeline update-user | Updates the specified workspace properties |
| pbicli admin refresh | Returns a list of imports for the organization |
| pbicli admin report list | Returns a list of reports for the organization |
| pbicli admin report list-user | Returns a list of users that have access to the specified dataset |
| pbicli admin report subscription | Returns a list of users that have access to the specified dataset |
| pbicli admin shared | Returns a list of Power BI items that are shared |
| pbicli admin user artifact | Returns a list of apps in the organization |
| pbicli admin user subscription | Returns a list of subscriptions that the given user has subscribed to |
| pbicli admin workspace add-user | Grants user permissions to the specified workspace |
| pbicli admin workspace delete-user | Removes user permissions to the specified workspace |
| pbicli admin workspace list | Returns a list of workspaces for the organization |
| pbicli admin workspace list-user | Returns a list of users that have access to the specified workspace |
| pbicli admin workspace modified | Gets a list of workspace IDs in the organization |
| pbicli admin workspace restore | Restores a deleted workspace |
| pbicli admin workspace result | Gets the scan result for the specified scan |
| pbicli admin workspace scan | Initiates a scan to receive metadata for the requested list of workspaces |
| pbicli admin workspace status | Gets the scan status for the specified scan |
| pbicli admin workspace unused | Returns a list of artifacts that have not been used within 30 days for the specified workspace |
| pbicli admin workspace update-user | Updates the specified workspace properties |
pbicli admin activity
Returns a list of audit activity events for a tenant
pbicli admin activity [--filter]
[--continuation-token]
[--date]
[--start-time]
[--end-time]
Parameters
--filter <filter>
Filters the results based on a boolean condition, using 'Activity', 'UserId', or both properties. Supports only 'eq' and 'and' operators--continuation-token <token>
Token required to get the next chunk of the result set--date <date>
Date for audit event results. Used with (optional) time values--start-time <time>
Start UTC time of the window for audit event results. If not provided '00:00:00' will be used--end-time <time>
End UTC time of the window for audit event results. If not provided '23:59:59' will be used
pbicli admin app list
Returns a list of apps in the organization
pbicli admin app list [--top]
Parameters
--top <number>
Returns only the firstresults. Default: 5000
pbicli admin app list-user
Returns a list of users that have access to the specified app
pbicli admin app list-user [--app] [-a]
Parameters
--app -a <name>
Name or ID of the Power BI app
pbicli admin capacity assign
Assigns the provided workspaces to the specified capacity
pbicli admin capacity assign [--capacity] [-c]
[--workspace] [-w]
Parameters
--capacity -c <name>
Name or ID of the Power BI capacity--workspace -w <name>
Name(s) or ID(s) of the Power BI workspace. Use comma seperated if multiple
pbicli admin capacity list
Returns a list of capacities for the organization
pbicli admin capacity list [--expand]
Parameters
--expand <entity>
Expands related entities inline. Allowed values: tenantKey
pbicli admin capacity list-user
Returns a list of users that have access to the specified dashboard
pbicli admin capacity list-user [--dashboard] [-d]
Parameters
--dashboard -d <name>
Name or ID of the Power BI dashboard
pbicli admin capacity unassign
Unassigns the provided workspaces from capacity
pbicli admin capacity unassign [--workspace] [-w]
Parameters
--workspace -w <name>
Name(s) or ID(s) of the Power BI workspace. Use comma seperated if multiple
pbicli admin capacity update
Changes the specific capacity information.
pbicli admin capacity update [--capacity] [-c]
[--tenant-key]
Parameters
--capacity -c <name>
Name or ID of the Power BI capacity--tenant-key <key>
The id of the encryption key
pbicli admin dashboard list
Returns a list of dashboards for the organization
pbicli admin dashboard list [--workspace] [-w]
[--expand]
[--filter]
[--top]
[--skip]
Parameters
--workspace -w <name>
Name or ID of the Power BI workspace--expand <entity>
Expands related entities inline, receives a comma-separated list of data types. Allowed values: tiles. Not used if --workspace is provided--filter <filter>
Filters the results based on a boolean condition--top <number>
Returns only the firstresults. Default: 5000 --skip <number>
Skips the firstresults
pbicli admin dashboard list-user
Returns a list of users that have access to the specified dashboard
pbicli admin dashboard list-user [--dashboard] [-d]
Parameters
--dashboard -d <name>
Name or ID of the Power BI dashboard
pbicli admin dashboard subscription
Returns a list of subscriptions within the specified dashboard
pbicli admin dashboard subscription [--dashboard] [-d]
Parameters
--dashboard -d <name>
Name or ID of the Power BI dashboard
pbicli admin dashboard tile
Returns a list of tiles within the specified dashboard
pbicli admin dashboard tile [--dashboard] [-d]
Parameters
--dashboard -d <name>
Name or ID of the Power BI dashboard
pbicli admin dataflow datasource
Returns a list of datasources for the specified dataflow
pbicli admin dataflow datasource [--dataflow] [-d]
Parameters
--dataflow -d <name>
Name or ID of the Power BI dataflow
pbicli admin dataflow export
Exports the specified dataflow definition
pbicli admin dataflow export [--dataflow] [-d]
Parameters
--dataflow -d <name>
Name or ID of the Power BI dataflow
pbicli admin dataflow list
Returns a list of dataflows for the organization
pbicli admin dataflow list [--workspace] [-w]
[--filter]
[--top]
[--skip]
Parameters
--workspace -w <name>
Name or ID of the Power BI workspace--filter <filter>
Filters the results based on a boolean condition--top <number>
Returns only the firstresults. Default: 5000 --skip <number>
Skips the firstresults
pbicli admin dataflow list-user
Returns a list of users that have access to the specified dataflow
pbicli admin dataflow list-user [--dataflow] [-d]
Parameters
--dataflow -d <name>
Name or ID of the Power BI dataflow
pbicli admin dataflow upstream
Returns a list of upstream dataflows for the specified dataflow in a Power BI workspace
pbicli admin dataflow upstream [--workspace] [-w]
[--dataflow] [-d]
Parameters
--workspace -w <name>
Name or ID of the Power BI workspace--dataflow -d <name>
Name or ID of the Power BI dataflow
pbicli admin dataset dataflow
Returns a list of upstream dataflows in a Power BI workspace
pbicli admin dataset dataflow [--workspace] [-w]
Parameters
--workspace -w <name>
Name or ID of the Power BI workspace
pbicli admin dataset datasource
Returns a list of datasources for the specified dataset
pbicli admin dataset datasource [--dataset] [-d]
Parameters
--dataset -d <name>
Name or ID of the Power BI dataset
pbicli admin dataset list
Returns a list of datasets for the organization
pbicli admin dataset list [--workspace] [-w]
[--filter]
[--top]
[--skip]
Parameters
--workspace -w <name>
Name or ID of the Power BI workspace--filter <filter>
Filters the results based on a boolean condition--top <number>
Returns only the firstresults. Default: 5000 --skip <number>
Skips the firstresults
pbicli admin dataset list-user
Returns a list of users that have access to the specified dataset
pbicli admin dataset list-user [--dataset] [-d]
Parameters
--dataset -d <name>
Name or ID of the Power BI dataset
pbicli admin import
Returns a list of imports for the organization
pbicli admin import [--expand]
[--filter]
[--top]
[--skip]
Parameters
--expand <entity>
Expands related entities inline, receives a comma-separated list of data types. Allowed values: datasets, reports--filter <filter>
Filters the results based on a boolean condition--top <number>
Returns only the firstresults. Default: 5000 --skip <number>
Skips the firstresults
pbicli admin key add
Adds an encryption key for Power BI workspaces assigned to a capacity
pbicli admin key add [--name]
[--keyVaultURI]
[--active]
[--default]
Parameters
--name <name>
The name of the encryption key--keyVaultURI <uri>
Uri to the version of the Azure Key Vault key to be used--active
Indicates to activate any inactivated capacities to use this key for its encryption--default
Indicates that this key is set as default for the entire tenant. Any new capacity creation will inherit this key upon creation
pbicli admin key list
Returns the encryption keys for the tenant
pbicli admin key list
pbicli admin key rotate
Adds an encryption key for Power BI workspaces assigned to a capacity
pbicli admin key rotate [--key]
[--keyVaultURI]
Parameters
--key <id>
ID of the encryption key--keyVaultURI <uri>
Uri to the version of the Azure Key Vault key to be used
pbicli admin label remove
Remove sensitivity labels from artifacts
pbicli admin label remove [--label-file]
Parameters
--label-file <file>
File with the artifact IDs to remove the sensitivity labels in JSON format
pbicli admin label set
Set sensitivity labels from artifacts
pbicli admin label set [--label-file]
Parameters
--label-file <file>
File with the artifact IDs to add the sensitivity labels in JSON format
pbicli admin pipeline delete-user
Removes user permissions to the specified workspace
pbicli admin pipeline delete-user [--pipeline] [-p]
[--identifier]
Parameters
--pipeline -p <name>
Name or ID of the Power BI pipeline--identifier <identifier>
Identifier of the user or principal
pbicli admin pipeline list
Returns a list of workspaces for the organization
pbicli admin pipeline list [--expand]
[--filter]
[--top]
[--skip]
Parameters
--expand <entity>
Expands related entities inline, receives a comma-separated list of data types. Allowed values: users, stages--filter <filter>
Filters the results based on a boolean condition--top <number>
Returns only the firstresults. Default: 5000 --skip <number>
Skips the firstresults
pbicli admin pipeline list-user
Returns a list of users that have access to the specified workspace
pbicli admin pipeline list-user [--pipeline] [-p]
Parameters
--pipeline -p <name>
Name or ID of the Power BI pipeline
pbicli admin pipeline update-user
Updates the specified workspace properties
pbicli admin pipeline update-user [--pipeline] [-p]
[--identifier]
[--access-right]
[--principal-type]
Parameters
--pipeline -p <name>
Name or ID of the Power BI pipeline--identifier <identifier>
Identifier of the user or principal--access-right <right>
Access right. Allowed values: Admin--principal-type <type>
Type of pricipal. Allowed values: App, User, Group, None
pbicli admin refresh
Returns a list of imports for the organization
pbicli admin refresh [--capacity] [-c]
[--refreshable-id]
[--expand]
[--filter]
[--top]
[--skip]
Parameters
--capacity -c <name>
Name or ID of the Power BI capacity--refreshable-id <refreshId>
The refreshable id--expand <entity>
Expands related entities inline, receives a comma-separated list of data types. Allowed values: capacity, workspace--filter <filter>
Filters the results based on a boolean condition--top <number>
Returns only the firstresults. Default: 5000 --skip <number>
Skips the firstresults
pbicli admin report list
Returns a list of reports for the organization
pbicli admin report list [--workspace] [-w]
[--filter]
[--top]
[--skip]
Parameters
--workspace -w <name>
Name or ID of the Power BI workspace--filter <filter>
Filters the results based on a boolean condition--top <number>
Returns only the firstresults. Default: 5000 --skip <number>
Skips the firstresults
pbicli admin report list-user
Returns a list of users that have access to the specified dataset
pbicli admin report list-user [--report] [-r]
Parameters
--report -r <report>
Name or ID of the Power BI report
pbicli admin report subscription
Returns a list of users that have access to the specified dataset
pbicli admin report subscription [--report] [-r]
Parameters
--report -r <report>
Name or ID of the Power BI report
pbicli admin shared
Returns a list of Power BI items that are shared
pbicli admin shared [--public]
[--continuation-token]
Parameters
--public
Returns only items that are shared via 'published to the web'--continuation-token <token>
Token required to get the next chunk of the result set
pbicli admin user artifact
Returns a list of apps in the organization
pbicli admin user artifact [--user]
[--continuation-token]
Parameters
--user <UPN>
The user principal name (UPN) or Graph ID of the user--continuation-token <token>
Token to get the next chunk of the result set
pbicli admin user subscription
Returns a list of subscriptions that the given user has subscribed to
pbicli admin user subscription [--user]
[--continuation-token]
Parameters
--user <UPN>
The user principal name (UPN) or Graph ID of the user--continuation-token <token>
Token to get the next chunk of the result set
pbicli admin workspace add-user
Grants user permissions to the specified workspace
pbicli admin workspace add-user [--workspace] [-w]
[--email]
[--identifier]
[--access-right]
[--principal-type]
Parameters
--workspace -w <name>
Name or ID of the Power BI workspace--email <email>
Email address of the user--identifier <identifier>
Identifier of the principal--access-right <right>
Access right. Allowed values: Admin, Contributor, Member, Viewer--principal-type <type>
Type of pricipal. Allowed values: App, User, Group, None
pbicli admin workspace delete-user
Removes user permissions to the specified workspace
pbicli admin workspace delete-user [--workspace] [-w]
[--user]
Parameters
--workspace -w <name>
Name or ID of the Power BI workspace--user <UPN>
The user principal name (UPN) of the user to remove
pbicli admin workspace list
Returns a list of workspaces for the organization
pbicli admin workspace list [--expand]
[--filter]
[--top]
[--skip]
Parameters
--expand <entity>
Expands related entities inline, receives a comma-separated list of data types. Allowed values: dashboards, datasets, dataflows, reports, users, workbooks--filter <filter>
Filters the results based on a boolean condition--top <number>
Returns only the firstresults. Default: 5000 --skip <number>
Skips the firstresults
pbicli admin workspace list-user
Returns a list of users that have access to the specified workspace
pbicli admin workspace list-user [--workspace] [-w]
Parameters
--workspace -w <name>
Name or ID of the Power BI workspace
pbicli admin workspace modified
Gets a list of workspace IDs in the organization
pbicli admin workspace modified [--modified]
[--personal-workspaces]
Parameters
--modified <datetime>
Last modified date (must be in ISO 8601 compliant UTC format)--personal-workspaces
Include personal workspaces
pbicli admin workspace restore
Restores a deleted workspace
pbicli admin workspace restore [--workspace] [-w]
[--owner]
[--name]
Parameters
--workspace -w <name>
Name or ID of the Power BI workspace--owner <email>
The email address of the owner of the group to be restored--name [name]
The optional new name of the group to be restored
pbicli admin workspace result
Gets the scan result for the specified scan
pbicli admin workspace result [--scan-id]
Parameters
--scan-id <scanId>
The scan ID for the triggered scan
pbicli admin workspace scan
Initiates a scan to receive metadata for the requested list of workspaces
pbicli admin workspace scan [--dataset-expressions]
[--dataset-schema]
[--datasource-details]
[--artifact-users ]
[--lineage]
[--workspace-file]
Parameters
--dataset-expressions
Whether to return dataset expressions (Dax query and Mashup)--dataset-schema
Whether to return dataset schema (Tables, Columns and Measures)--datasource-details
Whether to return datasource details--artifact-users
Whether to return artifact user details (Permission level)--lineage
Whether to return lineage info (upstream dataflows, tiles, datasource IDs)--workspace-file <file>
File with the workspace IDs to add to the scan in JSON format
pbicli admin workspace status
Gets the scan status for the specified scan
pbicli admin workspace status [--scan-id]
Parameters
--scan-id <scanId>
The scan ID for the triggered scan
pbicli admin workspace unused
Returns a list of artifacts that have not been used within 30 days for the specified workspace
pbicli admin workspace unused [--workspace] [-w]
[--continuation-token]
Parameters
--workspace -w <name>
Name or ID of the Power BI workspace--continuation-token <token>
Token to get the next chunk of the result set
pbicli admin workspace update-user
Updates the specified workspace properties
pbicli admin workspace update-user [--workspace] [-w]
[--update-details]
[--update-details-file]
Parameters
--workspace -w <name>
Name or ID of the Power BI workspace--update-details <data>
String with the update details in JSON format. Use @{file} to load from a file--update-details-file <file>
File with the update details in JSON format. Deprecated: use --update-details @{file}