Azure Cosmos DB for MongoDB vCore Quickstart - MongoDB driver for Python

This Quickstart is a Express API application that illustrates basic usage of the MongoDB driver for Python with Azure Cosmos DB for MongoDB vCore. Azure Cosmos DB for MongoDB vCore is built on DocumentDB providing a powerful and flexible solution for NoSQL database needs.

Pre-requisites

• Docker
• Azure Developer CLI
• Python 3.12

Deploy this solution

This solution is designed to be deployed to Azure with only a few commands. This template will deploy the following Azure service components:

architecture-beta
    service client(internet)[User]

    group azure(cloud)[Azure]

    service registry(server)[Container registry] in azure
    service identity(disk)[Managed identity] in azure
    service data(database)[Azure Cosmos DB for MongoDB vCore] in azure

    group host(server)[Azure Container Apps] in azure

    service web(server)[Web] in host
    service api(server)[API] in host

    junction container

    client:B -- L:web
    web:B -- T:container
    api:T -- B:container
    container:R -- L:registry
    api:R -- L:identity
    identity:R -- L:data

Loading

1. Log in to Azure Developer CLI. This is only required once per-install.

   azd auth login

2. Initialize this template (cosmos-db-mongodb-vcore-python-quickstart) using azd init.

   azd init --template cosmos-db-mongodb-vcore-python-quickstart

3. Ensure that Docker is running in your environment.

4. Use azd up to provision your Azure infrastructure and deploy the web application to Azure.

   azd up

5. Observed the sample dashboard web application that targets your deployed REST API.

   

(Optional) Run the solution locally

1. If you haven't deployed the solution already, provision the Azure infrastructure to deploy the Azure Cosmos DB for MongoDB vCore cluster with Microsoft Entra ID authentication enabled.

   azd provision

2. Navigate to the src/api folder.

   cd ./src/api/

3. Check that your environments secrets are loaded correctly in the *.env file. The list should include:

   	Description
   SETTINGS__ENDPOINT	The endpoint to the Azure Cosmos DB for MongoDB vCore cluster

   SETTINGS__ENDPOINT = <azure-cosmos-db-mongodb-vcore-cluster-name>.global.mongocluster.cosmos.azure.com
   

4. Run the application.

   flask run

5. Test the local REST API with a few basic HTTP requests:

   • Perform a health check (ping):

     GET http://localhost:5000/status
     Accept: application/json

   • Upsert a document into the collection:

     POST http://localhost:5000
     Content-Type: application/json
     
     {
       "id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
       "category": "gear-surf-surfboards",
       "name": "Yamba Surfboard",
       "quantity": 12,
       "price": 850.00,
       "clearance": false
     }

     POST http://localhost:5000
     Content-Type: application/json
     
     {
       "id": "bbbbbbbb-1111-2222-3333-cccccccccccc",
       "category": "gear-surf-surfboards",
       "name": "Kiama Classic Surfboard",
       "quantity": 25,
       "price": 790.00,
       "clearance": false
     }

     POST http://localhost:5000
     Content-Type: application/json
     
     {
       "id": "cccccccc-2222-3333-4444-dddddddddddd",
       "category": "gear-paddle-kayaks",
       "name": "Lastovichka Paddle Kayak",
       "quantity": 10,
       "price": 599.99,
       "clearance": true
     }

   • Get a specific document from the collection:

     GET http://localhost:5000/bbbbbbbb-1111-2222-3333-cccccccccccc
     Accept: application/json

   • Get all documents in the collection:

     GET http://localhost:5000
     Accept: application/json

   • Get documents in the collection filtered by category:

     GET http://localhost:5000/category/gear-surf-surfboards
     Accept: application/json

     GET http://localhost:5000/category/gear-paddle-kayaks
     Accept: application/json

   • Delete a document from the collection:

     DELETE http://localhost:5000/cccccccc-2222-3333-4444-dddddddddddd