Edit

Share via


Set up your Azure Cosmos DB for NoSQL connection

This article outlines the steps to create an Azure Cosmos DB for NoSQL connection in Microsoft Fabric pipelines.

Supported authentication types

The Azure Cosmos DB for NoSQL connector supports the following authentication types:

Authentication type Copy Dataflow Gen2
Account key n/a

Set up your connection for Dataflow Gen2

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

Set up your connection for a pipeline

To create a connection for a Microsoft Fabric pipeline:

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

    Screenshot showing how to open the manage connections and gateways menu.

  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 where you can set up your connection.

    Screenshot showing the New connection pane.

Set up connection

A summary of the connector properties supported in a pipeline is provided in the following table:

Name Description Required Property Copy
Connection name A name for your connection. Yes
Connection type Select Azure CosmosDB (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

For specific steps to set up your connection, follow these instructions:

  1. 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 (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.

    Screenshot showing how to set new connection.

  2. 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.

  3. In the General tab, select the privacy level that you want apply in the Privacy level drop-down list. Allowed values are Organizational, Privacy, and Public. For more information, see privacy levels in the Power Query documentation.

  4. Select Create. Your creation is successfully tested if all the credentials are correct. If not correct, the creation fails with errors.

    Screenshot showing the connection page.

Account 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.

Select Create. Your creation is successfully tested if all the credentials are correct. If not correct, the creation fails with errors.

Screenshot showing the connection page.