Microsoft.BotService botServices 2020-06-02
Bicep resource definition
The botServices resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.BotService/botServices resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.BotService/botServices@2020-06-02' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
name: 'string'
}
kind: 'string'
etag: 'string'
properties: {
cmekKeyVaultUrl: 'string'
description: 'string'
developerAppInsightKey: 'string'
developerAppInsightsApiKey: 'string'
developerAppInsightsApplicationId: 'string'
displayName: 'string'
endpoint: 'string'
iconUrl: 'string'
isCmekEnabled: bool
luisAppIds: [
'string'
]
luisKey: 'string'
msaAppId: 'string'
}
}
Property values
botServices
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) Character limit: 2-64 Valid characters: Alphanumerics, underscores, periods, and hyphens. Start with alphanumeric. Resource name must be unique across Azure. |
| location | Specifies the location of the resource. | string |
| tags | Contains resource tags defined as key/value pairs. | Dictionary of tag names and values. See Tags in templates |
| sku | Gets or sets the SKU of the resource. | Sku |
| kind | Required. Gets or sets the Kind of the resource. | 'bot' 'designer' 'function' 'sdk' |
| etag | Entity Tag | string |
| properties | The set of properties specific to bot resource | BotProperties |
BotProperties
| Name | Description | Value |
|---|---|---|
| cmekKeyVaultUrl | The CMK Url | string |
| description | The description of the bot | string |
| developerAppInsightKey | The Application Insights key | string |
| developerAppInsightsApiKey | The Application Insights Api Key | string |
| developerAppInsightsApplicationId | The Application Insights App Id | string |
| displayName | The Name of the bot | string (required) |
| endpoint | The bot's endpoint | string (required) |
| iconUrl | The Icon Url of the bot | string |
| isCmekEnabled | Whether Cmek is enabled | bool |
| luisAppIds | Collection of LUIS App Ids | string[] |
| luisKey | The LUIS Key | string |
| msaAppId | Microsoft App Id for the bot | string (required) |
Sku
| Name | Description | Value |
|---|---|---|
| name | The sku name | 'F0' 'S1' (required) |
ARM template resource definition
The botServices resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.BotService/botServices resource, add the following JSON to your template.
{
"type": "Microsoft.BotService/botServices",
"apiVersion": "2020-06-02",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"name": "string"
},
"kind": "string",
"etag": "string",
"properties": {
"cmekKeyVaultUrl": "string",
"description": "string",
"developerAppInsightKey": "string",
"developerAppInsightsApiKey": "string",
"developerAppInsightsApplicationId": "string",
"displayName": "string",
"endpoint": "string",
"iconUrl": "string",
"isCmekEnabled": "bool",
"luisAppIds": [ "string" ],
"luisKey": "string",
"msaAppId": "string"
}
}
Property values
botServices
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.BotService/botServices' |
| apiVersion | The resource api version | '2020-06-02' |
| name | The resource name | string (required) Character limit: 2-64 Valid characters: Alphanumerics, underscores, periods, and hyphens. Start with alphanumeric. Resource name must be unique across Azure. |
| location | Specifies the location of the resource. | string |
| tags | Contains resource tags defined as key/value pairs. | Dictionary of tag names and values. See Tags in templates |
| sku | Gets or sets the SKU of the resource. | Sku |
| kind | Required. Gets or sets the Kind of the resource. | 'bot' 'designer' 'function' 'sdk' |
| etag | Entity Tag | string |
| properties | The set of properties specific to bot resource | BotProperties |
BotProperties
| Name | Description | Value |
|---|---|---|
| cmekKeyVaultUrl | The CMK Url | string |
| description | The description of the bot | string |
| developerAppInsightKey | The Application Insights key | string |
| developerAppInsightsApiKey | The Application Insights Api Key | string |
| developerAppInsightsApplicationId | The Application Insights App Id | string |
| displayName | The Name of the bot | string (required) |
| endpoint | The bot's endpoint | string (required) |
| iconUrl | The Icon Url of the bot | string |
| isCmekEnabled | Whether Cmek is enabled | bool |
| luisAppIds | Collection of LUIS App Ids | string[] |
| luisKey | The LUIS Key | string |
| msaAppId | Microsoft App Id for the bot | string (required) |
Sku
| Name | Description | Value |
|---|---|---|
| name | The sku name | 'F0' 'S1' (required) |
Terraform (AzAPI provider) resource definition
The botServices resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.BotService/botServices resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.BotService/botServices@2020-06-02"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
cmekKeyVaultUrl = "string"
description = "string"
developerAppInsightKey = "string"
developerAppInsightsApiKey = "string"
developerAppInsightsApplicationId = "string"
displayName = "string"
endpoint = "string"
iconUrl = "string"
isCmekEnabled = bool
luisAppIds = [
"string"
]
luisKey = "string"
msaAppId = "string"
}
sku = {
name = "string"
}
kind = "string"
etag = "string"
})
}
Property values
botServices
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.BotService/botServices@2020-06-02" |
| name | The resource name | string (required) Character limit: 2-64 Valid characters: Alphanumerics, underscores, periods, and hyphens. Start with alphanumeric. Resource name must be unique across Azure. |
| location | Specifies the location of the resource. | string |
| parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
| tags | Contains resource tags defined as key/value pairs. | Dictionary of tag names and values. |
| sku | Gets or sets the SKU of the resource. | Sku |
| kind | Required. Gets or sets the Kind of the resource. | "bot" "designer" "function" "sdk" |
| etag | Entity Tag | string |
| properties | The set of properties specific to bot resource | BotProperties |
BotProperties
| Name | Description | Value |
|---|---|---|
| cmekKeyVaultUrl | The CMK Url | string |
| description | The description of the bot | string |
| developerAppInsightKey | The Application Insights key | string |
| developerAppInsightsApiKey | The Application Insights Api Key | string |
| developerAppInsightsApplicationId | The Application Insights App Id | string |
| displayName | The Name of the bot | string (required) |
| endpoint | The bot's endpoint | string (required) |
| iconUrl | The Icon Url of the bot | string |
| isCmekEnabled | Whether Cmek is enabled | bool |
| luisAppIds | Collection of LUIS App Ids | string[] |
| luisKey | The LUIS Key | string |
| msaAppId | Microsoft App Id for the bot | string (required) |
Sku
| Name | Description | Value |
|---|---|---|
| name | The sku name | "F0" "S1" (required) |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for