Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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@2017-12-01' = {
etag: 'string'
kind: 'string'
location: 'string'
name: 'string'
properties: {
description: 'string'
developerAppInsightKey: 'string'
developerAppInsightsApiKey: 'string'
developerAppInsightsApplicationId: 'string'
displayName: 'string'
endpoint: 'string'
iconUrl: 'string'
luisAppIds: [
'string'
]
luisKey: 'string'
msaAppId: 'string'
}
sku: {
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.BotService/botServices
| Name | Description | Value |
|---|---|---|
| etag | Entity Tag | string |
| kind | Required. Gets or sets the Kind of the resource. | 'bot' 'designer' 'function' 'sdk' |
| location | Specifies the location of the resource. | string |
| name | The resource name | string Constraints: Min length = 2 Max length = 64 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ (required) |
| properties | The set of properties specific to bot resource | BotProperties |
| sku | Gets or sets the SKU of the resource. | Sku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
BotProperties
| Name | Description | Value |
|---|---|---|
| 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 |
| luisAppIds | Collection of LUIS App Ids | string[] |
| luisKey | The LUIS Key | string |
| msaAppId | Microsoft App Id for the bot | string (required) |
ResourceTags
| Name | Description | Value |
|---|
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": "2017-12-01",
"name": "string",
"etag": "string",
"kind": "string",
"location": "string",
"properties": {
"description": "string",
"developerAppInsightKey": "string",
"developerAppInsightsApiKey": "string",
"developerAppInsightsApplicationId": "string",
"displayName": "string",
"endpoint": "string",
"iconUrl": "string",
"luisAppIds": [ "string" ],
"luisKey": "string",
"msaAppId": "string"
},
"sku": {
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.BotService/botServices
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2017-12-01' |
| etag | Entity Tag | string |
| kind | Required. Gets or sets the Kind of the resource. | 'bot' 'designer' 'function' 'sdk' |
| location | Specifies the location of the resource. | string |
| name | The resource name | string Constraints: Min length = 2 Max length = 64 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ (required) |
| properties | The set of properties specific to bot resource | BotProperties |
| sku | Gets or sets the SKU of the resource. | Sku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.BotService/botServices' |
BotProperties
| Name | Description | Value |
|---|---|---|
| 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 |
| luisAppIds | Collection of LUIS App Ids | string[] |
| luisKey | The LUIS Key | string |
| msaAppId | Microsoft App Id for the bot | string (required) |
ResourceTags
| Name | Description | Value |
|---|
Sku
| Name | Description | Value |
|---|---|---|
| name | The sku name | 'F0' 'S1' (required) |
Usage Examples
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@2017-12-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
etag = "string"
kind = "string"
properties = {
description = "string"
developerAppInsightKey = "string"
developerAppInsightsApiKey = "string"
developerAppInsightsApplicationId = "string"
displayName = "string"
endpoint = "string"
iconUrl = "string"
luisAppIds = [
"string"
]
luisKey = "string"
msaAppId = "string"
}
sku = {
name = "string"
}
}
}
Property Values
Microsoft.BotService/botServices
| Name | Description | Value |
|---|---|---|
| etag | Entity Tag | string |
| kind | Required. Gets or sets the Kind of the resource. | 'bot' 'designer' 'function' 'sdk' |
| location | Specifies the location of the resource. | string |
| name | The resource name | string Constraints: Min length = 2 Max length = 64 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ (required) |
| properties | The set of properties specific to bot resource | BotProperties |
| sku | Gets or sets the SKU of the resource. | Sku |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.BotService/botServices@2017-12-01" |
BotProperties
| Name | Description | Value |
|---|---|---|
| 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 |
| luisAppIds | Collection of LUIS App Ids | string[] |
| luisKey | The LUIS Key | string |
| msaAppId | Microsoft App Id for the bot | string (required) |
ResourceTags
| Name | Description | Value |
|---|
Sku
| Name | Description | Value |
|---|---|---|
| name | The sku name | 'F0' 'S1' (required) |