Create your first Azure AI Health Bot using Azure CLI

This Quickstart guide walks you through creating your first Azure AI Health Bot by using Azure CLI.

At the end of this guide you'll be able to access a white-labeled bot instance that can be embedded within your app or website. You can customize the built-in functionality and extend to introduce your own business flows through simple and intuitive visual editing tools

Important

An Azure account is required to complete these steps. If you don't have an Azure subscription, create a free account before you begin.

1. Once you have an Azure account, sign-in to Azure.

   • Use Azure Cloud Shell using the bash environment.

     Launch Cloud Shell in a new window

   • If you prefer, install the Azure CLI to run CLI reference commands.

     • If you're using a local install, sign in with Azure CLI by using the az sign-in command. To finish the authentication process, follow the steps displayed in your terminal. See Sign in with Azure CLI for other sign-in options.

     • When you're prompted, install Azure CLI extensions on first use. For more information about extensions, see Use extensions with Azure CLI.

     • Run az version to find the version and dependent libraries that are installed. To upgrade to the latest version, run az upgrade.

2. Create an Azure resource group by using the az group create command:

   
   az group create --name myResourceGroup --location eastus 
   
   

   A resource group is a logical container in which Azure resources are deployed and managed as a group. For more information about managing resource groups in Azure CLI, see Working with resource groups in Azure CLI.

3. Create an Azure AI Health Bot by using the az healthbot create command:

   
   az healthbot create --resource-group myResourceGroup --bot-name myhealthbot --location eastus --sku F0  
   
   

   • resource-group: Create a new group or use an existing group to organize your Azure AI Health Bot instances.

   • bot-name: Name for the bot that appears in the conversations. The name can only use lowercase letters and hyphens (-). The name must start with a letter and can't end with a hyphen (-) and must be between 2 and 30 characters in length.

   • location: Determine the location of the deployment data center for your instance. It's best to choose a location closest to your customer. The location can't be changed once the bot is created.

   • sku: Choose between the free and standard paid plans.

4. To get a list of your bots and information about them, use the az healthbot list command:

   
   az healthbot list --resource-group myResourceGroup --output table 
   
   

   Tip

   The --output parameter is a global parameter, available for all commands. The table value presents output in a friendly format. For more information, see Output formats for Azure CLI commands.

   For details about your Azure AI Health Bot, use the az healthbot show command:

   
   az healthbot show --resource-group myResourceGroup --bot-name myhealthbot 
   
   

5. When you're done, you can clean up all resources you created by deleting the resource group with the az group delete command:

   
   az group delete --name myResourceGroup 
   
   

   This command removes the resource group and everything that it contains. If you prefer, you can remove only the Azure Ai Health Bot by using the az healthbot delete command:

   
   az healthbot delete --resource-group myResourceGroup --bot-name myhealthbot