Set up your Azure Cosmos DB for NoSQL connection

This article outlines the steps to create an Azure Cosmos DB for NoSQL connection.

Supported authentication types

The Azure Cosmos DB for NoSQL connector supports the following authentication types for copy and Dataflow Gen2 respectively.

Authentication type Copy Dataflow Gen2
Account key n/a

Set up your connection in Dataflow Gen2

The Azure Cosmos DB for NoSQL connector isn't currently supported in Dataflow Gen2.

Set up your connection in a data pipeline

To create a connection in a data pipeline:

  1. From the page header in the Microsoft Fabric service, select Settings Settings gear icon > Manage connections and gateways.

    Screenshot showing how to open manage gateway.

  2. Select New at the top of the ribbon to add a new data source.

    Screenshot showing the new page.

    The New connection pane opens on the left side of the page.

    Screenshot showing the New connection pane.

Setup connection

Step 1: Specify the new connection name, type, account endpoint and database

Screenshot showing how to set new connection

In the New connection pane, choose Cloud, and specify the following field:

  • Connection name: Specify a name for your connection.
  • Connection type: Select Azure CosmosDB (Data pipeline) for your connection type.
  • Account Endpoint: Enter your account endpoint URL of your Azure Cosmos DB for NoSQL.
  • Database: Enter the database ID of your Azure Cosmos DB for NoSQL.

Step 2: Select and set your authentication

Under Authentication method, select your authentication method from the drop-down list and complete the related configuration. The Azure Cosmos DB for NoSQL connector supports the following authentication types:

Screenshot showing that authentication method of Azure Cosmos DB for NoSQL.

Key authentication

Account key: Specify the account key of your Azure Cosmos DB for NoSQL connection. Go to your Azure Cosmos DB for NoSQL account interface, browse to the Keys section, and get your account key.

Screenshot showing that key authentication method of Azure Cosmos DB for NoSQL.

Step 3: Specify the privacy level that you want to apply

In the General tab, select the privacy level that you want apply in the Privacy level drop-down list. Three privacy levels are supported. For more information, see privacy levels.

Step 4: Create your connection

Select Create. Your creation will be successfully tested and saved if all the credentials are correct. If not correct, the creation will fail with errors.

Screenshot showing the connection page.

Table summary

The connector properties in the following table are supported in pipeline copy:

Name Description Required Property Copy
Connection name A name for your connection. Yes
Connection type Select Azure CosmosDB (Data pipeline) for your connection type. Yes
Account Endpoint Enter your Azure Cosmos DB for NoSQL account endpoint URL. Yes
Database Enter the Azure Cosmos DB for NoSQL database ID. Yes
Authentication Go to Authentication. Yes Go to Authentication. Go to Authentication.
Privacy Level The privacy level that you want to apply. Allowed values are Organizational, Privacy, and Public. Yes

Authentication

The properties in the following table are the supported authentication types.

Name Description Required Property Copy
Key
- Account key The Azure Cosmos DB for NoSQL account key. Yes