en-US/Microsoft.PowerBI.Commands.Workspaces.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-PowerBIWorkspaceUser</command:name> <command:verb>Add</command:verb> <command:noun>PowerBIWorkspaceUser</command:noun> <maml:description> <maml:para>Gives permissions to a specified user to access a Power BI workspace.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Grants permissions to a specified user to access a Power BI workspace using the provided inputs and scope specified. Before you run this command, make sure you log in using Connect-PowerBIServiceAccount.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-PowerBIWorkspaceUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="UserAccessRight"> <maml:name>AccessRight</maml:name> <maml:Description> <maml:para>Permissions to assign to the user.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Member</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Admin</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Contributor</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WorkspaceUserAccessRight</command:parameterValue> <dev:type> <maml:name>WorkspaceUserAccessRight</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="GroupId, WorkspaceId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Workspace or Group Id for which user should be added.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Indicates scope of the call. Individual operates against only workspaces assigned to the caller; Organization operates against all workspaces within a tenant (must be an administrator to initiate). Individual is the default.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Individual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="UserEmailAddress"> <maml:name>UserPrincipalName</maml:name> <maml:Description> <maml:para>User Principal Name (or UPN, commonly an email address) for the user whose permissions need to be added.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-PowerBIWorkspaceUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="UserAccessRight"> <maml:name>AccessRight</maml:name> <maml:Description> <maml:para>Permissions to assign to the user.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Member</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Admin</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Contributor</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WorkspaceUserAccessRight</command:parameterValue> <dev:type> <maml:name>WorkspaceUserAccessRight</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Indicates scope of the call. Individual operates against only workspaces assigned to the caller; Organization operates against all workspaces within a tenant (must be an administrator to initiate). Individual is the default.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Individual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="UserEmailAddress"> <maml:name>UserPrincipalName</maml:name> <maml:Description> <maml:para>User Principal Name (or UPN, commonly an email address) for the user whose permissions need to be added.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Group"> <maml:name>Workspace</maml:name> <maml:Description> <maml:para>The workspace entity to add the user to.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Workspace</command:parameterValue> <dev:type> <maml:name>Workspace</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="UserAccessRight"> <maml:name>AccessRight</maml:name> <maml:Description> <maml:para>Permissions to assign to the user.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">WorkspaceUserAccessRight</command:parameterValue> <dev:type> <maml:name>WorkspaceUserAccessRight</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="GroupId, WorkspaceId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Workspace or Group Id for which user should be added.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Indicates scope of the call. Individual operates against only workspaces assigned to the caller; Organization operates against all workspaces within a tenant (must be an administrator to initiate). Individual is the default.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="UserEmailAddress"> <maml:name>UserPrincipalName</maml:name> <maml:Description> <maml:para>User Principal Name (or UPN, commonly an email address) for the user whose permissions need to be added.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Group"> <maml:name>Workspace</maml:name> <maml:Description> <maml:para>The workspace entity to add the user to.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Workspace</command:parameterValue> <dev:type> <maml:name>Workspace</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Add-PowerBIWorkspaceUser -Scope Organization -Id 23FCBDBD-A979-45D8-B1C8-6D21E0F4BE50 -UserEmailAddress john@contoso.com -AccessRight Admin</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/microsoftpowerbimgmt.workspaces/add-powerbiworkspaceuser?view=powerbi-ps</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-PowerBIWorkspace</command:name> <command:verb>Get</command:verb> <command:noun>PowerBIWorkspace</command:noun> <maml:description> <maml:para>Returns a list of Power BI workspaces.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves a list of Power BI workspaces that match the specified search criteria and scope. Before you run this command, make sure you log in using Connect-PowerBIServiceAccount.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PowerBIWorkspace</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Deleted</maml:name> <maml:Description> <maml:para>Indicates to show only deleted workspaces. Only supported when -Scope Organization is specified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>OData filter, case-sensitive (element names start lowercase).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Top"> <maml:name>First</maml:name> <maml:Description> <maml:para>First (top) list of results.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Orphaned</maml:name> <maml:Description> <maml:para>Indicates to show only orphaned workspaces. Only supported when -Scope Organization is specified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Individual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Skip</maml:name> <maml:Description> <maml:para>Skips the first set of results.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>User</maml:name> <maml:Description> <maml:para>Filter workspaces to show ones which the user is contained within. Only available when -Scope is Organization.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PowerBIWorkspace</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="GroupId, WorkspaceId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Id of the workspace to return.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Individual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PowerBIWorkspace</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the workspace to return if one exists with that name. Case insensitive search.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Individual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Deleted</maml:name> <maml:Description> <maml:para>Indicates to show only deleted workspaces. Only supported when -Scope Organization is specified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>OData filter, case-sensitive (element names start lowercase).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Top"> <maml:name>First</maml:name> <maml:Description> <maml:para>First (top) list of results.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="GroupId, WorkspaceId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Id of the workspace to return.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the workspace to return if one exists with that name. Case insensitive search.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Orphaned</maml:name> <maml:Description> <maml:para>Indicates to show only orphaned workspaces. Only supported when -Scope Organization is specified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Skip</maml:name> <maml:Description> <maml:para>Skips the first set of results.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>User</maml:name> <maml:Description> <maml:para>Filter workspaces to show ones which the user is contained within. Only available when -Scope is Organization.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.IEnumerable`1[[Microsoft.PowerBI.Common.Api.Workspaces.Workspace, Microsoft.PowerBI.Common.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-PowerBIWorkspace</dev:code> <dev:remarks> <maml:para>Returns all Power BI workspaces the calling user is assigned to (-Scope Individual).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-PowerBIWorkspace -Scope Organization -Filter "tolower(name) eq 'contoso sales'"</dev:code> <dev:remarks> <maml:para>Returns a workspace named 'Contoso Sales' (case insensitive with tolower) within the user's organization.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/microsoftpowerbimgmt.workspaces/get-powerbiworkspace?view=powerbi-ps</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-PowerBIWorkspaceUser</command:name> <command:verb>Remove</command:verb> <command:noun>PowerBIWorkspaceUser</command:noun> <maml:description> <maml:para>Removes permissions to a Power BI workspace for the specified user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes permissions for a specified user to a Power BI workspace using the provided inputs and scope specified. Before you run this command, make sure you log in using Connect-PowerBIServiceAccount.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-PowerBIWorkspaceUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="GroupId, WorkspaceId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Workspace or Group Id for which user should be removed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Indicates scope of the call. Individual operates against only workspaces assigned to the caller; Organization operates against all workspaces within a tenant (must be an administrator to initiate). Individual is the default.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Individual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="UserEmailAddress"> <maml:name>UserPrincipalName</maml:name> <maml:Description> <maml:para>User Principal Name (or UPN, commonly an email address) for the user whose permissions need to be removed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-PowerBIWorkspaceUser</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Indicates scope of the call. Individual operates against only workspaces assigned to the caller; Organization operates against all workspaces within a tenant (must be an administrator to initiate). Individual is the default.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Individual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="UserEmailAddress"> <maml:name>UserPrincipalName</maml:name> <maml:Description> <maml:para>User Principal Name (or UPN, commonly an email address) for the user whose permissions need to be removed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Group"> <maml:name>Workspace</maml:name> <maml:Description> <maml:para>The workspace entity to remove the user from.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Workspace</command:parameterValue> <dev:type> <maml:name>Workspace</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="GroupId, WorkspaceId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Workspace or Group Id for which user should be removed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Indicates scope of the call. Individual operates against only workspaces assigned to the caller; Organization operates against all workspaces within a tenant (must be an administrator to initiate). Individual is the default.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="UserEmailAddress"> <maml:name>UserPrincipalName</maml:name> <maml:Description> <maml:para>User Principal Name (or UPN, commonly an email address) for the user whose permissions need to be removed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Group"> <maml:name>Workspace</maml:name> <maml:Description> <maml:para>The workspace entity to remove the user from.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Workspace</command:parameterValue> <dev:type> <maml:name>Workspace</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-PowerBIWorkspaceUser -Scope Organization -Id 23FCBDBD-A979-45D8-B1C8-6D21E0F4BE50 -UserEmailAddress john@contoso.com</dev:code> <dev:remarks> <maml:para>Removes permissions for user john@contoso.com on workspace with ID 23FCBDBD-A979-45D8-B1C8-6D21E0F4BE50 within the caller's organization.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Remove-PowerBIWorkspaceUser -Scope Individual -Id 23FCBDBD-A979-45D8-B1C8-6D21E0F4BE50 -UserEmailAddress john@contoso.com</dev:code> <dev:remarks> <maml:para>Removes permissions for john@contoso.com on workspace with ID 23FCBDBD-A979-45D8-B1C8-6D21E0F4BE50, which is a workpace the caller owns.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/microsoftpowerbimgmt.workspaces/remove-powerbiworkspaceuser?view=powerbi-ps</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Restore-PowerBIWorkspace</command:name> <command:verb>Restore</command:verb> <command:noun>PowerBIWorkspace</command:noun> <maml:description> <maml:para>Restores a deleted Power BI workspace.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Restores a deleted Power BI workspace with the owner set to the user that matches the specified email address. Only workspaces in the new workspace experiences preview are supported and only deleted workspaces that haven't reached the data retention policy to be completely removed. 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. You must have logged in previously before using Connect-PowerBIServiceAccount.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Restore-PowerBIWorkspace</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AdminEmailAddress"> <maml:name>AdminUserPrincipalName</maml:name> <maml:Description> <maml:para>User Principal Name (or UPN, commonly an email address) of the user who will become the admin of the restored workspace.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="GroupId, WorkspaceId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the workspace to restore.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RestoredName</maml:name> <maml:Description> <maml:para>An optional new name to give to the restored workspace.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Indicates scope of the call. Individual is not supported; Organization can restore any deleted workspaces within a tenant (must be an administrator to initiate) unless the workspace met its data retention policy and completed removal. Organization is the default.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Individual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Restore-PowerBIWorkspace</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AdminEmailAddress"> <maml:name>AdminUserPrincipalName</maml:name> <maml:Description> <maml:para>User Principal Name (or UPN, commonly an email address) of the user who will become the admin of the restored workspace.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RestoredName</maml:name> <maml:Description> <maml:para>An optional new name to give to the restored workspace.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Indicates scope of the call. Individual is not supported; Organization can restore any deleted workspaces within a tenant (must be an administrator to initiate) unless the workspace met its data retention policy and completed removal. Organization is the default.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Individual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Group"> <maml:name>Workspace</maml:name> <maml:Description> <maml:para>The workspace entity to be restored.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Workspace</command:parameterValue> <dev:type> <maml:name>Workspace</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AdminEmailAddress"> <maml:name>AdminUserPrincipalName</maml:name> <maml:Description> <maml:para>User Principal Name (or UPN, commonly an email address) of the user who will become the admin of the restored workspace.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="GroupId, WorkspaceId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the workspace to restore.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RestoredName</maml:name> <maml:Description> <maml:para>An optional new name to give to the restored workspace.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>Indicates scope of the call. Individual is not supported; Organization can restore any deleted workspaces within a tenant (must be an administrator to initiate) unless the workspace met its data retention policy and completed removal. Organization is the default.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Group"> <maml:name>Workspace</maml:name> <maml:Description> <maml:para>The workspace entity to be restored.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Workspace</command:parameterValue> <dev:type> <maml:name>Workspace</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Restore-PowerBIWorkspace -Id "3244f1c1-01cf-457f-9383-6035e4950fdc" -RestoredName "TestWorkspace" -AdminEmailAddress "john@contoso.com"</dev:code> <dev:remarks> <maml:para>Restores the workspace with the specified ID, assigns the user with the specified email address as the admin, and updates the name of the workspace to the specified name.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/microsoftpowerbimgmt.workspaces/restore-powerbiworkspace?view=powerbi-ps</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-PowerBIWorkspace</command:name> <command:verb>Set</command:verb> <command:noun>PowerBIWorkspace</command:noun> <maml:description> <maml:para>Updates a Power BI workspace.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PowerBIWorkspace</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>The new description to give to the workspace to update.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="GroupId, WorkspaceId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the workspace to update.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The new name to give to the workspace to update. If the name matches another workspace in the organization, the update operation will fail.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Individual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-PowerBIWorkspace</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Individual</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Group"> <maml:name>Workspace</maml:name> <maml:Description> <maml:para>The workspace entity to update. The workspace will be updated with the name and description on the object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Workspace</command:parameterValue> <dev:type> <maml:name>Workspace</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>The new description to give to the workspace to update.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="GroupId, WorkspaceId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the workspace to update.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The new name to give to the workspace to update. If the name matches another workspace in the organization, the update operation will fail.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Scope</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIUserScope</command:parameterValue> <dev:type> <maml:name>PowerBIUserScope</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Group"> <maml:name>Workspace</maml:name> <maml:Description> <maml:para>The workspace entity to update. The workspace will be updated with the name and description on the object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Workspace</command:parameterValue> <dev:type> <maml:name>Workspace</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Set-PowerBIWorkspace -Scope Organization -Id "3244f1c1-01cf-457f-9383-6035e4950fdc" -Name "Test Name" -Description "Test Description"</dev:code> <dev:remarks> <maml:para>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.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>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</dev:code> <dev:remarks> <maml:para>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.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/microsoftpowerbimgmt.workspaces/set-powerbiworkspace?view=powerbi-ps</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |