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@2023-09-15-preview' = {
etag: 'string'
kind: 'string'
location: 'string'
name: 'string'
properties: {
allSettings: {
{customized property}: 'string'
}
appPasswordHint: 'string'
cmekKeyVaultUrl: 'string'
description: 'string'
developerAppInsightKey: 'string'
developerAppInsightsApiKey: 'string'
developerAppInsightsApplicationId: 'string'
disableLocalAuth: bool
displayName: 'string'
endpoint: 'string'
iconUrl: 'string'
isCmekEnabled: bool
isStreamingSupported: bool
luisAppIds: [
'string'
]
luisKey: 'string'
manifestUrl: 'string'
msaAppId: 'string'
msaAppMSIResourceId: 'string'
msaAppTenantId: 'string'
msaAppType: 'string'
openWithHint: 'string'
parameters: {
{customized property}: 'string'
}
publicNetworkAccess: 'string'
publishingCredentials: 'string'
schemaTransformationVersion: 'string'
storageResourceId: 'string'
tenantId: '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. | 'azurebot' '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 |
|---|---|---|
| allSettings | Contains resource all settings defined as key/value pairs. | BotPropertiesAllSettings |
| appPasswordHint | The hint (e.g. keyVault secret resourceId) on how to fetch the app secret | string |
| 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 |
| disableLocalAuth | Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. | bool |
| 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 |
| isStreamingSupported | Whether the bot is streaming supported | bool |
| luisAppIds | Collection of LUIS App Ids | string[] |
| luisKey | The LUIS Key | string |
| manifestUrl | The bot's manifest url | string |
| msaAppId | Microsoft App Id for the bot | string (required) |
| msaAppMSIResourceId | Microsoft App Managed Identity Resource Id for the bot | string |
| msaAppTenantId | Microsoft App Tenant Id for the bot | string |
| msaAppType | Microsoft App Type for the bot | 'MultiTenant' 'SingleTenant' 'UserAssignedMSI' |
| openWithHint | The hint to browser (e.g. protocol handler) on how to open the bot for authoring | string |
| parameters | Contains resource parameters defined as key/value pairs. | BotPropertiesParameters |
| publicNetworkAccess | Whether the bot is in an isolated network | 'Disabled' 'Enabled' 'SecuredByPerimeter' |
| publishingCredentials | Publishing credentials of the resource | string |
| schemaTransformationVersion | The channel schema transformation version for the bot | string |
| storageResourceId | The storage resourceId for the bot | string |
| tenantId | The Tenant Id for the bot | string |
BotPropertiesAllSettings
| Name | Description | Value |
|---|
BotPropertiesParameters
| Name | Description | Value |
|---|
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": "2023-09-15-preview",
"name": "string",
"etag": "string",
"kind": "string",
"location": "string",
"properties": {
"allSettings": {
"{customized property}": "string"
},
"appPasswordHint": "string",
"cmekKeyVaultUrl": "string",
"description": "string",
"developerAppInsightKey": "string",
"developerAppInsightsApiKey": "string",
"developerAppInsightsApplicationId": "string",
"disableLocalAuth": "bool",
"displayName": "string",
"endpoint": "string",
"iconUrl": "string",
"isCmekEnabled": "bool",
"isStreamingSupported": "bool",
"luisAppIds": [ "string" ],
"luisKey": "string",
"manifestUrl": "string",
"msaAppId": "string",
"msaAppMSIResourceId": "string",
"msaAppTenantId": "string",
"msaAppType": "string",
"openWithHint": "string",
"parameters": {
"{customized property}": "string"
},
"publicNetworkAccess": "string",
"publishingCredentials": "string",
"schemaTransformationVersion": "string",
"storageResourceId": "string",
"tenantId": "string"
},
"sku": {
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.BotService/botServices
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-09-15-preview' |
| etag | Entity Tag. | string |
| kind | Required. Gets or sets the Kind of the resource. | 'azurebot' '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 |
|---|---|---|
| allSettings | Contains resource all settings defined as key/value pairs. | BotPropertiesAllSettings |
| appPasswordHint | The hint (e.g. keyVault secret resourceId) on how to fetch the app secret | string |
| 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 |
| disableLocalAuth | Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. | bool |
| 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 |
| isStreamingSupported | Whether the bot is streaming supported | bool |
| luisAppIds | Collection of LUIS App Ids | string[] |
| luisKey | The LUIS Key | string |
| manifestUrl | The bot's manifest url | string |
| msaAppId | Microsoft App Id for the bot | string (required) |
| msaAppMSIResourceId | Microsoft App Managed Identity Resource Id for the bot | string |
| msaAppTenantId | Microsoft App Tenant Id for the bot | string |
| msaAppType | Microsoft App Type for the bot | 'MultiTenant' 'SingleTenant' 'UserAssignedMSI' |
| openWithHint | The hint to browser (e.g. protocol handler) on how to open the bot for authoring | string |
| parameters | Contains resource parameters defined as key/value pairs. | BotPropertiesParameters |
| publicNetworkAccess | Whether the bot is in an isolated network | 'Disabled' 'Enabled' 'SecuredByPerimeter' |
| publishingCredentials | Publishing credentials of the resource | string |
| schemaTransformationVersion | The channel schema transformation version for the bot | string |
| storageResourceId | The storage resourceId for the bot | string |
| tenantId | The Tenant Id for the bot | string |
BotPropertiesAllSettings
| Name | Description | Value |
|---|
BotPropertiesParameters
| Name | Description | Value |
|---|
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@2023-09-15-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
etag = "string"
kind = "string"
properties = {
allSettings = {
{customized property} = "string"
}
appPasswordHint = "string"
cmekKeyVaultUrl = "string"
description = "string"
developerAppInsightKey = "string"
developerAppInsightsApiKey = "string"
developerAppInsightsApplicationId = "string"
disableLocalAuth = bool
displayName = "string"
endpoint = "string"
iconUrl = "string"
isCmekEnabled = bool
isStreamingSupported = bool
luisAppIds = [
"string"
]
luisKey = "string"
manifestUrl = "string"
msaAppId = "string"
msaAppMSIResourceId = "string"
msaAppTenantId = "string"
msaAppType = "string"
openWithHint = "string"
parameters = {
{customized property} = "string"
}
publicNetworkAccess = "string"
publishingCredentials = "string"
schemaTransformationVersion = "string"
storageResourceId = "string"
tenantId = "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. | 'azurebot' '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@2023-09-15-preview" |
BotProperties
| Name | Description | Value |
|---|---|---|
| allSettings | Contains resource all settings defined as key/value pairs. | BotPropertiesAllSettings |
| appPasswordHint | The hint (e.g. keyVault secret resourceId) on how to fetch the app secret | string |
| 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 |
| disableLocalAuth | Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. | bool |
| 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 |
| isStreamingSupported | Whether the bot is streaming supported | bool |
| luisAppIds | Collection of LUIS App Ids | string[] |
| luisKey | The LUIS Key | string |
| manifestUrl | The bot's manifest url | string |
| msaAppId | Microsoft App Id for the bot | string (required) |
| msaAppMSIResourceId | Microsoft App Managed Identity Resource Id for the bot | string |
| msaAppTenantId | Microsoft App Tenant Id for the bot | string |
| msaAppType | Microsoft App Type for the bot | 'MultiTenant' 'SingleTenant' 'UserAssignedMSI' |
| openWithHint | The hint to browser (e.g. protocol handler) on how to open the bot for authoring | string |
| parameters | Contains resource parameters defined as key/value pairs. | BotPropertiesParameters |
| publicNetworkAccess | Whether the bot is in an isolated network | 'Disabled' 'Enabled' 'SecuredByPerimeter' |
| publishingCredentials | Publishing credentials of the resource | string |
| schemaTransformationVersion | The channel schema transformation version for the bot | string |
| storageResourceId | The storage resourceId for the bot | string |
| tenantId | The Tenant Id for the bot | string |
BotPropertiesAllSettings
| Name | Description | Value |
|---|
BotPropertiesParameters
| Name | Description | Value |
|---|
ResourceTags
| Name | Description | Value |
|---|
Sku
| Name | Description | Value |
|---|---|---|
| name | The sku name | 'F0' 'S1' (required) |