Connect-PowerBIServiceAccount

Module:

MicrosoftPowerBIMgmt.Profile

Log in to the Power BI service.

Syntax

Connect-PowerBIServiceAccount
       [-Environment <PowerBIEnvironmentType>]
       [-CustomEnvironment <String>]
       [-DiscoveryUrl <String>]
       [<CommonParameters>]

Connect-PowerBIServiceAccount
       [-Environment <PowerBIEnvironmentType>]
       [-CustomEnvironment <String>]
       -Credential <PSCredential>
       [-ServicePrincipal]
       [-Tenant <String>]
       [-DiscoveryUrl <String>]
       [<CommonParameters>]

Connect-PowerBIServiceAccount
       [-Environment <PowerBIEnvironmentType>]
       [-CustomEnvironment <String>]
       -Credential <PSCredential>
       [-DiscoveryUrl <String>]
       [<CommonParameters>]

Connect-PowerBIServiceAccount
       [-Environment <PowerBIEnvironmentType>]
       [-CustomEnvironment <String>]
       -CertificateThumbprint <String>
       -ApplicationId <String>
       [-ServicePrincipal]
       [-Tenant <String>]
       [-DiscoveryUrl <String>]
       [<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.

Examples

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 -Tenant [TenantId] -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.

Parameters

-ApplicationId

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

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-CertificateThumbprint

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.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Credential

PSCredential representing the Azure Active Directory (AAD) application client ID (username) and application secret key (password) to authenticate with a service principal account (-ServicePrincipal).

Type:	PSCredential
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-CustomEnvironment

The custom environment to use for the environments returned from the discovery url.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DiscoveryUrl

The discovery url to get the backend services info from. Custom environment must also be supplied.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Environment

Cloud environment to connect against. Default is Public.

Type:	PowerBIEnvironmentType
Accepted values:	Public, Germany, USGov, China, USGovHigh, USGovMil
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ServicePrincipal

Indicates to use a service principal account, as opposed to a user account.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Tenant

Tenant name or tenant ID containing the service principal account. If not specified, the 'COMMON' tenant is used.

Type:	String
Aliases:	TenantId
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

None

Outputs

Microsoft.PowerBI.Common.Abstractions.Interfaces.IPowerBIProfile

Notes

RELATED LINKS