Restore-PowerBIWorkspace

Reference

Module:: MicrosoftPowerBIMgmt.Workspaces

Restores a deleted Power BI workspace.

Syntax

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

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

Description

Restores a deleted Power BI workspace with the owner set to the user that matches the specified email address. Only workspaces in the new workspace experiences are supported and only deleted workspaces that haven't reached the data retention policy to be completely removed. Only -Scope Organization is supported and you must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this command. You must have logged in previously before using Connect-PowerBIServiceAccount.

Examples

Example 1

PS C:\> Restore-PowerBIWorkspace -Id "3244f1c1-01cf-457f-9383-6035e4950fdc" -RestoredName "TestWorkspace" -AdminEmailAddress "john@contoso.com"

Restores the workspace with the specified ID, assigns the user with the specified email address as the admin, and updates the name of the workspace to the specified name.

Parameters

-AdminUserPrincipalName

User Principal Name (or UPN, commonly an email address) of the user who will become the admin of the restored workspace.

Type:	String
Aliases:	AdminEmailAddress
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Id

ID of the workspace to restore.

Type:	Guid
Aliases:	GroupId, WorkspaceId
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-RestoredName

An optional new name to give to the restored workspace.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Scope

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 completed removal. Organization is the default.

Type:	PowerBIUserScope
Accepted values:	Individual, Organization
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Workspace

The workspace entity to be restored.

Type:	Workspace
Aliases:	Group
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

System.Guid

Outputs

System.Object