Commands › Power BI
Set-PowerBIWorkspace
Updates a Power BI workspace.
Quick start script
# Set-PowerBIWorkspace — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-PowerBIServiceAccount -ServicePrincipal -CertificateThumbprint $thumb -ApplicationId $appId -Tenant $tenantId
# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-PowerBIWorkspace
$before | Format-List
# 3. Make the change
Set-PowerBIWorkspace -CapacityId <Guid> -Id <Guid> -Workspace <Workspace>
# 4. Verify and diff
$after = Get-PowerBIWorkspace
Compare-Object ($before | Out-String) ($after | Out-String)Syntax — 3 parameter sets
Properties (Default)
Set-PowerBIWorkspace [-Scope <PowerBIUserScope>] -Id <Guid> [-Name <String>] [-Description <String>]
[<CommonParameters>]Workspace
Set-PowerBIWorkspace [-Scope <PowerBIUserScope>] -Workspace <Workspace> [<CommonParameters>]Capacity
Set-PowerBIWorkspace [-Scope <PowerBIUserScope>] -Id <Guid> -CapacityId <Guid> [<CommonParameters>]Parameters (6)
| Parameter | Type | Required | What it controls |
|---|---|---|---|
| -CapacityId | Guid | yes | 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. |
| -Description | String | The new description to give to the workspace to update. | |
| -Id | Guid | yes | ID of the workspace to update. |
| -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. | |
| -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. | |
| -Workspace | Workspace | yes | The workspace entity to update. The workspace will be updated with the name and description on the object. |
Reference facts derived from Microsoft documentation, © Microsoft, licensed MIT; restructured with original guidance by serv365.ai.