Connect a web app to Cosmos DB

In this scenario you will learn how to create an Azure Cosmos DB account and an Azure web app. Then you will link the Cosmos DB to the web app using app settings.

If you don't have an Azure subscription, create a free account before you begin.

Launch Azure Cloud Shell

The Azure Cloud Shell is a free Bash shell that you can run directly within the Azure portal. It has the Azure CLI preinstalled and configured to use with your account. Click the Cloud Shell button on the menu in the upper-right of the Azure portal.

Cloud Shell

The button launches an interactive shell that you can use to run the steps in this topic:

Screenshot showing the Cloud Shell window in the portal

If you choose to install and use the CLI locally, this topic requires that you are running the Azure CLI version 2.0 or later. Run az --version to find the version. If you need to install or upgrade, see Install Azure CLI 2.0.

Sample script


# Variables

# Create a Resource Group 
az group create --name myResourceGroup --location $location

# Create an App Service Plan
az appservice plan create --name WebAppWithCosmosDBPlan --resource-group myResourceGroup --location $location

# Create a Web App
az webapp create --name $appName --plan WebAppWithCosmosDBPlan --resource-group myResourceGroup 

# Create a Cosmos DB
cosmosdb=$(az cosmosdb create --name $appName --resource-group myResourceGroup --query documentEndpoint --output tsv)
cosmosCreds=$(az cosmosdb list-keys --name $appName --resource-group myResourceGroup --query primaryMasterKey --output tsv)

# Assign the connection string to an App Setting in the Web App
az webapp config appsettings set --settings "COSMOSDB_URL=$cosmosdb" "COSMOSDB_KEY=$cosmosCreds" --name $appName --resource-group myResourceGroup

Clean up deployment

After the script sample has been run, the follow command can be used to remove the resource group and all resources associated with it.

az group delete --name myResourceGroup

Script explanation

This script uses the following commands to create a resource group, web app, Cosmos DB and all related resources. Each command in the table links to command specific documentation.

Command Notes
az group create Creates a resource group in which all resources are stored.
az appservice plan create Creates an App Service plan. This is like a server farm for your Azure web app.
az webapp create Creates an Azure web app.
az cosmosdb create Creates a Cosmos DB account. This is where the data will be stored.
az cosmosdb list-keys Lists the access keys for the specified Cosmos DB account.
az webapp config appsettings set Creates or updates an app setting for an Azure web app. App settings are exposed as environment variables for your app.

Next steps

For more information on the Azure CLI, see Azure CLI documentation.

Additional App Service CLI script samples can be found in the Azure App Service documentation.