Top / Microsoft Azure / Azure Bot / Channels Registration

Azure Bot Channels Registration

This page shows how to write Terraform and Azure Resource Manager for Bot Channels Registration and write them securely.

terraform-logo

Review your .tf file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

azurerm_bot_channels_registration (Terraform)

The Channels Registration in Bot can be configured in Terraform with the resource name azurerm_bot_channels_registration. The following sections describe 5 examples of how to use the resource and its parameters.

Example Usage from GitHub

botregistration.tf#L21
resource "azurerm_bot_channels_registration" "root_bot_service_registration" {
   name                = var.bot_registration_name
   display_name        = var.bot_registration_name
#   endpoint            = data.terraform_remote_state.aws_state.output.api_gateway_stage_url
   location            = "global"
   resource_group_name = azurerm_resource_group.root_bot_resource_group.name
bot.tf#L1
resource "azurerm_bot_channels_registration" "bot" {
  name                                  = var.bot_name
  location                              = "global"
  resource_group_name                   = azurerm_resource_group.rg.name
  display_name                          = var.bot_display_name
  #microsoft_app_id                      = azuread_application.app.application_id
bot.tf#L3
resource "azurerm_bot_channels_registration" "oas_unblock_bot_bdm_dev" {
  name                = "oas_unblock_bot_bdm_dev"
  location            = "global"
  resource_group_name = azurerm_resource_group.oas_unblock_luis.name
  sku                 = "F0"
  microsoft_app_id    = "1263a42b-f5c3-4060-86f2-05a8245e7f01"
main.tf#L7
resource "azurerm_bot_channels_registration" "this" {
  developer_app_insights_api_key        = var.developer_app_insights_api_key
  developer_app_insights_application_id = var.developer_app_insights_application_id
  developer_app_insights_key            = var.developer_app_insights_key
  display_name                          = var.display_name
  endpoint                              = var.endpoint
main.tf#L7
resource "azurerm_bot_channels_registration" "this" {
  developer_app_insights_api_key        = var.developer_app_insights_api_key
  developer_app_insights_application_id = var.developer_app_insights_application_id
  developer_app_insights_key            = var.developer_app_insights_key
  display_name                          = var.display_name
  endpoint                              = var.endpoint

Review your Terraform file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

>> from Terraform Registry

Explanation in Terraform Registry

Manages a Bot Channels Registration.

>> from Terraform Registry

Microsoft.BotService/botServices (Azure Resource Manager)

The botServices in Microsoft.BotService can be configured in Azure Resource Manager with the resource name Microsoft.BotService/botServices. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Parameters

  • apiVersion required - string
  • etag optional - string

    Entity Tag

  • kind optional - string

    Required. Gets or sets the Kind of the resource.

  • location optional - string

    Specifies the location of the resource.

  • name required - string

    The name of the Bot resource.

  • properties required
      • allSettings optional - string

        Contains resource all settings defined as key/value pairs.

      • appPasswordHint optional - string

        The hint (e.g. keyVault secret resourceId) on how to fetch the app secret

      • cmekEncryptionStatus optional - string

        The CMK encryption status

      • cmekKeyVaultUrl optional - string

        The CMK Url

      • description optional - string

        The description of the bot

      • developerAppInsightKey optional - string

        The Application Insights key

      • developerAppInsightsApiKey optional - string

        The Application Insights Api Key

      • developerAppInsightsApplicationId optional - string

        The Application Insights App Id

      • disableLocalAuth optional - boolean

        Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.

      • displayName required - string

        The Name of the bot

      • endpoint required - string

        The bot's endpoint

      • iconUrl optional - string

        The Icon Url of the bot

      • isCmekEnabled optional - boolean

        Whether Cmek is enabled

      • isDeveloperAppInsightsApiKeySet optional - boolean

        Whether the bot is developerAppInsightsApiKey set

      • isStreamingSupported optional - boolean

        Whether the bot is streaming supported

      • luisAppIds optional - array

        Collection of LUIS App Ids

      • luisKey optional - string

        The LUIS Key

      • manifestUrl optional - string

        The bot's manifest url

      • msaAppId required - string

        Microsoft App Id for the bot

      • msaAppMSIResourceId optional - string

        Microsoft App Managed Identity Resource Id for the bot

      • msaAppTenantId optional - string

        Microsoft App Tenant Id for the bot

      • msaAppType optional - string

        Microsoft App Type for the bot.

      • openWithHint optional - string

        The hint to browser (e.g. protocol handler) on how to open the bot for authoring

      • parameters optional - string

        Contains resource parameters defined as key/value pairs.

      • publicNetworkAccess optional - string

        Whether the bot is in an isolated network.

      • publishingCredentials optional - string

        Publishing credentials of the resource

      • schemaTransformationVersion optional - string

        The channel schema transformation version for the bot

      • storageResourceId optional - string

        The storage resourceId for the bot

  • sku optional
      • name required - string

        The sku name.

  • tags optional - string

    Contains resource tags defined as key/value pairs.

  • type required - string

>> from Azure Resource Manager Documentation

The Other Related Azure Bot Resources

Frequently asked questions

What is Azure Bot Channels Registration?

Azure Bot Channels Registration is a resource for Bot of Microsoft Azure. Settings can be wrote in Terraform.

Where can I find the example code for the Azure Bot Channels Registration?

For Terraform, the wonboyn/selfserviceiac, mathieu-benoit/MyMonthlyBlogArticle.Bot and DTS-STN/oas-unblock-bot source code examples are useful. See the Terraform Example section for further details.

security-icon

Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.

Table of Contents