Add Azure Cosmos DB CDC source to an eventstream (preview)

Article
06/18/2024

This article shows you how to add an Azure Cosmos DB (Azure Cosmos DB for NoSQL) Change Data Capture source to an eventstream.

The Azure Cosmos DB Change Data Capture (CDC) source connector for Microsoft Fabric event streams lets you capture a snapshot of the current data in an Azure Cosmos DB database. The connector then monitors and records any future row-level changes to this data. Once the changes are captured in the eventstream, you can process this CDC data in real-time and send it to different destinations within Fabric for further processing or analysis.

Important

Enhanced capabilities of Fabric event streams are currently in preview.

Note

This source is not supported in the following regions of your workspace capacity: West US3, Switzerland West.

Prerequisites

Access to the Fabric premium workspace with Contributor or higher permissions.
Access to an Azure Cosmos DB for NoSQL account and database.
Your Azure Cosmos DB for NoSQL database must be publicly accessible and not be behind a firewall or secured in a virtual network.

Get connection details from the Azure portal

The labels for the items you need to collect from the Azure portal are shown in the following steps. You always need the endpoint URI, in a format like https://<account>.<api>.azure.com:<port>/, the Primary Key, and the Database name and item IDs you want to collect data for.

Note

Azure Cosmos DB for NoSQL CDC is using the Latest Version Mode of Azure Cosmos DB Change Feed. It captures the changes to records in the latest version. Note that Deletions are't captured with this mode.

On the Azure portal page for your Azure Cosmos DB account, select Keys under Settings in the left navigation.
On the Keys page, copy the URI and Primary key values to use for setting up the eventstream connection.
On the Azure portal Overview page for your Azure Cosmos DB account, note the Database and item ID you want to collect data for.

Note

The maximum number of sources and destinations for one eventstream is 11.

Add Azure Cosmos DB (CDC) as a source

In Fabric Real-Time Intelligence, select Eventstream to create a new eventstream. Make sure the Enhanced Capabilities (preview) option is enabled.
On the next screen, select Add external source.

Configure and connect to Azure Cosmos DB (CDC)

On the Select a data source screen, select Azure Cosmos DB (CDC).
On the Connect screen, under Connection, select New connection to create a cloud connection linking to your Azure Cosmos DB database.
On the Connection settings screen, enter the following information:
- Cosmos DB Endpoint: Enter the URI or Endpoint for your Cosmos DB account that you copied from the Azure portal.
- Connection name: Automatically generated, or you can enter a new name for this connection.
- Account key: Enter the Primary Key for your Azure Cosmos DB account that you copied from the Azure portal.
Select Connect.
Provide the following information for your Azure Cosmos DB resources:
- Container ID: Enter the name of the Azure Cosmos DB container or table you want to connect to.
- Database: Enter the name of your Azure Cosmos DB database.
- Offset policy: Select whether to start reading Earliest or Latest offsets if there's no commit.
Select Next.
Review the summary, and then select Add.