Add Azure Cosmos DB CDC as source in Real-Time hub (preview)

This article describes how to add Azure Cosmos DB for NoSQL Change Data Capture (CDC) as an event source in Fabric Real-Time hub.

The Azure Cosmos DB Change Data Capture (CDC) source connector 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 a stream, you can process this CDC data in real-time and send it to different destinations within Fabric for further processing or analysis.

Note

Real-Time hub is currently in preview.

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.

1. On the Azure portal page for your Azure Cosmos DB account, select Keys under Settings in the left navigation.

2. On the Keys page, copy the URI and Primary key values to use for setting up the eventstream connection.

   

3. On the Azure portal Overview page for your Azure Cosmos DB account, note the Database and item ID you want to collect data for.

   

Get events from an Azure Cosmos DB CDC

You can get events from an Azure Cosmos DB CDC into Real-Time hub in one of the ways:

• Using the Add source experience
• Using the Microsoft sources page

Launch Add source experience

1. Sign in to Microsoft Fabric.

2. Select Real-Time hub on the left navigation bar.

3. On the Real-Time hub page, select + Add source in the top-right corner of the page.

   

Use instructions from the Add Azure Cosmos DB CDC as a source section.

Microsoft sources page

1. In Real-Time hub, select Microsoft sources.

2. In the Source drop-down list, select Azure Cosmos DB (CDC).

3. For Subscription, select an Azure subscription that has the resource group with your Cosmos DB account.

4. For Resource group, select a resource group that has your Cosmos DB account.

5. For Region, select a location where your Cosmos DB is located.

6. Now, move the mouse over the name of the Cosmos DB CDC source that you want to connect to Real-Time hub in the list of databases, and select the Connect button, or select ... (ellipsis), and then select the Connect button.

   

   To configure connection information, use steps from the Add Azure Cosmos DB CDC as a source section. Skip the first step of selecting Azure Cosmos DB CDC as a source type in the Add source wizard.

Add Azure Cosmos DB CDC as a source

1. On the Select a data source screen, select Azure Cosmos DB (CDC).

   

2. Select Go to resource link if you want to navigate to the Azure Cosmos DB account in the Azure portal.

   

3. On the Connect page, select New connection.

   

4. In the Connection settings section, specify the Cosmos DB endpoint. Enter the URI or endpoint for your Cosmos DB account that you copied from the Azure portal.

   

5. Expand Advanced options, and follow these steps:

   1. For Number of retries, specify the maximum number of times the connector should retransmit a request to the Cosmos DB database if the request fails from a recoverable error.

   2. For Enable AVERAGE function pass down, specify whether the connector should pass down of the AVG aggregate function to the Cosmos DB database.

   3. For Enable SORT pass down for multiple columns, specify whether the connector should allow multiple columns to be passed down to Cosmos DB database when specified in the ORDER BY clause of the SQL query.

      

6. Scroll down, and in the Connection credentials section, follow these steps.

   1. Select an existing connection and keep the default Create new connection option.
   2. To create a connection, enter the following values:

      1. For Connection name, enter a name for the connection.

      2. For Authentication kind, select Account key.

      3. For Account key, enter the key value you saved earlier.

      4. Select Connect.

         

7. Now, on the Connect page, do these steps:

   1. Specify the Container ID of the container in your Azure Cosmos DB account.

   2. In the Stream details section to the right, select the Fabric workspace where you want to save the eventstream that the Wizard is going to create.

   3. For eventstream name, enter a name for the eventstream. The wizard creates an eventstream with the selected Azure Cosmos DB CDC as a source.

   4. The Stream name is automatically generated for you by appending -stream to the name of the eventstream. You can see this stream on the Real-time hub All data streams page when the wizard finishes.

   5. Select Next.

      

8. On the Review and create screen, review the summary, and then select Create source.

   

View data stream details

1. On the Review and create page, if you select Open eventstream, the wizard opens the eventstream that it created for you with the selected Azure Cosmos DB CDC as a source. To close the wizard, select Close or X* in the top-right corner of the page.

   

2. In Real-Time hub, select All data streams. To see the new data stream, refresh the All data streams page.

   

   For detailed steps, see View details of data streams in Fabric Real-Time hub.

Related content

To learn about consuming data streams, see the following articles:

• Process data streams
• Analyze data streams
• Set alerts on data streams