Skip to content

Configure Azure Cosmos DB Data Sources in NCC Portal

This article describes how to connect and manage Azure Cosmos DB data sources in the NCC Portal, following Microsoft Learn Fabric documentation style.

Prerequisites

Before you start, gather the following details:

  • Host
  • Username or Account Key
  • Password or Account Key

Step 1: Connect Azure Cosmos DB

To connect Azure Cosmos DB to your Fabric tenant:

  1. Visit Connect to Azure Cosmos DB and follow the instructions to create a new connection.
  2. If required, create a private endpoint.
  3. Name your connection using the CON_NCC prefix. This naming convention helps ensure visibility and manageability within the NCC Portal.

Step 2: Add a Data Source

  1. In NCC Portal, navigate to Tenant Settings > Data Sources.
  2. Select Add DataSource.
  3. Complete the following fields:
Field Description Example/Default Value
Name Database name of the Cosmos DB
Data Source Type Type of data source COSMOS
Namespace Prefix for storing data in Lakehouses
Code Identifier for pipelines COSMOS_01
Description Description of the data source
Connection Name of the connection in Fabric - Set in previous step
Environment NCC environment for the data source Development

Step 3: Create a Landing Zone Entity

  1. Go to Landing Zone Entities.
  2. Select New Entity.
  3. Enter the required details:
Field Description Example/Default Value
Pipeline Not used
Data Source Data source for connection - Set in previous step
Source schema Container name in the Cosmos DB
Source name Table name in the Cosmos DB
Incremental Extract data incrementally False
Has encrypted columns Indicate if the table contains sensitive data False
Entity value Optional. Entity values reference
Lake house Lakehouse for storing data LH_Data_Landingzone
File path File path for data storage Is filled automatically
File name File name for data storage Is filled automatically
File type Expected file type Parquet

TIP

  • Click here to see how to apply data encryption to your sensitive data.

Step 4: Create a Bronze Zone Entity

  1. Go to Bronze Zone Entities.
  2. Select New Entity.
  3. Provide the following information:
Field Description Example/Default Value
Pipeline Orchestrator pipeline for parsing PL_BRZ_COMMAND
Landing zone entity Landing zone entity to be parsed - Set in previous step
Entity value Optional. Entity values reference
Column mappings Optional. Column mapping info
Lake house Lakehouse for storing data LH_Bronze_Layer
Schema Schema for storing data dbo
Name Table name for storing data Is filled automatically
Primary keys Unique identifier fields (Case sensitive)

Step 5: Create a Silver Zone Entity

  1. Go to Silver Zone Entities.
  2. Select New Entity.
  3. Enter the following details:
Field Description Example/Default Value
Pipeline Orchestrator pipeline for parsing PL_SLV_COMMAND
Bronze layer entity Bronze layer entity to be parsed - Set in previous step
Entity value Optional. Entity values reference
Lake house Lakehouse for storing data LH_Silver_Layer
Schema Schema for storing data dbo
Name Table name for storing data Is filled automatically
Columns to exclude Comma-separated columns to exclude (Case sensitive)
Columns to exclude from history Comma-separated columns to exclude from comparison (Case sensitive)

Example

The company InSpark has a Cosmos DB connection in Fabric named NCC_COSMOS_DB_SALES. On this Cosmos DB server, named InSpark, there is a container sales and a table total_sales to be extracted. The configuration is as follows:

Data Source

Field Value
Name InSpark
Data Source Type COSMOS
Namespace InSpark_Sales
Code COSMOS_01
Description COSMOS connection to InSpark_Sales
Connection NCC_COSMOS_DB_SALES
Environment Development

Landing Zone Entity

Field Value
Pipeline PL_LDZ_COPY_FROM_COSMOS_01
Data Source InSpark
Source schema sales
Source name total_sales
Incremental False
Entity value
Lake house LH_Data_Landingzone
File path InSpark_Sales
File name total_sales
File type Parquet

Bronze Zone Entity

Field Value
Pipeline PL_BRZ_COMMAND
Landing zone entity InSpark_Sales/total_sales
Entity value
Column mappings
Lake house LH_Bronze_Layer
Schema dbo
Name total_sales
Primary keys id

Silver Zone Entity

Field Value
Pipeline PL_SLV_COMMAND
Bronze layer entity dbo.total_sales
Entity value
Lake house LH_Silver_Layer
Schema dbo
Name total_sales
Columns to exclude
Columns to exclude from history

Next steps