Azure Bot Channels Registration
This page shows how to write Terraform and Azure Resource Manager for Bot Channels Registration and write them securely.
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
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
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
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"
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
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
Parameters
-
developer_app_insights_api_key
optional computed - string -
developer_app_insights_application_id
optional computed - string -
developer_app_insights_key
optional computed - string -
display_name
optional computed - string -
endpoint
optional - string -
id
optional computed - string -
location
required - string -
microsoft_app_id
required - string -
name
required - string -
resource_group_name
required - string -
sku
required - string -
tags
optional - map from string to string -
timeouts
single block
Explanation in Terraform Registry
Manages a Bot Channels Registration.
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 - stringetag
optional - stringEntity Tag
kind
optional - stringRequired. Gets or sets the Kind of the resource.
location
optional - stringSpecifies the location of the resource.
name
required - stringThe name of the Bot resource.
properties
requiredallSettings
optional - stringContains resource all settings defined as key/value pairs.
appPasswordHint
optional - stringThe hint (e.g. keyVault secret resourceId) on how to fetch the app secret
cmekEncryptionStatus
optional - stringThe CMK encryption status
cmekKeyVaultUrl
optional - stringThe CMK Url
description
optional - stringThe description of the bot
developerAppInsightKey
optional - stringThe Application Insights key
developerAppInsightsApiKey
optional - stringThe Application Insights Api Key
developerAppInsightsApplicationId
optional - stringThe Application Insights App Id
disableLocalAuth
optional - booleanOpt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
displayName
required - stringThe Name of the bot
endpoint
required - stringThe bot's endpoint
iconUrl
optional - stringThe Icon Url of the bot
isCmekEnabled
optional - booleanWhether Cmek is enabled
isDeveloperAppInsightsApiKeySet
optional - booleanWhether the bot is developerAppInsightsApiKey set
isStreamingSupported
optional - booleanWhether the bot is streaming supported
luisAppIds
optional - arrayCollection of LUIS App Ids
luisKey
optional - stringThe LUIS Key
manifestUrl
optional - stringThe bot's manifest url
msaAppId
required - stringMicrosoft App Id for the bot
msaAppMSIResourceId
optional - stringMicrosoft App Managed Identity Resource Id for the bot
msaAppTenantId
optional - stringMicrosoft App Tenant Id for the bot
msaAppType
optional - stringMicrosoft App Type for the bot.
openWithHint
optional - stringThe hint to browser (e.g. protocol handler) on how to open the bot for authoring
parameters
optional - stringContains resource parameters defined as key/value pairs.
publicNetworkAccess
optional - stringWhether the bot is in an isolated network.
publishingCredentials
optional - stringPublishing credentials of the resource
schemaTransformationVersion
optional - stringThe channel schema transformation version for the bot
storageResourceId
optional - stringThe storage resourceId for the bot
sku
optionalname
required - stringThe sku name.
tags
optional - stringContains resource tags defined as key/value pairs.
type
required - string
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.