This bot has been created using Bot Framework, it shows how to create a simple bot that accepts input from the user and echoes it back.
This sample is a Spring Boot app and uses the Azure CLI and azure-webapp Maven plugin to deploy to Azure.
Fill in values as appropriate to your bot.
Left resource group name, app ID, and subscription id out for security reasons.
-
From the root of this project folder:
- Build the sample using
mvn package
- Run it by using
java -jar .\target\echo-bot-1.0.0.jar
- Build the sample using
-
Test the bot using Bot Framework Emulator
Bot Framework Emulator is a desktop application that allows bot developers to test and debug their bots on localhost or running remotely through a tunnel.
-
Install the Bot Framework Emulator version 4.3.0 or greater from here
-
Connect to the bot using Bot Framework Emulator
- Launch Bot Framework Emulator
- File -> Open Bot
- Enter a Bot URL of
http://localhost:3978/api/messages
-
As described on Deploy your bot, you will perform the first 4 steps to setup the Azure app, then deploy the code using the azure-webapp Maven plugin.
From a command (or PowerShell) prompt in the root of the bot folder, execute:
az login
az account set --subscription "<azure-subscription>"
If you aren't sure which subscription to use for deploying the bot, you can view the list of subscriptions for your account by using az account list
command.
az ad app create --display-name "EchoBot" --password "EchoBot123?" --available-to-other-tenants
Replace <botname>
and <appsecret>
with your own values.
<botname>
is the unique name of your bot.
<appsecret>
is a minimum 16 character password for your bot.
Record the appid
from the returned JSON
Replace the values for <appid>
, <appsecret>
, <botname>
, and <groupname>
in the following commands:
az deployment sub create --name "echoBotDeploy" --location "westus" --template-file ".\deploymentTemplates\template-with-new-rg.json" --parameters appId="<appid>" appSecret="<appsecret>" botId="<botname>" botSku=S1 newAppServicePlanName="echoBotPlan" newWebAppName="echoBot" groupLocation="westus" newAppServicePlanLocation="westus"
az deployment group create --resource-group "<groupname>" --template-file ".\deploymentTemplates\template-with-preexisting-rg.json" --parameters appId="<appid>" appSecret="EchoBot123?" botId="EchoBot" newWebAppName="echoBot" newAppServicePlanName="echoBotPlan" appServicePlanLocation="westeurope" --name "echoBot"
In src/main/resources/application.properties update
MicrosoftAppPassword
with the botsecret valueMicrosoftAppId
with the appid from the first step
- Execute
mvn clean package
- Execute
mvn azure-webapp:deploy -Dgroupname="<groupname>" -Dbotname="<botname>"
If the deployment is successful, you will be able to test it via "Test in Web Chat" from the Azure Portal using the "Bot Channel Registration" for the bot.
After the bot is deployed, you only need to execute #6 if you make changes to the bot.