Tutorial: Implement Azure Databricks with a Cosmos DB endpoint

This tutorial describes how to implement a VNet injected Databricks environment with a Service Endpoint enabled for Cosmos DB.

In this tutorial you learn how to:

  • Create an Azure Databricks workspace in a virtual network
  • Create a Cosmos DB service endpoint
  • Create a Cosmos DB account and import data
  • Create an Azure Databricks cluster
  • Query Cosmos DB from an Azure Databricks notebook


Before you start, do the following:

Create a Cosmos DB service endpoint

  1. Once you have deployed an Azure Databricks workspace to a virtual network, navigate to the virtual network in the Azure portal. Notice the public and private subnets that were created through the Databricks deployment.

    Virtual network subnets

  2. Select the public-subnet and create a Cosmos DB service endpoint. Then Save.

    Add a Cosmos DB service endpoint

Create a Cosmos DB account

  1. Open the Azure portal. On the upper-left side of the screen, select Create a resource > Databases > Azure Cosmos DB.

  2. Fill out the Instance Details on the Basics tab with the following settings:

    Setting Value
    Subscription your subscription
    Resource Group your resource group
    Account Name db-vnet-service-endpoint
    API Core (SQL)
    Location West US
    Geo-Redundancy Disable
    Multi-region Writes Enable

    Add a Cosmos DB service endpoint

  3. Select the Network tab and configure your virtual network.

    a. Choose the virtual network you created as a prerequisite, and then select public-subnet. Notice that private-subnet has the note 'Microsoft AzureCosmosDB' endpoint is missing'. This is because you only enabled the Cosmos DB service endpoint on the public-subnet.

    b. Ensure you have Allow access from Azure portal enabled. This setting allows you to access your Cosmos DB account from the Azure portal. If this option is set to Deny, you will receive errors when attempting to access your account.


    It is not necessary for this tutorial, but you can also enable Allow access from my IP if you want the ability to access your Cosmos DB account from your local machine. For example, if you are connecting to your account using the Cosmos DB SDK, you need to enable this setting. If it is disabled, you will receive "Access Denied" errors.

    Cosmos DB Account network settings

  4. Select Review + Create, and then Create to create your Cosmos DB account inside the virtual network.

  5. Once your Cosmos DB account has been created, navigate to Keys under Settings. Copy the primary connection string and save it in a text editor for later use.

    Cosmos DB account keys page

  6. Select Data Explorer and New Container to add a new database and container to your Cosmos DB account.

    Cosmos DB new collection

Upload data to Cosmos DB

  1. Open the graphical interface version of the data migration tool for Cosmos DB, Dtui.exe.

    Cosmos DB Data Migration Tool

  2. On the Source Information tab, select CSV File(s) in the Import from dropdown. Then select Add Files and add the storm data CSV you downloaded as a prerequisite.

    Cosmos DB Data Migration Tool source information

  3. On the Target Information tab, input your connection string. The connection string format is AccountEndpoint=<URL>;AccountKey=<key>;Database=<database>. The AccountEndpoint and AccountKey are included in the primary connection string you saved in the previous section. Append Database=<your database name> to the end of the connection string, and select Verify. Then, add the Container name and partition key.

    Cosmos DB Data Migration Tool target information

  4. Select Next until you get to the Summary page. Then, select Import.

Create a cluster and add library

  1. Navigate to your Azure Databricks service in the Azure portal and select Launch Workspace.

  2. Create a new cluster. Choose a Cluster Name and accept the remaining default settings.

    New cluster settings

  3. After your cluster is created, navigate to the cluster page and select the Libraries tab. Select Install New and upload the Spark connector jar file to install the library.

    Install Spark connector library

    You can verify that the library was installed on the Libraries tab.

    Databricks cluster Libraries tab

Query Cosmos DB from a Databricks notebook

  1. Navigate to your Azure Databricks workspace and create a new python notebook.

    Create new Databricks notebook

  2. Run the following python code to set the Cosmos DB connection configuration. Change the Endpoint, Masterkey, Database, and Container accordingly.

    connectionConfig = {
      "Endpoint" : "https://<your Cosmos DB account name.documents.azure.com:443/",
      "Masterkey" : "<your Cosmos DB primary key>",
      "Database" : "<your database name>",
      "preferredRegions" : "West US 2",
       "Collection": "<your collection name>",
      "schema_samplesize" : "1000",
      "query_pagesize" : "200000",
      "query_custom" : "SELECT * FROM c"
  3. Use the following python code to load the data and create a temporary view.

    users = spark.read.format("com.microsoft.azure.cosmosdb.spark").options(**connectionConfig).load()
  4. Use the following magic command to execute a SQL statement that returns data.

    select * from storm

    You have successfully connected your VNet-injected Databricks workspace to a service-endpoint enabled Cosmos DB resource. To read more about how to connect to Cosmos DB, see Azure Cosmos DB Connector for Apache Spark.

Clean up resources

When no longer needed, delete the resource group, the Azure Databricks workspace, and all related resources. Deleting the job avoids unnecessary billing. If you're planning to use the Azure Databricks workspace in future, you can stop the cluster and restart it later. If you are not going to continue to use this Azure Databricks workspace, delete all resources you created in this tutorial by using the following steps:

  1. From the left-hand menu in the Azure portal, click Resource groups and then click the name of the resource group you created.

  2. On your resource group page, select Delete, type the name of the resource to delete in the text box, and then select Delete again.

Next steps

In this tutorial, you've deployed an Azure Databricks workspace to a virtual network, and used the Cosmos DB Spark connector to query Cosmos DB data from Databricks. To learn more about working with Azure Databricks in a virtual network, continue to the tutorial for using SQL Server with Azure Databricks.