Create an Azure Bot resource

APPLIES TO: SDK v4

The Azure Bot resource (bot resource) allows you to register your bot with Azure Bot Services and to connect your bot to channels. You can build, connect, and manage bots to interact with your users wherever they are, from your app or website to Teams, Messenger and many other channels. To learn how to create a bot, see the Create a bot with the Bot Framework SDK quickstart.

This article describes how to create a bot resource through the Azure portal. For information on how to create a bot resource through the Azure CLI, see how to Deploy your bot in Azure.

When you create a bot resource, Azure creates associated resources. Some of the resources created depend on how you decide to manage your bot's identity.

Your bot's identity can be managed in Azure in a few different ways.

• As a user-assigned managed identity, so that you do not need to manage the bot's credentials yourself.
• As a single-tenant app.
• As a multi-tenant app.

Prerequisites

• If you don't have an Azure subscription, create a free account before you begin.
• The Bot Framework SDK for C# or Javascript version 4.15.0 or later, for user-assigned managed identity and single-tenant bots.

Create the resource

Create the Azure Bot resource, which will allow you to register your bot with the Azure Bot Service.

1. Go to the Azure portal.

2. In the right pane, select Create a resource.

3. In the search box enter bot, then press Enter.

4. Select the Azure Bot card.

   

5. Select Create.

6. Enter values in the required fields. Choose which type of app to create and whether to use existing or create new identity information.

   

7. Select Review + create.

8. If the validation passes, select Create.

9. Select Go to resource group. You should see the bot and related resources listed in the resource group you selected.

10. Select Get the SDK from GitHub to build your bot with the Bot Framework SDK.

    

Bot identity information

You need to add identity information to your bot's configuration file. The file differs depending on the programming language you use to create the bot.

The identity information you need to add depends on the bot's application type. Provide the following values in your configuration file.

To add the user-assigned managed identity to your bot's web app:

1. Go to the app service page for your bot's web app.
2. In the navigation pane under Settings, select Identity.
3. On the Identity pane, select the User assigned tab and Add (+).
4. On the Add user assigned managed identity pane:

   1. Select your subscription.

   2. For User assigned managed identities, select the managed identity for your bot. If the managed identity was auto-generated for you, it will have the same name as your bot.

   3. Select Add to use this identity for your bot.

      

To get your bot's app or tenant ID:

1. Go to the Azure Bot resource page for your bot.
2. Go to the bot's Configuration pane. From here you can copy the bot's Microsoft App ID or App Tenant ID.

To get the bot's app password from Azure Key Vault, see:

• About Azure Key Vault
• Use Key Vault references for App Service and Azure Functions.
• Assign a Key Vault access policy using the Azure portal
• Quickstart: Set and retrieve a secret from Azure Key Vault using the Azure portal

Additional information

• For information about identity management with Azure Active Directory, see What is Azure Active Directory?.
• For information about Azure App Service and App Service plans, see the App Service overview.
• For information about Azure resources and how they are managed in general, see the Azure Resource Manager overview.

Skill support

Some types of skill consumers are not able to use some types of skill bots. The following table describes which combinations are supported.

For information on how to configure a skill or skill consumer, see Implement a skill or Implement a skill consumer.

Next steps

• Create a bot with Bot Framework Composer
• Create a bot with the Bot Framework SDK