en-US/Microsoft.PowerBI.Commands.Profile.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>Connect-PowerBIServiceAccount</command:name> <command:verb>Connect</command:verb> <command:noun>PowerBIServiceAccount</command:noun> <maml:description> <maml:para>Login to Power BI service.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Login to Power BI service with either a user or service principal account (application key or certificate). For user accounts, an Azure Active Directory (AAD) First-Party application is leveraged for authentication. To logout call Disconnect-PowerBIServiceAccount.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-PowerBIServiceAccount</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para>Azure Active Directory (AAD) Application ID (also known as Client ID) to be used with a certificate thumbprint (-CertificateThumbprint) to authenticate with a service principal account (-ServicePrincipal).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CertificateThumbprint</maml:name> <maml:Description> <maml:para>Certificate thumbprint of an installed certificate associated to an Azure Active Directory (AAD) Application. Certificate must be installed in either the CurrentUser or LocalMachine personal certificate stores (LocalMachine requires an administrator prompt to access) with a private key installed.</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>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to connect against. Default is Public.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Public</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Germany</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGov</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">China</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</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>ServicePrincipal</maml:name> <maml:Description> <maml:para>Indicates to use a service principal account, as opposed to a user account.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PowerBIServiceAccount</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>PSCredential representing the Azure Active Directory (AAD) application client ID (username) and application secret key (password) to authenticate with a service principal account (-ServicePrincipal).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</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>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to connect against. Default is Public.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Public</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Germany</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGov</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">China</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-PowerBIServiceAccount</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>PSCredential representing the Azure Active Directory (AAD) application client ID (username) and application secret key (password) to authenticate with a service principal account (-ServicePrincipal).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</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>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to connect against. Default is Public.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Public</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Germany</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">USGov</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">China</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</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>ServicePrincipal</maml:name> <maml:Description> <maml:para>Indicates to use a service principal account, as opposed to a user account.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</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>ApplicationId</maml:name> <maml:Description> <maml:para>Azure Active Directory (AAD) Application ID (also known as Client ID) to be used with a certificate thumbprint (-CertificateThumbprint) to authenticate with a service principal account (-ServicePrincipal).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CertificateThumbprint</maml:name> <maml:Description> <maml:para>Certificate thumbprint of an installed certificate associated to an Azure Active Directory (AAD) Application. Certificate must be installed in either the CurrentUser or LocalMachine personal certificate stores (LocalMachine requires an administrator prompt to access) with a private key installed.</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>Credential</maml:name> <maml:Description> <maml:para>PSCredential representing the Azure Active Directory (AAD) application client ID (username) and application secret key (password) to authenticate with a service principal account (-ServicePrincipal).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</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>Environment</maml:name> <maml:Description> <maml:para>Cloud environment to connect against. Default is Public.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerBIEnvironmentType</command:parameterValue> <dev:type> <maml:name>PowerBIEnvironmentType</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>ServicePrincipal</maml:name> <maml:Description> <maml:para>Indicates to use a service principal account, as opposed to a user account.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command: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.Abstractions.Interfaces.IPowerBIProfile</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:\> Connect-PowerBIServiceAccount</dev:code> <dev:remarks> <maml:para>Logs in using user authentication against the Public cloud, a prompt will display to collect credentials.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Connect-PowerBIServiceAccount -Environment China</dev:code> <dev:remarks> <maml:para>Logs in using user authentication against the China cloud, a prompt will display to collect credentials.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Connect-PowerBIServiceAccount -ServicePrincipal -Credential (Get-Credential)</dev:code> <dev:remarks> <maml:para>Logs in using a service principal against the Public cloud, a prompt will display from Get-Credential to enter your username (your AAD client ID) and password (your application secret key).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> Connect-PowerBIServiceAccount -ServicePrincipal -CertificateThumbprint 38DA4BED389A014E69A6E6D8AE56761E85F0DFA4 -ApplicationId b5fde143-722c-4e8d-8113-5b33a9291468</dev:code> <dev:remarks> <maml:para>Logs in using a service principal with an installed certificate to the Public cloud. The certificate must be installed in either CurrentUser or LocalMachine certificate store (LocalMachine requires administrator access) with a private key installed.</maml:para> </dev:remarks> </command:example> </command:examples> <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>Disconnect-PowerBIServiceAccount</command:name> <command:verb>Disconnect</command:verb> <command:noun>PowerBIServiceAccount</command:noun> <maml:description> <maml:para>Logout of the Power BI service.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Disconnects from any previous PowerBI Service connections. If there was no connections, the command completes without error.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disconnect-PowerBIServiceAccount</maml:name> </command:syntaxItem> </command:syntax> <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:\> Disconnect-PowerBIServiceAccount</dev:code> <dev:remarks> <maml:para>Disconnects any active PowerBI service connections.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |