Edit

Share via

Set-PowerBIWorkspace

Module:
MicrosoftPowerBIMgmt.Workspaces Module

Updates a Power BI workspace.

Syntax

Properties (Default) 

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

Workspace 

Set-PowerBIWorkspace
    -Workspace <Workspace>
    [-Scope <PowerBIUserScope>]
    [<CommonParameters>]

Capacity 

Set-PowerBIWorkspace
    -Id <Guid>
    -CapacityId <Guid>
    [-Scope <PowerBIUserScope>]
    [<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 the appropriate permissions or role (such as 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.

Parameter properties

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

Parameter sets

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

-Description

The new description to give to the workspace to update.

Parameter properties

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

Parameter sets

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

-Id

ID of the workspace to update.

Parameter properties

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

Parameter sets

Properties
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
Capacity
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

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

Parameter sets

Properties
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. 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.

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 update. The workspace will be updated with the name and description on the object.

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

None

Outputs

System.Object