Create a SignalR Service with an App Service
This sample script creates a new Azure SignalR Service resource, which is used to push real-time content updates to clients. This script also adds a new Web App and App Service plan to host your ASP.NET Core Web App that uses the SignalR Service. The web app is configured with an App Setting named AzureSignalRConnectionString to connect to the new SignalR service resource.
If you prefer to run CLI reference commands locally, install the Azure CLI. If you're running on Windows or macOS, consider running Azure CLI in a Docker container. For more information, see How to run the Azure CLI in a Docker container.
If you're using a local installation, sign in to the Azure CLI by using the az login command. To finish the authentication process, follow the steps displayed in your terminal. For other sign-in options, see Sign in with the Azure CLI.
When you're prompted, install the Azure CLI extension on first use. For more information about extensions, see Use extensions with the Azure CLI.
Launch Azure Cloud Shell
The Azure Cloud Shell is a free interactive shell that you can use to run the steps in this article. It has common Azure tools preinstalled and configured to use with your account.
To open the Cloud Shell, just select Try it from the upper right corner of a code block. You can also launch Cloud Shell in a separate browser tab by going to https://shell.azure.com.
When Cloud Shell opens, verify that Bash is selected for your environment. Subsequent sessions will use Azure CLI in a Bash environment, Select Copy to copy the blocks of code, paste it into the Cloud Shell, and press Enter to run it.
Sign in to Azure
Cloud Shell is automatically authenticated under the initial account signed-in with. Use the following script to sign in using a different subscription, replacing
<Subscription ID> with your Azure Subscription ID. If you don't have an Azure subscription, create an Azure free account before you begin.
subscription="<subscriptionId>" # add subscription here az account set -s $subscription # ...or use 'az login'
Run the script
# Create a SignalR Service with an App Service # Variable block let "randomIdentifier=$RANDOM*$RANDOM" location="East US" resourceGroup="msdocs-azure-signalr-rg-$randomIdentifier" tag="create-signal-service-with-app-service" signalRSvc="msdocs-signalr-svc-$randomIdentifier" webApp="msdocs-web-app-signalr-$randomIdentifier" appSvcPlan="msdocs-app-svc-plan-$randomIdentifier" signalRSku="Standard_S1" unitCount="1" serviceMode="Default" planSku="Free" # Create a resource group echo "Creating $resourceGroup in "$location"..." az group create --name $resourceGroup --location "$location" --tag $tag # Create the Azure SignalR Service resource echo "Creating $signalRSvc" az signalr create \ --name $signalRSvc \ --resource-group $resourceGroup \ --sku $signalRSku \ --unit-count $unitCount \ --service-mode $serviceMode # Create an App Service plan. echo "Creating $appSvcPlan" az appservice plan create --name $appSvcPlan --resource-group $resourceGroup --sku $planSku # Create the Web App echo "Creating $webApp" az webapp create --name $webApp --resource-group $resourceGroup --plan $appSvcPlan # Get the SignalR primary connection string primaryConnectionString=$(az signalr key list --name $signalRSvc \ --resource-group $resourceGroup --query primaryConnectionString -o tsv) echo $primaryConnectionString # Add an app setting to the web app for the SignalR connection az webapp config appsettings set --name $webApp --resource-group $resourceGroup \ --settings "AzureSignalRConnectionString=$primaryConnectionString"
Clean up resources
Use the following command to remove the resource group and all resources associated with it using the az group delete command - unless you have an ongoing need for these resources. Some of these resources may take a while to create, as well as to delete.
az group delete --name $resourceGroup
Each command in the table links to command specific documentation. This script uses the following commands:
|az group create||Creates a resource group in which all resources are stored.|
|az signalr create||Creates an Azure SignalR Service resource.|
|az signalr key list||List the keys, which will be used by your application when pushing real-time content updates with SignalR.|
|az appservice plan create||Creates an Azure App Service Plan for hosting web apps.|
|az webapp create||Creates an Azure Web app using the App Service hosting plan.|
|az webapp config appsettings set||Adds a new app setting for the web app. This app setting is used to store the SignalR connection string.|
For more information on the Azure CLI, see Azure CLI documentation.
Additional Azure SignalR Service CLI script samples can be found in the Azure SignalR Service documentation.
Submit and view feedback for