Set-PowerBIWorkspace

Updates a Power BI workspace.

Syntax

Set-PowerBIWorkspace
   [-Scope <PowerBIUserScope>]
   -Id <Guid>
   [-Name <String>]
   [-Description <String>]
   [<CommonParameters>]
Set-PowerBIWorkspace
   [-Scope <PowerBIUserScope>]
   -Workspace <Workspace>
   [<CommonParameters>]
Set-PowerBIWorkspace
   [-Scope <PowerBIUserScope>]
   -Id <Guid>
   -CapacityId <Guid>
   [<CommonParameters>]

Description

Updates the name or description of a Power BI workspace. Only workspaces in the new workspace experiences preview are supported. 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. Before you run this command, make sure you log in using Connect-PowerBIServiceAccount.

Examples

Example 1

PS C:\> Set-PowerBIWorkspace -Scope Organization -Id "3244f1c1-01cf-457f-9383-6035e4950fdc" -Name "Test Name" -Description "Test Description"

If the current user is an administrator, this will update the workspace matching the specified ID with the specified name and description values for a workspace in the caller's organization.

Example 2

PS C:\> $workspaces = Get-PowerBIWorkspace -Scope Organization
PS C:\> $workspace = $workspaces[0]
PS C:\> $workspace.Name = "Test Name"
PS C:\> $workspace.Description = "Test Description"
PS C:\> Set-PowerBIWorkspace -Scope Organization -Workspace $workspace

If the current user is an administrator, this will update the specified workspace object with the specified name and description values for a workspace in the caller's organization.

Parameters

-CapacityId

The capacity object id which a workspace will be assigned to. If CapacityId is set to "00000000-0000-0000-0000-000000000000", the workspace will be migrated to shared capacity.

Type:Guid
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Description

The new description to give to the workspace to update.

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

ID of the workspace to update.

Type:Guid
Aliases:GroupId, WorkspaceId
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Name

The new name to give to the workspace to update. If the name matches another workspace in the organization, the update operation will fail.

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

Indicates scope of the call. Only Organization is supported with this cmdlet. Organization operates against all workspaces within a tenant (must be an administrator to initiate). Individual is the default.

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

The workspace entity to update. The workspace will be updated with the name and description on the object.

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

Inputs

None

Outputs

System.Object