Edit

Share via

Restore-PowerBIWorkspace

Module:
MicrosoftPowerBIMgmt.Workspaces Module

Restores a deleted Power BI workspace.

Syntax

Id (Default) 

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

Workspace 

Restore-PowerBIWorkspace
    -AdminUserPrincipalName <String>
    -Workspace <Workspace>
    [-Scope <PowerBIUserScope>]
    [-RestoredName <String>]
    [<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 the appropriate permissions or role (such as 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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AdminEmailAddress

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

ID of the workspace to restore.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False
Aliases:GroupId, WorkspaceId

Parameter sets

Id
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-RestoredName

An optional new name to give to the restored workspace.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:PowerBIUserScope
Default value:None
Accepted values:Individual, Organization
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Workspace

The workspace entity to be restored.

Parameter properties

Type:Workspace
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Group

Parameter sets

Workspace
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

System.Guid

Outputs

System.Object