Microsoft Fabric Lakehouse [Technical Preview]

The Cloudera Octopai Microsoft Fabric Lakehouse connector is used to integrate Microsoft Fabric Lakehouse environments into the Cloudera Octopai platform, enabling centralized metadata management and comprehensive data lineage.

Overview

Before you set up the Microsoft Fabric Lakehouse connector, ensure that you have the following requirements:

  • Microsoft Entra application credentials: a registered service principal with a tenant ID, application (client) ID, and client secret. See Application registration (service principal).
  • Microsoft ODBC Driver 18 for SQL Server: installed on the Windows machine that hosts the Cloudera Octopai client for SQL endpoint connectivity. See SQL access (ODBC).
  • Microsoft Fabric API permissions: application API permissions assigned to the service principal, including Lakehouse.Read.All and related scopes. See Required application permissions.
  • Fabric workspace permissions: the Contributor role assigned to the service principal on the target workspace. See Workspace permissions.
  • OneLake access: required for extracting metadata from Lakehouse files, folders, and file shortcuts through the Microsoft OneLake Distributed File System (DFS) endpoint.
  • Shortcut access: required when the Lakehouse contains shortcuts* to another workspace or to external storage.

Microsoft Fabric Lakehouse metadata extraction uses both the Lakehouse SQL endpoint and OneLake APIs. The SQL endpoint is used for Delta tables, columns, schemas, views, stored procedures, and functions. OneLake access is used for files, folders, and file shortcuts.

Application registration (service principal)

Perform the following steps to register a Microsoft Entra service principal.
  1. In the Azure portal, open Microsoft Entra ID > App registrations, and select New registration.
  2. Provide a name for the application, and select Accounts in this organizational directory only.
  3. Select Register.
  4. From the application overview page, record the Directory (tenant) ID and Application (client) ID.
  5. Create a Client secret under Manage > Certificates and secrets.
The Cloudera Octopai Microsoft Fabric Lakehouse connector authenticates using a Microsoft Entra service principal. The service principal is used for:
  • Microsoft Fabric REST API access
  • SQL endpoint access through ODBC using Microsoft Entra authentication
The following values are required while configuring the connector:
  • Tenant ID
  • Application (client) ID
  • Client Secret Value

SQL access (ODBC)

Microsoft Fabric Lakehouse metadata extraction requires SQL connectivity through the Lakehouse SQL endpoint. Install Microsoft ODBC Driver 18 for SQL Server on the Windows machine that hosts the Cloudera Octopai Client. For Windows, see Download ODBC Driver for SQL Server.

Identity prerequisites

A Microsoft Entra application registration (service principal) is required and is used for:

  • API authentication
  • SQL connectivity through the Lakehouse SQL endpoint
  • Access to Fabric workspace items through Microsoft Fabric APIs
  • Access to Lakehouse files and folders through OneLake APIs

Tenant settings (Fabric admin portal)

Use the Fabric admin portal to enable the settings required by the connector:

  1. Open Microsoft Fabric.
  2. Select Settings, and then select Admin portal.
  3. Open Tenant settings.
  4. Find and enable the Service principals can call Fabric public APIs option.
  5. Find and enable the Allow apps to access Fabric items option.
  6. Find and enable the Users can access data stored in OneLake with apps external to Fabric option.

Workspace permissions

Assign the service principal to the target workspace with the Contributor role. Contributor access is required for complete metadata extraction coverage, including:

  • Stored procedures
  • Views
  • Functions
  • Tables
  • Columns
  • Schemas

The Viewer role is not sufficient for full metadata extraction because it may not expose stored procedures, views, and functions.

Required application permissions

The application requires the following Microsoft Fabric API permissions:

  • Lakehouse.Read.All
  • Workspace.Read.All
  • SQLEndpoint.Read.All
  • Item.Read.All

Network requirements

The extraction environment must allow outbound network access from the Windows machine that hosts the Cloudera Octopai platform to the following endpoints:

api.fabric.microsoft.com
*.fabric.microsoft.com
*.datawarehouse.fabric.microsoft.com
onelake.dfs.fabric.microsoft.com
login.microsoftonline.com

Setting up Lakehouse (Microsoft Fabric) metadata source

Metadata sources are set on the Cloudera Octopai Client.

  1. From the Cloudera Octopai Client, click the Lakehouse (Microsoft Fabric) connector.

    New Metadata source page to choose the Microsoft Fabric Lakehouse connector
  2. In the New Metadata Source wizard, select the Service Principal authentication method and enter the following details:
    • Connection Name: Enter a meaningful name. The name is displayed to Cloudera Octopai platform users.
    • Application (client) ID
    • Tenant ID
    • Client Secret Value
    • Workspace ID
    • Parse, Analyze, and Tag the Views and Stored Procedures as ETLs: (optional) Select this option when you want Cloudera Octopai to treat views and stored procedures as ETL objects during analysis.

    Metadata source wizard configuration for the Microsoft Fabric Lakehouse connector
* The Microsoft Fabric Lakehouse connector supports data lineage for OneLake shortcuts.