Quickstart: Create an Azure AI Health Bot instance using Azure PowerShell

Article
10/12/2023

This article walks you through creating your first Azure AI Health Bot using Azure PowerShell.

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.

Prerequisites

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

Prepare your environment

If you choose to use Azure PowerShell locally:
- Install the Az PowerShell module.
- Connect to your Azure account using the Connect-AzAccount cmdlet.
If you choose to use Azure Cloud Shell:
- See Overview of Azure Cloud Shell for more information.
Important

While the Az.HealthBot PowerShell module is in preview, you must install it separately using the Install-Module cmdlet.
```
Install-Module -Name Az.HealthBot
```
If you have multiple Azure subscriptions, choose the appropriate subscription in which the resources should be billed. Select a specific subscription using the Set-AzContext cmdlet.
```
Set-AzContext -SubscriptionId 00000000-0000-0000-0000-000000000000
```

Create a resource group

Create an Azure resource group using the New-AzResourceGroup cmdlet. A resource group is a logical container in which Azure resources are deployed and managed as a group.

The following example creates a resource group with the specified name and in the specified location.

New-AzResourceGroup -Name myResourceGroup -Location eastus

Create an Azure AI Health Bot

To create an Azure AI Health Bot, you use the New-AzHealthBot cmdlet. The following example creates an Azure AI Health Bot with the specified values.

New-AzHealthBot -Name myhealthbot -ResourceGroupName myResourceGroup -Location eastus -Sku F0

ResourceGroupName: Create a new group or use an existing group to organize your Azure AI Health Bot instances
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. The 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.

Retrieve Azure AI Health Bot information

To get a list of your Azure AI Health Bots and information about them, you use the Get-AzHealthBot cmdlet. The following example retrieves information about the specified Azure AI Health Bot.

Get-AzHealthBot -ResourceGroupName myResourceGroup -name myhealthbot

Clean up resources

If the resources created in this article aren't needed, you can delete them by running the following examples.

Delete the Azure AI Health Bot

To remove an Azure AI Health Bot, you use the Remove-AzHealthBot cmdlet. The following example deletes the specified Azure AI Health Bot.

Remove-AzHealthBot -Name myhealthbot -ResourceGroupName myResourceGroup

Delete the resource group

Caution

The following example deletes the specified resource group and all resources contained within it. If resources outside the scope of this article exist in the specified resource group, they will also be deleted.

Remove-AzResourceGroup -Name myResourceGroup

Next steps

Create your first custom scenario