# [ Power BI Service and Administration ] [ cheatsheet ]

Workspace Management:

● Create a new workspace: New-PowerBIWorkspace -Name "Workspace Name"

● Add a user to a workspace: Add-PowerBIWorkspaceUser -WorkspaceId
<workspace-id> -UserEmailAddress <user-email> -AccessRight <access-right>
● Remove a user from a workspace: Remove-PowerBIWorkspaceUser -WorkspaceId
<workspace-id> -UserEmailAddress <user-email>
● Update workspace properties: Set-PowerBIWorkspace -WorkspaceId
<workspace-id> -Name "New Workspace Name" -Description "New Description"
● Delete a workspace: Remove-PowerBIWorkspace -WorkspaceId <workspace-id>
● Get a list of workspaces: Get-PowerBIWorkspace
● Get workspace users: Get-PowerBIWorkspaceUser -WorkspaceId <workspace-id>
● Set workspace access: Set-PowerBIWorkspaceAccess -WorkspaceId
<workspace-id> -AccessRight <access-right>
● Restore a deleted workspace: Restore-PowerBIWorkspace -WorkspaceId
<workspace-id> -RestoredName "Restored Workspace"
● Upgrade a workspace to a new experience: Upgrade-PowerBIWorkspace
-WorkspaceId <workspace-id>

App Management:

● Create a new app: New-PowerBIApp -WorkspaceId <workspace-id> -Name "App

Name"
● Update app properties: Set-PowerBIApp -AppId <app-id> -Name "New App
Name" -Description "New Description"
● Publish an app: Publish-PowerBIApp -AppId <app-id>
● Unpublish an app: Unpublish-PowerBIApp -AppId <app-id>
● Delete an app: Remove-PowerBIApp -AppId <app-id>
● Get a list of apps: Get-PowerBIApp
● Get app users: Get-PowerBIAppUser -AppId <app-id>
● Update app access: Set-PowerBIAppAccess -AppId <app-id> -PrincipalId
<principal-id> -AccessRight <access-right>
● Add a workspace to an app: Add-PowerBIWorkspaceToApp -AppId <app-id>
-WorkspaceId <workspace-id>
● Remove a workspace from an app: Remove-PowerBIWorkspaceFromApp -AppId
<app-id> -WorkspaceId <workspace-id>

Report and Dashboard Management:

By: Waleed Mousa

 ● Get a list of reports: Get-PowerBIReport
● Get a report by ID: Get-PowerBIReport -ReportId <report-id>
● Export a report: Export-PowerBIReport -ReportId <report-id> -OutFile
"path/to/export.pbix"
● Delete a report: Remove-PowerBIReport -ReportId <report-id>
● Update report properties: Set-PowerBIReport -ReportId <report-id> -Name
"New Report Name" -Description "New Description"
● Rebind a report to a dataset: Set-PowerBIReportDataset -ReportId
<report-id> -DatasetId <dataset-id>
● Get a list of dashboards: Get-PowerBIDashboard
● Get a dashboard by ID: Get-PowerBIDashboard -DashboardId <dashboard-id>
● Delete a dashboard: Remove-PowerBIDashboard -DashboardId <dashboard-id>
● Update dashboard properties: Set-PowerBIDashboard -DashboardId
<dashboard-id> -Name "New Dashboard Name" -Description "New Description"

Dataset Management:

● Get a list of datasets: Get-PowerBIDataset

● Get a dataset by ID: Get-PowerBIDataset -DatasetId <dataset-id>
● Create a new dataset: New-PowerBIDataset -WorkspaceId <workspace-id>
-Name "Dataset Name" -Tables <tables>
● Delete a dataset: Remove-PowerBIDataset -DatasetId <dataset-id>
● Update dataset properties: Set-PowerBIDataset -DatasetId <dataset-id>
-Name "New Dataset Name" -Description "New Description"
● Refresh a dataset: Invoke-PowerBIDatasetRefresh -DatasetId <dataset-id>
● Get dataset refresh history: Get-PowerBIDatasetRefreshHistory -DatasetId
<dataset-id>
● Update dataset parameters: Set-PowerBIDatasetParameters -DatasetId
<dataset-id> -Parameters <parameters>
● Take a dataset ownership: Set-PowerBIDatasetOwnership -DatasetId
<dataset-id> -PrincipalType "User" -PrincipalId <principal-id>
● Update dataset data sources: Set-PowerBIDatasetDatasources -DatasetId
<dataset-id> -DatasourceType <datasource-type> -ConnectionString
<connection-string>

Data Gateway Management:

● Get a list of data gateways: Get-PowerBIDataGateway

● Get a data gateway by ID: Get-PowerBIDataGateway -GatewayId <gateway-id>
● Create a new data gateway: New-PowerBIDataGateway -Name "Gateway Name"
-Description "Gateway Description"

By: Waleed Mousa

 ● Delete a data gateway: Remove-PowerBIDataGateway -GatewayId <gateway-id>
● Update data gateway properties: Set-PowerBIDataGateway -GatewayId
<gateway-id> -Name "New Gateway Name" -Description "New Description"
● Add a data source to a gateway: Add-PowerBIDataGatewayDatasource
-GatewayId <gateway-id> -DatasourceType <datasource-type>
-ConnectionString <connection-string>
● Remove a data source from a gateway: Remove-PowerBIDataGatewayDatasource
-GatewayId <gateway-id> -DatasourceId <datasource-id>
● Get data gateway status: Get-PowerBIDataGatewayStatus -GatewayId
<gateway-id>
● Update data gateway credentials: Set-PowerBIDataGatewayCredential
-GatewayId <gateway-id> -Credential <credential>
● Restart a data gateway: Restart-PowerBIDataGateway -GatewayId
<gateway-id>

Security and Access Control:

● Add a security group to a workspace: Add-PowerBIWorkspaceUser

-WorkspaceId <workspace-id> -GroupUserAccessRight "Contributor"
-Identifier <group-id>
● Remove a security group from a workspace: Remove-PowerBIWorkspaceUser
-WorkspaceId <workspace-id> -GroupUserAccessRight "None" -Identifier
<group-id>
● Add a user to a security group: Add-PowerBIGroupUser -GroupId <group-id>
-UserEmailAddress <user-email>
● Remove a user from a security group: Remove-PowerBIGroupUser -GroupId
<group-id> -UserEmailAddress <user-email>
● Update a user's access to a workspace: Set-PowerBIWorkspaceUser
-WorkspaceId <workspace-id> -UserEmailAddress <user-email> -AccessRight
<access-right>
● Get workspace access for a user: Get-PowerBIWorkspaceUser -WorkspaceId
<workspace-id> -UserEmailAddress <user-email>
● Enable row-level security (RLS) for a dataset:
New-PowerBIDatasetRoleAssignment -DatasetId <dataset-id> -RoleName
<role-name> -PrincipalType <principal-type> -PrincipalId <principal-id>
● Disable row-level security (RLS) for a dataset:
Remove-PowerBIDatasetRoleAssignment -DatasetId <dataset-id> -RoleName
<role-name> -PrincipalType <principal-type> -PrincipalId <principal-id>
● Update row-level security (RLS) roles for a dataset:
Set-PowerBIDatasetRoleAssignment -DatasetId <dataset-id> -RoleName
<role-name> -PrincipalType <principal-type> -PrincipalId <principal-id>

By: Waleed Mousa

 ● Get row-level security (RLS) roles for a dataset:
Get-PowerBIDatasetRoleAssignment -DatasetId <dataset-id>

Tenant Settings and Administration:

● Get Power BI tenant settings: Get-PowerBITenantSettings

● Update Power BI tenant settings: Set-PowerBITenantSettings -CustomVisuals
$true -ExportData $true -PublishToWebEnabled $false
● Get Power BI tenant capacity: Get-PowerBITenantCapacity
● Update Power BI tenant capacity: Set-PowerBITenantCapacity -CapacityId
<capacity-id> -CapacityType <capacity-type> -Memory <memory> -VCores
<vcores>
● Get Power BI tenant workspaces: Get-PowerBITenantWorkspace
● Get Power BI tenant users: Get-PowerBITenantUser
● Add a Power BI tenant user: Add-PowerBITenantUser -UserPrincipalName
<user-principal-name>
● Remove a Power BI tenant user: Remove-PowerBITenantUser
-UserPrincipalName <user-principal-name>
● Get Power BI tenant audit logs: Get-PowerBITenantAuditLogs -StartDateTime
<start-date> -EndDateTime <end-date>
● Get Power BI tenant usage metrics: Get-PowerBITenantUsageMetrics
-StartDateTime <start-date> -EndDateTime <end-date>

Deployment and ALM:

● Deploy a Power BI report: Invoke-PowerBIDeployment -ReportPath

"path/to/report.pbix" -WorkspaceId <workspace-id>
● Deploy a Power BI dataset: Invoke-PowerBIDeployment -DatasetPath
"path/to/dataset.pbix" -WorkspaceId <workspace-id>
● Deploy a Power BI dataflow: Invoke-PowerBIDeployment -DataflowPath
"path/to/dataflow.json" -WorkspaceId <workspace-id>
● Deploy a Power BI template: Invoke-PowerBIDeployment -TemplatePath
"path/to/template.pbit" -WorkspaceId <workspace-id>
● Create a Power BI pipeline: New-PowerBIPipeline -Name "Pipeline Name"
-Description "Pipeline Description" -WorkspaceId <workspace-id>
● Add a stage to a Power BI pipeline: Add-PowerBIPipelineStage -PipelineId
<pipeline-id> -StageName "Stage Name" -StageOrder <stage-order>
● Add an artifact to a Power BI pipeline stage:
Add-PowerBIPipelineArtifact -PipelineId <pipeline-id> -StageName "Stage
Name" -ArtifactType <artifact-type> -ArtifactPath <artifact-path>

By: Waleed Mousa

 ● Trigger a Power BI pipeline deployment: Start-PowerBIPipelineDeployment
-PipelineId <pipeline-id>
● Get Power BI pipeline deployment status:
Get-PowerBIPipelineDeploymentStatus -PipelineId <pipeline-id>
-DeploymentId <deployment-id>
● Rollback a Power BI pipeline deployment: Stop-PowerBIPipelineDeployment
-PipelineId <pipeline-id> -DeploymentId <deployment-id>

Monitoring and Alerting:

● Get Power BI service health: Get-PowerBIServiceHealth

● Get Power BI service incidents: Get-PowerBIServiceIncident
● Get Power BI service metrics: Get-PowerBIServiceMetric -MetricName
<metric-name> -StartDateTime <start-date> -EndDateTime <end-date>
● Create a Power BI alert: New-PowerBIAlert -AlertName "Alert Name"
-AlertType <alert-type> -Threshold <threshold> -Frequency <frequency>
● Update a Power BI alert: Set-PowerBIAlert -AlertId <alert-id> -AlertName
"New Alert Name" -Threshold <new-threshold>
● Delete a Power BI alert: Remove-PowerBIAlert -AlertId <alert-id>
● Get Power BI alert history: Get-PowerBIAlertHistory -AlertId <alert-id>
● Get Power BI alert incidents: Get-PowerBIAlertIncident -AlertId
<alert-id>
● Acknowledge a Power BI alert incident:
Set-PowerBIAlertIncidentAcknowledged -AlertId <alert-id> -IncidentId
<incident-id>

Automation and Scripting:

● Connect to Power BI service: Connect-PowerBIServiceAccount

● Disconnect from Power BI service: Disconnect-PowerBIServiceAccount
● Invoke a Power BI REST API request: Invoke-PowerBIRestMethod -Url
<api-url> -Method <http-method> -Body <request-body>
● Get a Power BI access token: Get-PowerBIAccessToken -ApplicationId
<app-id> -ApplicationSecret <app-secret>
● Create a Power BI service principal: New-PowerBIServicePrincipal
-ApplicationId <app-id> -ApplicationSecret <app-secret> -Tenant
<tenant-id>
● Assign a workspace to a service principal: Add-PowerBIWorkspaceUser
-WorkspaceId <workspace-id> -PrincipalId <service-principal-id>
-AccessRight <access-right>

By: Waleed Mousa

● Trigger a Power BI dataset refresh using a service principal:
Invoke-PowerBIRestMethod -Url "datasets/<dataset-id>/refresh" -Method
Post -AccessToken <service-principal-access-token>
● Export a Power BI report using a service principal:
Invoke-PowerBIRestMethod -Url "reports/<report-id>/export" -Method Get
-AccessToken <service-principal-access-token> -OutFile
"path/to/export.pbix"
● Clone a Power BI workspace using a service principal:
Invoke-PowerBIRestMethod -Url "groups/<workspace-id>/clone" -Method Post
-AccessToken <service-principal-access-token> -Body '{"name": "Cloned
Workspace", "description": "Cloned workspace description"}'
● Update a Power BI dataset using a service principal:
Invoke-PowerBIRestMethod -Url "datasets/<dataset-id>" -Method Patch
-AccessToken <service-principal-access-token> -Body '{"name": "Updated
Dataset Name"}'

By: Waleed Mousa