Commands › Power BI

Restore-PowerBIWorkspace

Power BI MicrosoftPowerBIMgmt Restore-*

Restores a deleted Power BI workspace.

Quick start script

# Restore-PowerBIWorkspace — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-PowerBIServiceAccount -ServicePrincipal -CertificateThumbprint $thumb -ApplicationId $appId -Tenant $tenantId

# 2. Run and inspect
Restore-PowerBIWorkspace -AdminUserPrincipalName <String> -Id <Guid> -Workspace <Workspace> | Format-List

# 3. Export for evidence / drift tracking
Restore-PowerBIWorkspace | Export-Clixml .\PowerBIWorkspace-$(Get-Date -Format yyyyMMdd).xml

Syntax — 2 parameter sets

Id (Default)

Restore-PowerBIWorkspace [-Scope <PowerBIUserScope>] -Id <Guid> [-RestoredName <String>]
 -AdminUserPrincipalName <String> [<CommonParameters>]

Workspace

Restore-PowerBIWorkspace [-Scope <PowerBIUserScope>] [-RestoredName <String>] -AdminUserPrincipalName <String>
 -Workspace <Workspace> [<CommonParameters>]

Parameters (5)

ParameterTypeRequiredWhat it controls
-AdminUserPrincipalName String yes User Principal Name (or UPN, commonly an email address) of the user who will become the admin of the restored workspace.
-Id Guid yes ID of the workspace to restore.
-RestoredName String An optional new name to give to the restored workspace.
-Scope PowerBIUserScope Indicates scope of the call. Individual is not supported; Organization can restore any deleted workspaces within a tenant (must be an administrator to initiate) unless the workspace met its data retention policy and...
-Workspace Workspace yes The workspace entity to be restored.

Reference facts derived from Microsoft documentation, © Microsoft, licensed MIT; restructured with original guidance by serv365.ai.