Set-PowerBIWorkspace

NAME Set-PowerBIWorkspace



SYNOPSIS

Updates a Power BI workspace.





SYNTAX

Set-PowerBIWorkspace -CapacityId <Guid> -Id <Guid> [-Scope {Individual | Organization}] [<CommonParameters>]



Set-PowerBIWorkspace [-Description <String>] -Id <Guid> [-Name <String>] [-Scope {Individual | Organization}]

[<CommonParameters>]



Set-PowerBIWorkspace [-Scope {Individual | Organization}] -Workspace <Workspace> [<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.





PARAMETERS

-CapacityId <Guid>

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.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Description <String>

The new description to give to the workspace to update.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Id <Guid>

ID of the workspace to update.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Name <String>

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

the update operation will fail.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Scope <PowerBIUserScope>

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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Workspace <Workspace>

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



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None







OUTPUTS

System.Object







NOTES









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



RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... werbiworks

pace?view=powerbi-ps