Commands › Power BI
Get-PowerBIWorkspace
Returns a list of Power BI workspaces.
Quick start script
# Get-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. Run and inspect
Get-PowerBIWorkspace -All <SwitchParameter> -Id <Guid> -Name <String> | Format-List
# 3. Export for evidence / drift tracking
Get-PowerBIWorkspace | Export-Clixml .\PowerBIWorkspace-$(Get-Date -Format yyyyMMdd).xmlSyntax — 4 parameter sets
List (Default)
Get-PowerBIWorkspace [-Scope <PowerBIUserScope>] [-Filter <String>] [-User <String>] [-Deleted] [-Orphaned]
[-First <Int32>] [-Skip <Int32>] [-Include <ArtifactType[]>] [<CommonParameters>]Id
Get-PowerBIWorkspace -Id <Guid> [-Scope <PowerBIUserScope>] [-Include <ArtifactType[]>] [<CommonParameters>]Name
Get-PowerBIWorkspace -Name <String> [-Scope <PowerBIUserScope>] [-Include <ArtifactType[]>]
[<CommonParameters>]All
Get-PowerBIWorkspace [-Scope <PowerBIUserScope>] [-Filter <String>] [-User <String>] [-Deleted] [-Orphaned]
[-Include <ArtifactType[]>] [-All] [<CommonParameters>]Parameters (11)
| Parameter | Type | Required | What it controls |
|---|---|---|---|
| -All | SwitchParameter | yes | Indicates to show all the workspaces. -First and -Skip cannot be used with this parameter. |
| -Deleted | SwitchParameter | Indicates to show only deleted workspaces. Only supported when -Scope Organization is specified. | |
| -Filter | String | OData filter, case-sensitive (element names start lowercase). | |
| -First | Int32 | First (top) list of results. This value defaults to 100. | |
| -Id | Guid | yes | ID of the workspace to return. |
| -Include | ArtifactType[] | Retrieves related artifacts associated with the Power BI workspace. Only available when -Scope is Organization. | |
| -Name | String | yes | Name of the workspace to return if one exists with that name. Case insensitive search. |
| -Orphaned | SwitchParameter | Indicates to show only orphaned workspaces. Only supported when -Scope Organization is specified. | |
| -Scope | PowerBIUserScope | Indicates scope of the call. Individual returns only workspaces assigned to the caller; Organization returns all workspaces within a tenant (must be an administrator to initiate). Individual is the default. | |
| -Skip | Int32 | Skips the first set of results. | |
| -User | String | Filter workspaces to show ones which the user is contained within. Only available when -Scope is Organization. |
Reference facts derived from Microsoft documentation, © Microsoft, licensed MIT; restructured with original guidance by serv365.ai.