en-US/Microsoft.PowerBI.Commands.Reports.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>Export-PowerBIReport</command:name> <command:verb>Export</command:verb> <command:noun>PowerBIReport</command:noun> <maml:description> <maml:para>Exports a Power BI report to the .pbix file format.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Saves a Power BI report from the Power BI service into a .pbix file that can be loaded by the Power BI Desktop or uploaded back to Power BI service. Before you run this command, make sure you log in using Connect-PowerBIServiceAccount.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-PowerBIReport</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ReportId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the report to export.</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>OutFile</maml:name> <maml:Description> <maml:para>Output file to save the exported report to. Path must not already exist.</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="GroupId"> <maml:name>WorkspaceId</maml:name> <maml:Description> <maml:para>ID of the workspace containing the Power BI report to export.</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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ReportId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the report to export.</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>OutFile</maml:name> <maml:Description> <maml:para>Output file to save the exported report to. Path must not already exist.</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="GroupId"> <maml:name>WorkspaceId</maml:name> <maml:Description> <maml:para>ID of the workspace containing the Power BI report to export.</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: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:\> Export-PowerBIReport -Id 9b519499-5ba1-4f1c-878b-be3a69f1791f -OutFile .\Sales.pbix</dev:code> <dev:remarks> <maml:para>Saves report with ID 9b519499-5ba1-4f1c-878b-be3a69f1791f into a file named Sales.pbix in your current working directory ($PWD).</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.reports/export-powerbireport?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-PowerBIDashboard</command:name> <command:verb>Get</command:verb> <command:noun>PowerBIDashboard</command:noun> <maml:description> <maml:para>Returns a list of Power BI dashboards.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves a list of Power BI dashboards 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-PowerBIDashboard</maml:name> <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). Only supported when -Scope Organization is specified.</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>Scope</maml:name> <maml:Description> <maml:para>Indicates the scope of the call. Individual returns only dashboards assigned to the caller; Organization returns all dashboards 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="GroupId"> <maml:name>WorkspaceId</maml:name> <maml:Description> <maml:para>ID of the workspace to filter results to; only dashboards that belong to that workspace are shown.</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:syntaxItem> <command:syntaxItem> <maml:name>Get-PowerBIDashboard</maml:name> <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). Only supported when -Scope Organization is specified.</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>Scope</maml:name> <maml:Description> <maml:para>Indicates the scope of the call. Individual returns only dashboards assigned to the caller; Organization returns all dashboards 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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="Group"> <maml:name>Workspace</maml:name> <maml:Description> <maml:para>Workspace to filter results to; only dashboards that belong to that workspace are shown.</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:syntaxItem> <maml:name>Get-PowerBIDashboard</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ImportId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the dashboard 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 the scope of the call. Individual returns only dashboards assigned to the caller; Organization returns all dashboards 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="GroupId"> <maml:name>WorkspaceId</maml:name> <maml:Description> <maml:para>ID of the workspace to filter results to; only dashboards that belong to that workspace are shown.</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:syntaxItem> <command:syntaxItem> <maml:name>Get-PowerBIDashboard</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ImportId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the dashboard 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 the scope of the call. Individual returns only dashboards assigned to the caller; Organization returns all dashboards 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="True (ByValue)" position="named" aliases="Group"> <maml:name>Workspace</maml:name> <maml:Description> <maml:para>Workspace to filter results to; only dashboards that belong to that workspace are shown.</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:syntaxItem> <maml:name>Get-PowerBIDashboard</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 dashboard 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 the scope of the call. Individual returns only dashboards assigned to the caller; Organization returns all dashboards 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="GroupId"> <maml:name>WorkspaceId</maml:name> <maml:Description> <maml:para>ID of the workspace to filter results to; only dashboards that belong to that workspace are shown.</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:syntaxItem> <command:syntaxItem> <maml:name>Get-PowerBIDashboard</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 dashboard 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 the scope of the call. Individual returns only dashboards assigned to the caller; Organization returns all dashboards 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="True (ByValue)" position="named" aliases="Group"> <maml:name>Workspace</maml:name> <maml:Description> <maml:para>Workspace to filter results to; only dashboards that belong to that workspace are shown.</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>Filter</maml:name> <maml:Description> <maml:para>OData filter, case-sensitive (element names start lowercase). Only supported when -Scope Organization is specified.</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="ImportId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the dashboard 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 dashboard 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 the scope of the call. Individual returns only dashboards assigned to the caller; Organization returns all dashboards 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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="Group"> <maml:name>Workspace</maml:name> <maml:Description> <maml:para>Workspace to filter results to; only dashboards that belong to that workspace are shown.</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="GroupId"> <maml:name>WorkspaceId</maml:name> <maml:Description> <maml:para>ID of the workspace to filter results to; only dashboards that belong to that workspace are shown.</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: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.Reports.Dashboard, 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-PowerBIDashboard</dev:code> <dev:remarks> <maml:para>Returns all Power BI dashboards that 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-PowerBIDashboard -Scope Organization -Name 'Contoso Sales'</dev:code> <dev:remarks> <maml:para>Returns a workspace named 'Contoso Sales' (case insensitive) 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.reports/get-powerbidashboard?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-PowerBIImport</command:name> <command:verb>Get</command:verb> <command:noun>PowerBIImport</command:noun> <maml:description> <maml:para>Returns a list of Power BI imports.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves a list of Power BI imports 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-PowerBIImport</maml:name> <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). Only supported when -Scope Organization is specified.</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>Scope</maml:name> <maml:Description> <maml:para>Indicates scope of the call. Individual returns only imports assigned to the caller; Organization returns all imports 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="GroupId"> <maml:name>WorkspaceId</maml:name> <maml:Description> <maml:para>ID of the workspace to filter results to; only imports that belong to that workspace are shown. Only available when -Scope is Individual.</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:syntaxItem> <command:syntaxItem> <maml:name>Get-PowerBIImport</maml:name> <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). Only supported when -Scope Organization is specified.</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>Scope</maml:name> <maml:Description> <maml:para>Indicates scope of the call. Individual returns only imports assigned to the caller; Organization returns all imports 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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="Group"> <maml:name>Workspace</maml:name> <maml:Description> <maml:para>Workspace to filter results to; only imports that belong to that workspace are shown. Only available when -Scope is Individual.</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:syntaxItem> <maml:name>Get-PowerBIImport</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ImportId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the import 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 imports assigned to the caller; Organization returns all imports 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="GroupId"> <maml:name>WorkspaceId</maml:name> <maml:Description> <maml:para>ID of the workspace to filter results to; only imports that belong to that workspace are shown. Only available when -Scope is Individual.</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:syntaxItem> <command:syntaxItem> <maml:name>Get-PowerBIImport</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ImportId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the import 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 imports assigned to the caller; Organization returns all imports 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="True (ByValue)" position="named" aliases="Group"> <maml:name>Workspace</maml:name> <maml:Description> <maml:para>Workspace to filter results to; only imports that belong to that workspace are shown. Only available when -Scope is Individual.</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:syntaxItem> <maml:name>Get-PowerBIImport</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 import 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 imports assigned to the caller; Organization returns all imports 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="GroupId"> <maml:name>WorkspaceId</maml:name> <maml:Description> <maml:para>ID of the workspace to filter results to; only imports that belong to that workspace are shown. Only available when -Scope is Individual.</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:syntaxItem> <command:syntaxItem> <maml:name>Get-PowerBIImport</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 import 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 imports assigned to the caller; Organization returns all imports 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="True (ByValue)" position="named" aliases="Group"> <maml:name>Workspace</maml:name> <maml:Description> <maml:para>Workspace to filter results to; only imports that belong to that workspace are shown. Only available when -Scope is Individual.</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>Filter</maml:name> <maml:Description> <maml:para>OData filter, case-sensitive (element names start lowercase). Only supported when -Scope Organization is specified.</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="ImportId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the import 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 import 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 imports assigned to the caller; Organization returns all imports 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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="Group"> <maml:name>Workspace</maml:name> <maml:Description> <maml:para>Workspace to filter results to; only imports that belong to that workspace are shown. Only available when -Scope is Individual.</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="GroupId"> <maml:name>WorkspaceId</maml:name> <maml:Description> <maml:para>ID of the workspace to filter results to; only imports that belong to that workspace are shown. Only available when -Scope is Individual.</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: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.Reports.Import, 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-PowerBIImport</dev:code> <dev:remarks> <maml:para>Returns all Power BI workspaces that 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-PowerBIImport -Scope Organization</dev:code> <dev:remarks> <maml:para>Returns all Power BI imports 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.reports/get-powerbiimport?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-PowerBIReport</command:name> <command:verb>Get</command:verb> <command:noun>PowerBIReport</command:noun> <maml:description> <maml:para>Returns a list of Power BI reports.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves a list of Power BI reports 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-PowerBIReport</maml:name> <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). Only supported when -Scope Organization is specified.</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>Scope</maml:name> <maml:Description> <maml:para>Indicates scope of the call. Individual returns only reports assigned to the caller; Organization returns all reports 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="GroupId"> <maml:name>WorkspaceId</maml:name> <maml:Description> <maml:para>ID of the workspace to filter results to; only reports that belong to that workspace are shown.</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:syntaxItem> <command:syntaxItem> <maml:name>Get-PowerBIReport</maml:name> <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). Only supported when -Scope Organization is specified.</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>Scope</maml:name> <maml:Description> <maml:para>Indicates scope of the call. Individual returns only reports assigned to the caller; Organization returns all reports 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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="Group"> <maml:name>Workspace</maml:name> <maml:Description> <maml:para>Workspace to filter results to; only reports that belong to that workspace are shown.</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:syntaxItem> <maml:name>Get-PowerBIReport</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ReportId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the report 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 reports assigned to the caller; Organization returns all reports 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="GroupId"> <maml:name>WorkspaceId</maml:name> <maml:Description> <maml:para>ID of the workspace to filter results to; only reports that belong to that workspace are shown.</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:syntaxItem> <command:syntaxItem> <maml:name>Get-PowerBIReport</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ReportId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the report 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 reports assigned to the caller; Organization returns all reports 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="True (ByValue)" position="named" aliases="Group"> <maml:name>Workspace</maml:name> <maml:Description> <maml:para>Workspace to filter results to; only reports that belong to that workspace are shown.</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:syntaxItem> <maml:name>Get-PowerBIReport</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 report 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 reports assigned to the caller; Organization returns all reports 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="GroupId"> <maml:name>WorkspaceId</maml:name> <maml:Description> <maml:para>ID of the workspace to filter results to; only reports that belong to that workspace are shown.</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:syntaxItem> <command:syntaxItem> <maml:name>Get-PowerBIReport</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 report 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 reports assigned to the caller; Organization returns all reports 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="True (ByValue)" position="named" aliases="Group"> <maml:name>Workspace</maml:name> <maml:Description> <maml:para>Workspace to filter results to; only reports that belong to that workspace are shown.</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>Filter</maml:name> <maml:Description> <maml:para>OData filter, case-sensitive (element names start lowercase). Only supported when -Scope Organization is specified.</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="ReportId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the report 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 report 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 reports assigned to the caller; Organization returns all reports 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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="Group"> <maml:name>Workspace</maml:name> <maml:Description> <maml:para>Workspace to filter results to; only reports that belong to that workspace are shown.</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="GroupId"> <maml:name>WorkspaceId</maml:name> <maml:Description> <maml:para>ID of the workspace to filter results to; only reports that belong to that workspace are shown.</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: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.Reports.Report, 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-PowerBIReport</dev:code> <dev:remarks> <maml:para>Returns a list of all PowerBI reports that a user has access to.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-PowerBIReport -Scope Organization</dev:code> <dev:remarks> <maml:para>Returns a list of all PowerBI reports within a 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.reports/get-powerbireport?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-PowerBITile</command:name> <command:verb>Get</command:verb> <command:noun>PowerBITile</command:noun> <maml:description> <maml:para>Returns a list of Power BI tiles for a dashboard.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves a list of Power BI tiles 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-PowerBITile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DashboardId</maml:name> <maml:Description> <maml:para>ID of the dashboard to return tiles for.</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="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>Scope</maml:name> <maml:Description> <maml:para>Indicates scope of the call. Individual returns only tiles assigned to the caller; Organization returns all tiles 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="GroupId"> <maml:name>WorkspaceId</maml:name> <maml:Description> <maml:para>ID of the workspace to filter results to; only tiles that belong to that workspace are shown. Only available when -Scope is Individual.</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:syntaxItem> <command:syntaxItem> <maml:name>Get-PowerBITile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DashboardId</maml:name> <maml:Description> <maml:para>ID of the dashboard to return tiles for.</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="ImportId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the tile 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 tiles assigned to the caller; Organization returns all tiles 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="GroupId"> <maml:name>WorkspaceId</maml:name> <maml:Description> <maml:para>ID of the workspace to filter results to; only tiles that belong to that workspace are shown. Only available when -Scope is Individual.</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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DashboardId</maml:name> <maml:Description> <maml:para>ID of the dashboard to return tiles for.</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="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="ImportId"> <maml:name>Id</maml:name> <maml:Description> <maml:para>ID of the tile 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 tiles assigned to the caller; Organization returns all tiles 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="GroupId"> <maml:name>WorkspaceId</maml:name> <maml:Description> <maml:para>ID of the workspace to filter results to; only tiles that belong to that workspace are shown. Only available when -Scope is Individual.</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: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.Reports.Tile, 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-PowerBITile -DashboardId 6b071d0b-7430-4342-a3a6-d5c0fac130e4</dev:code> <dev:remarks> <maml:para>Returns a list of tiles in the Power BI dashboard with ID 6b071d0b-7430-4342-a3a6-d5c0fac130e4, for a user that has access to the dashboard.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-PowerBITile -DashboardId 6b071d0b-7430-4342-a3a6-d5c0fac130e4 -Scope Organization</dev:code> <dev:remarks> <maml:para>Returns a list of tiles in the Power BI dashboard with ID 6b071d0b-7430-4342-a3a6-d5c0fac130e4, for a dashboard in 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.reports/get-powerbitile?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>New-PowerBIReport</command:name> <command:verb>New</command:verb> <command:noun>PowerBIReport</command:noun> <maml:description> <maml:para>Creates a Power BI report.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Loads a Power BI report from a pbix file and deploys it to the Power BI service. Before you run this command, make sure you log in using Connect-PowerBIServiceAccount.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-PowerBIReport</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The path to the pbix file.</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>ConflictAction</maml:name> <maml:Description> <maml:para>Determines what to do if a dataset with the same name already exists. Default value is 'CreateOrOverwrite'</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Ignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Abort</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Overwrite</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CreateOrOverwrite</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ImportConflictHandlerModeEnum</command:parameterValue> <dev:type> <maml:name>ImportConflictHandlerModeEnum</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="ReportName"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The report name. If not set, the file name will be used.</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>Timeout</maml:name> <maml:Description> <maml:para>The number of seconds to wait for the service. If not set no timeout will be used.</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="Group"> <maml:name>Workspace</maml:name> <maml:Description> <maml:para>The workspace to deploy the report 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:syntaxItem> <maml:name>New-PowerBIReport</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The path to the pbix file.</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>ConflictAction</maml:name> <maml:Description> <maml:para>Determines what to do if a dataset with the same name already exists. Default value is 'CreateOrOverwrite'</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Ignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Abort</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Overwrite</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CreateOrOverwrite</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ImportConflictHandlerModeEnum</command:parameterValue> <dev:type> <maml:name>ImportConflictHandlerModeEnum</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="ReportName"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The report name. If not set, the file name will be used.</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>Timeout</maml:name> <maml:Description> <maml:para>The number of seconds to wait for the service. If not set no timeout will be used.</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="GroupId"> <maml:name>WorkspaceId</maml:name> <maml:Description> <maml:para>The id of the workspace to deploy the report to</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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ConflictAction</maml:name> <maml:Description> <maml:para>Determines what to do if a dataset with the same name already exists. Default value is 'CreateOrOverwrite'</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ImportConflictHandlerModeEnum</command:parameterValue> <dev:type> <maml:name>ImportConflictHandlerModeEnum</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="ReportName"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The report name. If not set, the file name will be used.</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="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The path to the pbix file.</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>Timeout</maml:name> <maml:Description> <maml:para>The number of seconds to wait for the service. If not set no timeout will be used.</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="Group"> <maml:name>Workspace</maml:name> <maml:Description> <maml:para>The workspace to deploy the report 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="GroupId"> <maml:name>WorkspaceId</maml:name> <maml:Description> <maml:para>The id of the workspace to deploy the report to</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: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>Microsoft.PowerBI.Common.Api.Reports.Report</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:\> New-PowerBIReport -Path '.\report.pbix' -Name 'Report'</dev:code> <dev:remarks> <maml:para>Adds the report to the personal Workspace.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-PowerBIReport -Path '.\report.pbix' -Name 'Report' -Workspace ( Get-PowerBIWorkspace -Name 'Team Workspace' )</dev:code> <dev:remarks> <maml:para>Adds the report to the Team Workspace.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |