Excel Add-In for Azure Data Catalog

Build 24.0.9060

Establishing a Connection

Configure a Connection Profile

From the CData ribbon, click Get Data and select From Azure Data Catalog connection/s to launch the CData Query window. To setup a new connection, you will have to click the New Azure Data Catalog Connection button. Here you can set the connection settings, test the connection, and save the connection profile.

Connecting to Azure Data Catalog

You can optionally set the following to read the different catalog data returned from Azure Data Catalog.

  • CatalogName: Set this to the catalog name associated with your Azure Data Catalog. If left blank, the default catalogis is used.

    To get your catalog name, navigate to the Azure Portal home page > Data Catalog > Catalog Name

Authenticating to Azure Data Catalog

Azure AD

Azure AD is Microsoft’s multi-tenant, cloud-based directory and identity management service. It is user-based authentication that requires that you set AuthScheme to AzureAD.

Authentication to Azure AD over a Web application always requires the creation of a custom OAuth application. For details, see Creating an Azure AD Application.

Desktop Applications

CData provides an embedded OAuth application that simplifies connection to Azure AD from a Desktop application.

You can also authenticate from a desktop application using a custom OAuth application. (For further information, see Creating an Azure AD Application.) To authenticate via Azure AD, set these parameters:

  • AuthScheme: AzureAD.
  • Custom applications only:

    • OAuthClientId: The client Id assigned when you registered your custom OAuth application.
    • OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.
    • CallbackURL: The redirect URI you defined when you registered your custom OAuth application.

When you connect, the add-in opens Azure Data Catalog's OAuth endpoint in your default browser. Log in and grant permissions to the application.

The add-in completes the OAuth process, obtaining an access token from Azure Data Catalog and using it to request data. The OAuth values are saved in the path specified in OAuthSettingsLocation. These values persist across connections.

When the access token expires, the add-in refreshes it automatically.

Azure Service Principal

Azure Service Principal is role-based application-based authentication. This means that authentication is done per application, rather than per user. All tasks taken on by the application are executed without a default user context, but based on the assigned roles. The application access to the resources is controlled through the assigned roles' permissions.

For information about how to set up Azure Service Principal authentication, see Creating an Azure AD Application with Service Principal.

Managed Service Identity (MSI)

If you are running Azure Data Catalog on an Azure VM and want to leverage MSI to connect, set AuthScheme to AzureMSI.

User-Managed Identities

To obtain a token for a managed identity, use the OAuthClientId property to specify the managed identity's "client_id".

When your VM has multiple user-assigned managed identities, you must also specify OAuthClientId.

Connection Properties

The Connection properties describe the various options that can be used to establish a connection.

Managing Connections

After successfully authenticating to Azure Data Catalog you will be able to customize the data you are importing. To learn more about this, see Managing Connections.

See Also

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060