Connect a web app to a redis cache

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

To run this sample, make sure you have installed the latest Azure CLI 2.0. To start, run az login to create a connection with Azure.

This sample works in a Bash shell. For options on running Azure CLI scripts on Windows client, see Running the Azure CLI in Windows.

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 don't have an Azure subscription, create a free account before you begin.

Sample script


# Variables

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

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

# Create a Web App
az webapp create --name $appName --plan WebAppWithRedisPlan --resource-group $resourceGroupName 

# Create a Redis Cache
redis=($(az redis create --name $appName --resource-group $resourceGroupName --location $location --vm-size C0 --sku Basic --query [hostName,sslPort,accessKeys.primaryKey] --output tsv))

# Assign the connection string to an App Setting in the Web App
az webapp config appsettings set --settings "REDIS_URL=${redis[0]}" "REDIS_PORT=${redis[1]}" "REDIS_KEY=${redis[2]}" --name $appName --resource-group $resourceGroupName

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, redis cache 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 redis create Create new Redis Cache instance. This is where the data will be stored.
az redis list-keys Lists the access keys for the redis cache instance.
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.