Cosmos DB Setup Guide link
Updated November 16, 2023
Follow our setup guide to connect CosmosDB to Fivetran.
To connect your Cosmos DB to Fivetran, you need:
- A Cosmos resource configured with the native NoSQL API
- Your Cosmos instance's URI (e.g.,
- Your Cosmos instance's READ-ONLY key (primary or secondary)
Choose connection methodlink
Fivetran connects directly to your Cosmos DB resource.
Connect using Private Linklink
IMPORTANT: You must have a Business Critical plan to use Azure Private Link.
Azure Private Link allows Virtual Networks (VNets) and Azure-hosted or on-premises services to communicate with one another without exposing traffic to the public internet. Learn more in Microsoft's Azure Private Link documentation.
Follow our Azure Private Link setup guide to configure Private Link for your Cosmos resource.
Enable resource accesslink
In the Microsoft Azure Portal, navigate into the Cosmos DB resource you want to replicate.
Go to the
In the Public network access section, either pick All networks (not recommended) or Selected Networks to safelist Fivetran's IP addresses in your firewall. For more details, follow Microsoft's instructions on how to configure the IP policy.
TIP: For security reasons, we do not recommend the All networks option.
Find credentials (account key only)link
Navigate into the Cosmos DB resource you want to replicate and go to the Keys tab.
Copy the URI and read-only key (either primary or secondary). You will need them to configure Fivetran.
Finish Fivetran configurationlink
In your connector setup form, enter a destination schema prefix. This prefix applies to each replicated schema and cannot be changed once your connector is created.
Select your data access method.
Depending on your data access method, enter the following:
Select your pack mode.
Click Save & Test. Fivetran tests and validates our connection to your Cosmos DB resource instance. Upon successful completion of the setup tests, you can sync your data using Fivetran.
Fivetran performs the following tests to ensure that we can connect to your Cosmos DB primary instance and that it is properly configured:
- Validating that the Cosmos DB resource credentials you provided in the setup form are complete and properly formatted.
- Validating that Fivetran is able to make a simple query on one of the containers in the resource.
NOTE: The tests may take a few minutes to finish running.