< Back
Connect-PowerBIServiceAccount
Post
NAME Connect-PowerBIServiceAccount
SYNOPSIS
Log in to the Power BI service.
SYNTAX
Connect-PowerBIServiceAccount -ApplicationId <String> -CertificateThumbprint <String> [-Environment {Public |
Germany | USGov | China | USGovHigh | USGovMil}] -ServicePrincipal [-Tenant <String>] [<CommonParameters>]
Connect-PowerBIServiceAccount -Credential <PSCredential> [-Environment {Public | Germany | USGov | China |
USGovHigh | USGovMil}] -ServicePrincipal [-Tenant <String>] [<CommonParameters>]
Connect-PowerBIServiceAccount -Credential <PSCredential> [-Environment {Public | Germany | USGov | China |
USGovHigh | USGovMil}] [<CommonParameters>]
DESCRIPTION
Log in 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 log out
call Disconnect-PowerBIServiceAccount.
PARAMETERS
-ApplicationId <String>
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).
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CertificateThumbprint <String>
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.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Credential <PSCredential>
PSCredential representing the Azure Active Directory (AAD) application client ID (username) and application
secret key (password) to authenticate with a service principal account (-ServicePrincipal).
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Environment <PowerBIEnvironmentType>
Cloud environment to connect against. Default is Public.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ServicePrincipal [<SwitchParameter>]
Indicates to use a service principal account, as opposed to a user account.
Required? true
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Tenant <String>
Tenant name or tenant ID containing the service principal account. If not specified, the 'COMMON' tenant is
used.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
Microsoft.PowerBI.Common.Abstractions.Interfaces.IPowerBIProfile
NOTES
-------------------------- Example 1 --------------------------
PS C:\\> Connect-PowerBIServiceAccount
Logs in using user authentication against the Public cloud, a prompt will display to collect credentials.
-------------------------- Example 2 --------------------------
PS C:\\> Connect-PowerBIServiceAccount -Environment China
Logs in using user authentication against the China cloud, a prompt will display to collect credentials.
-------------------------- Example 3 --------------------------
PS C:\\> Connect-PowerBIServiceAccount -ServicePrincipal -Credential (Get-Credential)
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).
-------------------------- Example 4 --------------------------
PS C:\\> Connect-PowerBIServiceAccount -ServicePrincipal -CertificateThumbprint
38DA4BED389A014E69A6E6D8AE56761E85F0DFA4 -ApplicationId b5fde143-722c-4e8d-8113-5b33a9291468
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... owerbiserv
iceaccount?view=powerbi-ps
SYNOPSIS
Log in to the Power BI service.
SYNTAX
Connect-PowerBIServiceAccount -ApplicationId <String> -CertificateThumbprint <String> [-Environment {Public |
Germany | USGov | China | USGovHigh | USGovMil}] -ServicePrincipal [-Tenant <String>] [<CommonParameters>]
Connect-PowerBIServiceAccount -Credential <PSCredential> [-Environment {Public | Germany | USGov | China |
USGovHigh | USGovMil}] -ServicePrincipal [-Tenant <String>] [<CommonParameters>]
Connect-PowerBIServiceAccount -Credential <PSCredential> [-Environment {Public | Germany | USGov | China |
USGovHigh | USGovMil}] [<CommonParameters>]
DESCRIPTION
Log in 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 log out
call Disconnect-PowerBIServiceAccount.
PARAMETERS
-ApplicationId <String>
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).
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CertificateThumbprint <String>
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.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Credential <PSCredential>
PSCredential representing the Azure Active Directory (AAD) application client ID (username) and application
secret key (password) to authenticate with a service principal account (-ServicePrincipal).
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Environment <PowerBIEnvironmentType>
Cloud environment to connect against. Default is Public.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ServicePrincipal [<SwitchParameter>]
Indicates to use a service principal account, as opposed to a user account.
Required? true
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Tenant <String>
Tenant name or tenant ID containing the service principal account. If not specified, the 'COMMON' tenant is
used.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
Microsoft.PowerBI.Common.Abstractions.Interfaces.IPowerBIProfile
NOTES
-------------------------- Example 1 --------------------------
PS C:\\> Connect-PowerBIServiceAccount
Logs in using user authentication against the Public cloud, a prompt will display to collect credentials.
-------------------------- Example 2 --------------------------
PS C:\\> Connect-PowerBIServiceAccount -Environment China
Logs in using user authentication against the China cloud, a prompt will display to collect credentials.
-------------------------- Example 3 --------------------------
PS C:\\> Connect-PowerBIServiceAccount -ServicePrincipal -Credential (Get-Credential)
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).
-------------------------- Example 4 --------------------------
PS C:\\> Connect-PowerBIServiceAccount -ServicePrincipal -CertificateThumbprint
38DA4BED389A014E69A6E6D8AE56761E85F0DFA4 -ApplicationId b5fde143-722c-4e8d-8113-5b33a9291468
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... owerbiserv
iceaccount?view=powerbi-ps