Get-PowerBIWorkspace

NAME Get-PowerBIWorkspace



SYNOPSIS

Returns a list of Power BI workspaces.





SYNTAX

Get-PowerBIWorkspace -All [-Deleted] [-Filter <String>] [-Orphaned] [-Scope {Individual | Organization}] [-User

<String>] [<CommonParameters>]



Get-PowerBIWorkspace [-Deleted] [-Filter <String>] [-First <Int32>] [-Orphaned] [-Scope {Individual |

Organization}] [-Skip <Int32>] [-User <String>] [<CommonParameters>]



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



Get-PowerBIWorkspace -Name <String> [-Scope {Individual | Organization}] [<CommonParameters>]





DESCRIPTION

Retrieves a list of Power BI workspaces that match the specified search criteria and scope. By default (without

-First parameter) it shows the first 100 workspaces assigned to the user. Use -First and -Skip to fetch more

workspaces or use -All to return all workspaces. Before you run this command, make sure you log in using

Connect-PowerBIServiceAccount.





PARAMETERS

-All [<SwitchParameter>]

Indicates to show all the workspaces. -First and -Skip cannot be used with this parameter.



Required? true

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Deleted [<SwitchParameter>]

Indicates to show only deleted workspaces. Only supported when -Scope Organization is specified.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Filter <String>

OData filter, case-sensitive (element names start lowercase).



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-First <Int32>

First (top) list of results. This value defaults to 100.



Required? false

Position? named

Default value 100

Accept pipeline input? False

Accept wildcard characters? false



-Id <Guid>

ID of the workspace to return.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

Name of the workspace to return if one exists with that name. Case insensitive search.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Orphaned [<SwitchParameter>]

Indicates to show only orphaned workspaces. Only supported when -Scope Organization is specified.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Skip <Int32>

Skips the first set of results.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-User <String>

Filter workspaces to show ones which the user is contained within. Only available when -Scope is Organization.



Required? false

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.Collections.Generic.IEnumerable`1[[Microsoft.PowerBI.Common.Api.Workspaces.Workspace,

Microsoft.PowerBI.Common.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]







NOTES









-------------------------- Example 1 --------------------------



PS C:\\> Get-PowerBIWorkspace



Returns the first 100 Power BI workspaces the calling user is assigned to (-Scope Individual).

-------------------------- Example 2 --------------------------



PS C:\\> Get-PowerBIWorkspace -All



Returns all Power BI workspaces the calling user is assigned to.

-------------------------- Example 3 --------------------------



PS C:\\> Get-PowerBIWorkspace -Scope Organization -Filter "tolower(name) eq 'contoso sales'"



Returns a workspace named 'Contoso Sales' (case insensitive with tolower) within the user's organization.



RELATED LINKS

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

pace?view=powerbi-ps