Get started with Java and Azure Cosmos DB

Get started with Java and Azure Cosmos DB

In this guide, you work with a Spring Boot application that uses Azure Cosmos DB for its data store and Azure Cosmos DB for NoSQL. This application takes a prescribed approach to development using Java 11, Spring Data, and reactive development. This project was created using Spring Initializr.


  • An Azure subscription or free Azure Cosmos DB trial account:
  • Azure CLI:
    • You can use Azure CLI with Windows, macOS, Linux, Docker, and Azure Cloud Shell.

    • If you run Azure CLI commands in the Azure Cloud Shell, use the Bash environment.

    • If you prefer to run Azure CLI commands locally, install the Azure CLI. After you install it, sign in to the Azure CLI by using the az login command. For other sign-in options, see Sign in with the Azure CLI.

    • When you use Azure Spring Apps with Azure CLI for the first time, you’re prompted to install the spring Azure CLI extension.

    • Certain Azure Cosmos DB commands might prompt you to install the cosmosdb-preview Azure CLI extension.

  • Java:
    • Use Java 11 or higher.
    • Use a Java development environment, such as Visual Studio Code, IntelliJ, NetBeans, or Eclipse.
  • Use the following Maven plugins to assist with Azure deployments:
  • For the Spring packages to work with Azure Cosmos DB and Azure CLI, you must use a version of Spring Boot >= 2.2.11.RELEASE and < 2.7.0-M1.

  • If you use Visual Studio Code, consider installing the Spring initializr extension for Spring Boot support. Install the Lombok extension if you want to automatically generate getters and setters.

Create a resource group

To store Azure resources for this demo, you need an Azure resource group:

  1. Before you create your resource group, determine the location to use. If you’re not sure which locations are available, run the following Azure CLI command and use the value from the Name column of the table:

    az account list-locations -o table
  2. Use the following command to create a resource group:

    az group create --location eastus --resource-group

Create an Azure Cosmos DB account and database

To configure your Azure Cosmos DB account to work with the demo, do the following tasks:

  1. Create an Azure Cosmos DB account.

  2. Create an Azure Cosmos DB for NoSQL database.

  3. Create the pet-supplies container.

Create an Azure Cosmos DB account

To create an Azure Cosmos DB account, run the following command:

az cosmosdb create -n pet-supplies-demo -g pet-supplies-demo-rg --enable-free-tier true --default-consistency-level Session

After you run this command, it may take a few minutes to create your Azure Cosmos DB account.

Create a database with Azure Cosmos DB for NoSQL

To create the pet-supplies database with Azure Cosmos DB for NoSQL, run the following command:

az cosmosdb sql database create -g pet-supplies-demo-rg --account-name
pet-supplies-demo -n pet-supplies

Create a container with Azure Cosmos DB for NoSQL

Before you create a container for your Azure Cosmos DB database, you need to be sure of your data model and establish a partition key. A partition key is an immutable property on a document that is used to group documents logically.

After a partition key is set for a container, it can’t change. The partition key is a design-time decision.

Keep the following information in mind when you choose your partition keys:

  • Partition keys should have a wide range of values.

  • Partition keys should have an even spread of data across their values.

  • Avoid cross-partition queries because they’re expensive.

After you’ve created a partition key, you can create the container. In this example, use \/documentType for your partition key.

To create the pet-supplies container for the pet-supplies database, run the following command:

az cosmosdb sql container create -g pet-supplies-demo-rg --account-name
pet-supplies-demo --database-name pet-supplies --name pet-supplies
--partition-key-path "/documentType"

Clone the repository and set environment variables

There are a few more things you need to set up before you can run your code:

  1. Clone the repository.

  2. Set the environment variables.

  3. Create an instance of Azure Cosmos DB for NoSQL.

Clone the repository

Clone the repository that contains the sample code, which is available in the Cloud-Scale Data for Spring Developers repository. The repository contains a folder named demos, with the following contents:

  • hello-world-keyvault: An introduction to Java and Azure Key Vault, which is used to store your application secrets securely.

  • cosmos-db: The main sample referred to throughout the rest of the guide.

Set the environment variables

After you create your Azure Cosmos DB for NoSQL instance, create environment variables by using the URI and the key. is configured to look for the following environment variables:



Get the value for AZURE_COSMOS_URI

Use the following command to store the URI in the environment variable named AZURE_COSMOS_URI:

AZURE_COSMOS_URI=$(az cosmosdb show --name pet-supplies-demo -g
pet-supplies-demo-rg --query "readLocations[0].documentEndpoint" -o

Get the value for AZURE_COSMOS_KEY

Use the following command to store the read and write key in the environment variable named AZURE_COSMOS_KEY:

AZURE_COSMOS_KEY=$(az cosmosdb keys list --name pet-supplies-demo -g
pet-supplies-demo-rg --query "primaryMasterKey" -o tsv)

Run the code

To run the code, follow these steps:

  1. Install your dependencies:
mvn install
  1. Run the following code locally, and then access the API at http://localhost:8080:
mvn spring-boot:run

Learn more

Next | Deploy to Azure App Service