Microsoft Power BI XMLA connection¶
Introduction¶
A Microsoft Power BI XMLA connection, created using the Microsoft Power BI XMLA connector, establishes access to Microsoft Power BI XMLA. These activities, once configured, interact with Microsoft Power BI XMLA through the connection.
Create or edit a Microsoft Power BI XMLA connection¶
A new Microsoft Power BI XMLA connection is created using the Microsoft Power BI XMLA connector from one of these locations:
- The design component palette's Project endpoints and connectors tab (see Design component palette).
- The Global Connections page (see Create a global endpoint in Global Connections).
An existing Microsoft Power BI XMLA connection can be edited from these locations:
- The design component palette's Project endpoints and connectors tab (see Design component palette).
- The project pane's Components tab (see Component actions menu in Project pane Components tab).
- The Global Connections page (see Edit a global endpoint in Global Connections).
Configure a Microsoft Power BI XMLA connection¶
Each user interface element of the Microsoft Power BI XMLA connection configuration screen is described below.
Tip
Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [
into the field or by clicking the variable icon to display a list of the existing variables to choose from.
-
Connection Name: Enter a name to use to identify the connection. The name must be unique for each Microsoft Power BI XMLA connection and must not contain forward slashes (
/
) or colons (:
). This name is also used to identify the Microsoft Power BI XMLA endpoint, which refers to both a specific connection and its activities. -
Auth Scheme: Select the authorization scheme, one of:
-
AzureAD
-
AzureServicePrincipal
-
Azure Tenant: Enter the Azure tenant.
-
OAuth Client Id: Enter the OAuth client ID.
-
OAuth Client Secret: Enter the OAuth client secret.
-
-
AzureServicePrincipalCert
-
Azure Tenant: Enter the Azure tenant.
-
OAuth Client Id: Enter the OAuth client ID.
-
OAuth JWT Cert: Enter the OAuth JWT certificate.
-
OAuth JWT Cert Type: Select the OAuth JWT certificate type, one of:
-
USER
-
MACHINE
-
PFXFILE
-
PFXBLOB
-
JKSFILE
-
JKSBLOB
-
PEMKEY_FILE
-
PEMKEY_BLOB
-
PUBLIC_KEY_FILE
-
PUBLIC_KEY_BLOB
-
SSHPUBLIC_KEY_FILE
-
SSHPUBLIC_KEY_BLOB
-
P7BFILE
-
PPKFILE
-
XMLFILE
-
XMLBLOB
-
-
OAuth JWT Cert Password: Enter the OAuth JWT certificate password.
-
OAuth JWT Cert Subject: Enter the OAuth JWT certificate subject.
-
-
-
Initiate OAuth: Select the OAuth setting, one of:
-
OFF
- OAuth Access Token: Enter the OAuth access token.
-
GETANDREFRESH
-
REFRESH
- OAuth Access Token: Enter the OAuth access token.
-
-
OAuth Refresh Token: Enter the OAuth refresh token.
-
Use Proxy Settings: Select to use private agent proxy settings.
-
Advanced Configurations: When selected, shows the Advanced Configurations Properties table, which is used to add additional configuration properties as key-value pairs.
Click the add icon to add a row to the table below and enter a key-value pair for each property.
To save the row, click the submit icon in the rightmost column.
To edit or delete a single row, hover over the rightmost column and use the edit icon or delete icon .
To delete all rows, click Clear All.
Important
Fields in the Advanced Configurations table display the variable icon only in edit mode. For these fields' variable values to be populated at runtime, the agent version must be at least 10.75 / 11.13.
-
Test: Click to verify the connection using the specified configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.
-
Save Changes: Click to save and close the connection configuration.
-
Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.
-
Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.
Next steps¶
After a Microsoft Power BI XMLA connector connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).
Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.
These activity types are available: