Microsoft.BotService botServices/channels 2020-06-02

Article
04/13/2023

Bicep resource definition

The botServices/channels 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/channels resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.BotService/botServices/channels@2020-06-02' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
  }
  kind: 'string'
  parent: resourceSymbolicName
  etag: 'string'
  properties: {
    channelName: 'string'
    // For remaining properties, see Channel objects
  }
}

Channel objects

Set the channelName property to specify the type of object.

For AlexaChannel, use:

  channelName: 'AlexaChannel'
  properties: {
    alexaSkillId: 'string'
    isEnabled: bool
  }

For DirectLineChannel, use:

  channelName: 'DirectLineChannel'
  properties: {
    sites: [
      {
        isEnabled: bool
        isSecureSiteEnabled: bool
        isV1Enabled: bool
        isV3Enabled: bool
        siteName: 'string'
        trustedOrigins: [
          'string'
        ]
      }
    ]
  }

For DirectLineSpeechChannel, use:

  channelName: 'DirectLineSpeechChannel'
  properties: {
    cognitiveServicesSubscriptionId: 'string'
    customSpeechModelId: 'string'
    customVoiceDeploymentId: 'string'
    isDefaultBotForCogSvcAccount: bool
    isEnabled: bool
  }

For EmailChannel, use:

  channelName: 'EmailChannel'
  properties: {
    emailAddress: 'string'
    isEnabled: bool
    password: 'string'
  }

For FacebookChannel, use:

  channelName: 'FacebookChannel'
  properties: {
    appId: 'string'
    appSecret: 'string'
    isEnabled: bool
    pages: [
      {
        accessToken: 'string'
        id: 'string'
      }
    ]
  }

For KikChannel, use:

  channelName: 'KikChannel'
  properties: {
    apiKey: 'string'
    isEnabled: bool
    isValidated: bool
    userName: 'string'
  }

For LineChannel, use:

  channelName: 'LineChannel'
  properties: {
    lineRegistrations: [
      {
        channelAccessToken: 'string'
        channelSecret: 'string'
      }
    ]
  }

For MsTeamsChannel, use:

  channelName: 'MsTeamsChannel'
  properties: {
    callingWebHook: 'string'
    enableCalling: bool
    isEnabled: bool
  }

For SkypeChannel, use:

  channelName: 'SkypeChannel'
  properties: {
    callingWebHook: 'string'
    enableCalling: bool
    enableGroups: bool
    enableMediaCards: bool
    enableMessaging: bool
    enableScreenSharing: bool
    enableVideo: bool
    groupsMode: 'string'
    isEnabled: bool
  }

For SlackChannel, use:

  channelName: 'SlackChannel'
  properties: {
    clientId: 'string'
    clientSecret: 'string'
    isEnabled: bool
    landingPageUrl: 'string'
    signingSecret: 'string'
    verificationToken: 'string'
  }

For SmsChannel, use:

  channelName: 'SmsChannel'
  properties: {
    accountSID: 'string'
    authToken: 'string'
    isEnabled: bool
    isValidated: bool
    phone: 'string'
  }

For TelegramChannel, use:

  channelName: 'TelegramChannel'
  properties: {
    accessToken: 'string'
    isEnabled: bool
    isValidated: bool
  }

For WebChatChannel, use:

  channelName: 'WebChatChannel'
  properties: {
    sites: [
      {
        enablePreview: bool
        isEnabled: bool
        siteName: 'string'
      }
    ]
  }

Property values

botServices/channels

Name	Description	Value
name	The resource name See how to set names and types for child resources in Bicep.	string (required) Character limit: 2-64 Valid characters: Alphanumerics, underscores, periods, and hyphens. Start with alphanumeric.
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'
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: botServices
etag	Entity Tag	string
properties	The set of properties specific to bot channel resource	Channel

Channel

Name	Description	Value
channelName	Set the object type	AlexaChannel DirectLineChannel DirectLineSpeechChannel EmailChannel FacebookChannel KikChannel LineChannel MsTeamsChannel SkypeChannel SlackChannel SmsChannel TelegramChannel WebChatChannel (required)

AlexaChannel

Name	Description	Value
channelName	The channel name	'AlexaChannel' (required)
properties	The set of properties specific to Alexa channel resource	AlexaChannelProperties

AlexaChannelProperties

Name	Description	Value
alexaSkillId	The Alexa skill Id	string (required)
isEnabled	Whether this channel is enabled for the bot	bool (required)

DirectLineChannel

Name	Description	Value
channelName	The channel name	'DirectLineChannel' (required)
properties	The set of properties specific to Direct Line channel resource	DirectLineChannelProperties

DirectLineChannelProperties

Name	Description	Value
sites	The list of Direct Line sites	DirectLineSite[]

DirectLineSite

Name	Description	Value
isEnabled	Whether this site is enabled for DirectLine channel.	bool (required)
isSecureSiteEnabled	Whether this site is enabled for authentication with Bot Framework.	bool
isV1Enabled	Whether this site is enabled for Bot Framework V1 protocol.	bool (required)
isV3Enabled	Whether this site is enabled for Bot Framework V1 protocol.	bool (required)
siteName	Site name	string (required)
trustedOrigins	List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True.	string[]

DirectLineSpeechChannel

Name	Description	Value
channelName	The channel name	'DirectLineSpeechChannel' (required)
properties	The set of properties specific to DirectLine Speech channel resource	DirectLineSpeechChannelProperties

DirectLineSpeechChannelProperties

Name	Description	Value
cognitiveServicesSubscriptionId	The cognitive service subscription ID to use with this channel registration.	string (required)
customSpeechModelId	Custom voice deployment id (optional).	string
customVoiceDeploymentId	Custom speech model id (optional).	string
isDefaultBotForCogSvcAccount	Make this a default bot for chosen cognitive service account.	bool
isEnabled	Whether this channel is enabled or not.	bool

EmailChannel

Name	Description	Value
channelName	The channel name	'EmailChannel' (required)
properties	The set of properties specific to email channel resource	EmailChannelProperties

EmailChannelProperties

Name	Description	Value
emailAddress	The email address	string (required)
isEnabled	Whether this channel is enabled for the bot	bool (required)
password	The password for the email address. Value only returned through POST to the action Channel List API, otherwise empty.	string

FacebookChannel

Name	Description	Value
channelName	The channel name	'FacebookChannel' (required)
properties	The set of properties specific to bot facebook channel	FacebookChannelProperties

FacebookChannelProperties

Name	Description	Value
appId	Facebook application id	string (required)
appSecret	Facebook application secret. Value only returned through POST to the action Channel List API, otherwise empty.	string
isEnabled	Whether this channel is enabled for the bot	bool (required)
pages	The list of Facebook pages	FacebookPage[]

FacebookPage

Name	Description	Value
accessToken	Facebook application access token. Value only returned through POST to the action Channel List API, otherwise empty.	string
id	Page id	string (required)

KikChannel

Name	Description	Value
channelName	The channel name	'KikChannel' (required)
properties	The set of properties specific to Kik channel resource	KikChannelProperties

KikChannelProperties

Name	Description	Value
apiKey	Kik API key. Value only returned through POST to the action Channel List API, otherwise empty.	string
isEnabled	Whether this channel is enabled for the bot	bool (required)
isValidated	Whether this channel is validated for the bot	bool
userName	The Kik user name	string (required)

LineChannel

Name	Description	Value
channelName	The channel name	'LineChannel' (required)
properties	The set of properties specific to line channel resource	LineChannelProperties

LineChannelProperties

Name	Description	Value
lineRegistrations	The list of line channel registrations	LineRegistration[] (required)

LineRegistration

Name	Description	Value
channelAccessToken	Access token for the line channel registration	string
channelSecret	Secret for the line channel registration	string

MsTeamsChannel

Name	Description	Value
channelName	The channel name	'MsTeamsChannel' (required)
properties	The set of properties specific to Microsoft Teams channel resource	MsTeamsChannelProperties

MsTeamsChannelProperties

Name	Description	Value
callingWebHook	Webhook for Microsoft Teams channel calls	string
enableCalling	Enable calling for Microsoft Teams channel	bool
isEnabled	Whether this channel is enabled for the bot	bool (required)

SkypeChannel

Name	Description	Value
channelName	The channel name	'SkypeChannel' (required)
properties	The set of properties specific to Skype channel resource	SkypeChannelProperties

SkypeChannelProperties

Name	Description	Value
callingWebHook	Calling web hook for Skype channel	string
enableCalling	Enable calling for Skype channel	bool
enableGroups	Enable groups for Skype channel	bool
enableMediaCards	Enable media cards for Skype channel	bool
enableMessaging	Enable messaging for Skype channel	bool
enableScreenSharing	Enable screen sharing for Skype channel	bool
enableVideo	Enable video for Skype channel	bool
groupsMode	Group mode for Skype channel	string
isEnabled	Whether this channel is enabled for the bot	bool (required)

SlackChannel

Name	Description	Value
channelName	The channel name	'SlackChannel' (required)
properties	The set of properties specific to Slack channel resource	SlackChannelProperties

SlackChannelProperties

Name	Description	Value
clientId	The Slack client id	string
clientSecret	The Slack client secret. Value only returned through POST to the action Channel List API, otherwise empty.	string
isEnabled	Whether this channel is enabled for the bot	bool (required)
landingPageUrl	The Slack landing page Url	string
signingSecret	The Slack signing secret.	string
verificationToken	The Slack verification token. Value only returned through POST to the action Channel List API, otherwise empty.	string

SmsChannel

Name	Description	Value
channelName	The channel name	'SmsChannel' (required)
properties	The set of properties specific to Sms channel resource	SmsChannelProperties

SmsChannelProperties

Name	Description	Value
accountSID	The Sms account SID. Value only returned through POST to the action Channel List API, otherwise empty.	string (required)
authToken	The Sms auth token. Value only returned through POST to the action Channel List API, otherwise empty.	string
isEnabled	Whether this channel is enabled for the bot	bool (required)
isValidated	Whether this channel is validated for the bot	bool
phone	The Sms phone	string (required)

TelegramChannel

Name	Description	Value
channelName	The channel name	'TelegramChannel' (required)
properties	The set of properties specific to Telegram channel resource	TelegramChannelProperties

TelegramChannelProperties

Name	Description	Value
accessToken	The Telegram access token. Value only returned through POST to the action Channel List API, otherwise empty.	string
isEnabled	Whether this channel is enabled for the bot	bool (required)
isValidated	Whether this channel is validated for the bot	bool

WebChatChannel

Name	Description	Value
channelName	The channel name	'WebChatChannel' (required)
properties	The set of properties specific to Web Chat channel resource	WebChatChannelProperties

WebChatChannelProperties

Name	Description	Value
sites	The list of Web Chat sites	WebChatSite[]

WebChatSite

Name	Description	Value
enablePreview	Whether this site is enabled for preview versions of Webchat	bool (required)
isEnabled	Whether this site is enabled for DirectLine channel	bool (required)
siteName	Site name	string (required)

Sku

Name	Description	Value
name	The sku name	'F0' 'S1' (required)

ARM template resource definition

The botServices/channels 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/channels resource, add the following JSON to your template.

{
  "type": "Microsoft.BotService/botServices/channels",
  "apiVersion": "2020-06-02",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string"
  },
  "kind": "string",
  "etag": "string",
  "properties": {
    "channelName": "string"
    // For remaining properties, see Channel objects
  }
}

Channel objects

Set the channelName property to specify the type of object.

For AlexaChannel, use:

  "channelName": "AlexaChannel",
  "properties": {
    "alexaSkillId": "string",
    "isEnabled": "bool"
  }

For DirectLineChannel, use:

  "channelName": "DirectLineChannel",
  "properties": {
    "sites": [
      {
        "isEnabled": "bool",
        "isSecureSiteEnabled": "bool",
        "isV1Enabled": "bool",
        "isV3Enabled": "bool",
        "siteName": "string",
        "trustedOrigins": [ "string" ]
      }
    ]
  }

For DirectLineSpeechChannel, use:

  "channelName": "DirectLineSpeechChannel",
  "properties": {
    "cognitiveServicesSubscriptionId": "string",
    "customSpeechModelId": "string",
    "customVoiceDeploymentId": "string",
    "isDefaultBotForCogSvcAccount": "bool",
    "isEnabled": "bool"
  }

For EmailChannel, use:

  "channelName": "EmailChannel",
  "properties": {
    "emailAddress": "string",
    "isEnabled": "bool",
    "password": "string"
  }

For FacebookChannel, use:

  "channelName": "FacebookChannel",
  "properties": {
    "appId": "string",
    "appSecret": "string",
    "isEnabled": "bool",
    "pages": [
      {
        "accessToken": "string",
        "id": "string"
      }
    ]
  }

For KikChannel, use:

  "channelName": "KikChannel",
  "properties": {
    "apiKey": "string",
    "isEnabled": "bool",
    "isValidated": "bool",
    "userName": "string"
  }

For LineChannel, use:

  "channelName": "LineChannel",
  "properties": {
    "lineRegistrations": [
      {
        "channelAccessToken": "string",
        "channelSecret": "string"
      }
    ]
  }

For MsTeamsChannel, use:

  "channelName": "MsTeamsChannel",
  "properties": {
    "callingWebHook": "string",
    "enableCalling": "bool",
    "isEnabled": "bool"
  }

For SkypeChannel, use:

  "channelName": "SkypeChannel",
  "properties": {
    "callingWebHook": "string",
    "enableCalling": "bool",
    "enableGroups": "bool",
    "enableMediaCards": "bool",
    "enableMessaging": "bool",
    "enableScreenSharing": "bool",
    "enableVideo": "bool",
    "groupsMode": "string",
    "isEnabled": "bool"
  }

For SlackChannel, use:

  "channelName": "SlackChannel",
  "properties": {
    "clientId": "string",
    "clientSecret": "string",
    "isEnabled": "bool",
    "landingPageUrl": "string",
    "signingSecret": "string",
    "verificationToken": "string"
  }

For SmsChannel, use:

  "channelName": "SmsChannel",
  "properties": {
    "accountSID": "string",
    "authToken": "string",
    "isEnabled": "bool",
    "isValidated": "bool",
    "phone": "string"
  }

For TelegramChannel, use:

  "channelName": "TelegramChannel",
  "properties": {
    "accessToken": "string",
    "isEnabled": "bool",
    "isValidated": "bool"
  }

For WebChatChannel, use:

  "channelName": "WebChatChannel",
  "properties": {
    "sites": [
      {
        "enablePreview": "bool",
        "isEnabled": "bool",
        "siteName": "string"
      }
    ]
  }

Property values

botServices/channels

Name	Description	Value
type	The resource type	'Microsoft.BotService/botServices/channels'
apiVersion	The resource api version	'2020-06-02'
name	The resource name See how to set names and types for child resources in JSON ARM templates.	string (required) Character limit: 2-64 Valid characters: Alphanumerics, underscores, periods, and hyphens. Start with alphanumeric.
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 channel resource	Channel

Channel

Name	Description	Value
channelName	Set the object type	AlexaChannel DirectLineChannel DirectLineSpeechChannel EmailChannel FacebookChannel KikChannel LineChannel MsTeamsChannel SkypeChannel SlackChannel SmsChannel TelegramChannel WebChatChannel (required)

AlexaChannel

Name	Description	Value
channelName	The channel name	'AlexaChannel' (required)
properties	The set of properties specific to Alexa channel resource	AlexaChannelProperties

AlexaChannelProperties

Name	Description	Value
alexaSkillId	The Alexa skill Id	string (required)
isEnabled	Whether this channel is enabled for the bot	bool (required)

DirectLineChannel

Name	Description	Value
channelName	The channel name	'DirectLineChannel' (required)
properties	The set of properties specific to Direct Line channel resource	DirectLineChannelProperties

DirectLineChannelProperties

Name	Description	Value
sites	The list of Direct Line sites	DirectLineSite[]

DirectLineSite

Name	Description	Value
isEnabled	Whether this site is enabled for DirectLine channel.	bool (required)
isSecureSiteEnabled	Whether this site is enabled for authentication with Bot Framework.	bool
isV1Enabled	Whether this site is enabled for Bot Framework V1 protocol.	bool (required)
isV3Enabled	Whether this site is enabled for Bot Framework V1 protocol.	bool (required)
siteName	Site name	string (required)
trustedOrigins	List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True.	string[]

DirectLineSpeechChannel

Name	Description	Value
channelName	The channel name	'DirectLineSpeechChannel' (required)
properties	The set of properties specific to DirectLine Speech channel resource	DirectLineSpeechChannelProperties

DirectLineSpeechChannelProperties

Name	Description	Value
cognitiveServicesSubscriptionId	The cognitive service subscription ID to use with this channel registration.	string (required)
customSpeechModelId	Custom voice deployment id (optional).	string
customVoiceDeploymentId	Custom speech model id (optional).	string
isDefaultBotForCogSvcAccount	Make this a default bot for chosen cognitive service account.	bool
isEnabled	Whether this channel is enabled or not.	bool

EmailChannel

Name	Description	Value
channelName	The channel name	'EmailChannel' (required)
properties	The set of properties specific to email channel resource	EmailChannelProperties

EmailChannelProperties

Name	Description	Value
emailAddress	The email address	string (required)
isEnabled	Whether this channel is enabled for the bot	bool (required)
password	The password for the email address. Value only returned through POST to the action Channel List API, otherwise empty.	string

FacebookChannel

Name	Description	Value
channelName	The channel name	'FacebookChannel' (required)
properties	The set of properties specific to bot facebook channel	FacebookChannelProperties

FacebookChannelProperties

Name	Description	Value
appId	Facebook application id	string (required)
appSecret	Facebook application secret. Value only returned through POST to the action Channel List API, otherwise empty.	string
isEnabled	Whether this channel is enabled for the bot	bool (required)
pages	The list of Facebook pages	FacebookPage[]

FacebookPage

Name	Description	Value
accessToken	Facebook application access token. Value only returned through POST to the action Channel List API, otherwise empty.	string
id	Page id	string (required)

KikChannel

Name	Description	Value
channelName	The channel name	'KikChannel' (required)
properties	The set of properties specific to Kik channel resource	KikChannelProperties

KikChannelProperties

Name	Description	Value
apiKey	Kik API key. Value only returned through POST to the action Channel List API, otherwise empty.	string
isEnabled	Whether this channel is enabled for the bot	bool (required)
isValidated	Whether this channel is validated for the bot	bool
userName	The Kik user name	string (required)

LineChannel

Name	Description	Value
channelName	The channel name	'LineChannel' (required)
properties	The set of properties specific to line channel resource	LineChannelProperties

LineChannelProperties

Name	Description	Value
lineRegistrations	The list of line channel registrations	LineRegistration[] (required)

LineRegistration

Name	Description	Value
channelAccessToken	Access token for the line channel registration	string
channelSecret	Secret for the line channel registration	string

MsTeamsChannel

Name	Description	Value
channelName	The channel name	'MsTeamsChannel' (required)
properties	The set of properties specific to Microsoft Teams channel resource	MsTeamsChannelProperties

MsTeamsChannelProperties

Name	Description	Value
callingWebHook	Webhook for Microsoft Teams channel calls	string
enableCalling	Enable calling for Microsoft Teams channel	bool
isEnabled	Whether this channel is enabled for the bot	bool (required)

SkypeChannel

Name	Description	Value
channelName	The channel name	'SkypeChannel' (required)
properties	The set of properties specific to Skype channel resource	SkypeChannelProperties

SkypeChannelProperties

Name	Description	Value
callingWebHook	Calling web hook for Skype channel	string
enableCalling	Enable calling for Skype channel	bool
enableGroups	Enable groups for Skype channel	bool
enableMediaCards	Enable media cards for Skype channel	bool
enableMessaging	Enable messaging for Skype channel	bool
enableScreenSharing	Enable screen sharing for Skype channel	bool
enableVideo	Enable video for Skype channel	bool
groupsMode	Group mode for Skype channel	string
isEnabled	Whether this channel is enabled for the bot	bool (required)

SlackChannel

Name	Description	Value
channelName	The channel name	'SlackChannel' (required)
properties	The set of properties specific to Slack channel resource	SlackChannelProperties

SlackChannelProperties

Name	Description	Value
clientId	The Slack client id	string
clientSecret	The Slack client secret. Value only returned through POST to the action Channel List API, otherwise empty.	string
isEnabled	Whether this channel is enabled for the bot	bool (required)
landingPageUrl	The Slack landing page Url	string
signingSecret	The Slack signing secret.	string
verificationToken	The Slack verification token. Value only returned through POST to the action Channel List API, otherwise empty.	string

SmsChannel

Name	Description	Value
channelName	The channel name	'SmsChannel' (required)
properties	The set of properties specific to Sms channel resource	SmsChannelProperties

SmsChannelProperties

Name	Description	Value
accountSID	The Sms account SID. Value only returned through POST to the action Channel List API, otherwise empty.	string (required)
authToken	The Sms auth token. Value only returned through POST to the action Channel List API, otherwise empty.	string
isEnabled	Whether this channel is enabled for the bot	bool (required)
isValidated	Whether this channel is validated for the bot	bool
phone	The Sms phone	string (required)

TelegramChannel

Name	Description	Value
channelName	The channel name	'TelegramChannel' (required)
properties	The set of properties specific to Telegram channel resource	TelegramChannelProperties

TelegramChannelProperties

Name	Description	Value
accessToken	The Telegram access token. Value only returned through POST to the action Channel List API, otherwise empty.	string
isEnabled	Whether this channel is enabled for the bot	bool (required)
isValidated	Whether this channel is validated for the bot	bool

WebChatChannel

Name	Description	Value
channelName	The channel name	'WebChatChannel' (required)
properties	The set of properties specific to Web Chat channel resource	WebChatChannelProperties

WebChatChannelProperties

Name	Description	Value
sites	The list of Web Chat sites	WebChatSite[]

WebChatSite

Name	Description	Value
enablePreview	Whether this site is enabled for preview versions of Webchat	bool (required)
isEnabled	Whether this site is enabled for DirectLine channel	bool (required)
siteName	Site name	string (required)

Sku

Name	Description	Value
name	The sku name	'F0' 'S1' (required)

Terraform (AzAPI provider) resource definition

The botServices/channels 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/channels resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.BotService/botServices/channels@2020-06-02"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      channelName = "string"
      // For remaining properties, see Channel objects
    }
    sku = {
      name = "string"
    }
    kind = "string"
    etag = "string"
  })
}

Channel objects

Set the channelName property to specify the type of object.

For AlexaChannel, use:

  channelName = "AlexaChannel"
  properties = {
    alexaSkillId = "string"
    isEnabled = bool
  }

For DirectLineChannel, use:

  channelName = "DirectLineChannel"
  properties = {
    sites = [
      {
        isEnabled = bool
        isSecureSiteEnabled = bool
        isV1Enabled = bool
        isV3Enabled = bool
        siteName = "string"
        trustedOrigins = [
          "string"
        ]
      }
    ]
  }

For DirectLineSpeechChannel, use:

  channelName = "DirectLineSpeechChannel"
  properties = {
    cognitiveServicesSubscriptionId = "string"
    customSpeechModelId = "string"
    customVoiceDeploymentId = "string"
    isDefaultBotForCogSvcAccount = bool
    isEnabled = bool
  }

For EmailChannel, use:

  channelName = "EmailChannel"
  properties = {
    emailAddress = "string"
    isEnabled = bool
    password = "string"
  }

For FacebookChannel, use:

  channelName = "FacebookChannel"
  properties = {
    appId = "string"
    appSecret = "string"
    isEnabled = bool
    pages = [
      {
        accessToken = "string"
        id = "string"
      }
    ]
  }

For KikChannel, use:

  channelName = "KikChannel"
  properties = {
    apiKey = "string"
    isEnabled = bool
    isValidated = bool
    userName = "string"
  }

For LineChannel, use:

  channelName = "LineChannel"
  properties = {
    lineRegistrations = [
      {
        channelAccessToken = "string"
        channelSecret = "string"
      }
    ]
  }

For MsTeamsChannel, use:

  channelName = "MsTeamsChannel"
  properties = {
    callingWebHook = "string"
    enableCalling = bool
    isEnabled = bool
  }

For SkypeChannel, use:

  channelName = "SkypeChannel"
  properties = {
    callingWebHook = "string"
    enableCalling = bool
    enableGroups = bool
    enableMediaCards = bool
    enableMessaging = bool
    enableScreenSharing = bool
    enableVideo = bool
    groupsMode = "string"
    isEnabled = bool
  }

For SlackChannel, use:

  channelName = "SlackChannel"
  properties = {
    clientId = "string"
    clientSecret = "string"
    isEnabled = bool
    landingPageUrl = "string"
    signingSecret = "string"
    verificationToken = "string"
  }

For SmsChannel, use:

  channelName = "SmsChannel"
  properties = {
    accountSID = "string"
    authToken = "string"
    isEnabled = bool
    isValidated = bool
    phone = "string"
  }

For TelegramChannel, use:

  channelName = "TelegramChannel"
  properties = {
    accessToken = "string"
    isEnabled = bool
    isValidated = bool
  }

For WebChatChannel, use:

  channelName = "WebChatChannel"
  properties = {
    sites = [
      {
        enablePreview = bool
        isEnabled = bool
        siteName = "string"
      }
    ]
  }

Property values

botServices/channels

Name	Description	Value
type	The resource type	"Microsoft.BotService/botServices/channels@2020-06-02"
name	The resource name	string (required) Character limit: 2-64 Valid characters: Alphanumerics, underscores, periods, and hyphens. Start with alphanumeric.
location	Specifies the location of the resource.	string
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: botServices
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 channel resource	Channel

Channel

Name	Description	Value
channelName	Set the object type	AlexaChannel DirectLineChannel DirectLineSpeechChannel EmailChannel FacebookChannel KikChannel LineChannel MsTeamsChannel SkypeChannel SlackChannel SmsChannel TelegramChannel WebChatChannel (required)

AlexaChannel

Name	Description	Value
channelName	The channel name	"AlexaChannel" (required)
properties	The set of properties specific to Alexa channel resource	AlexaChannelProperties

AlexaChannelProperties

Name	Description	Value
alexaSkillId	The Alexa skill Id	string (required)
isEnabled	Whether this channel is enabled for the bot	bool (required)

DirectLineChannel

Name	Description	Value
channelName	The channel name	"DirectLineChannel" (required)
properties	The set of properties specific to Direct Line channel resource	DirectLineChannelProperties

DirectLineChannelProperties

Name	Description	Value
sites	The list of Direct Line sites	DirectLineSite[]

DirectLineSite

Name	Description	Value
isEnabled	Whether this site is enabled for DirectLine channel.	bool (required)
isSecureSiteEnabled	Whether this site is enabled for authentication with Bot Framework.	bool
isV1Enabled	Whether this site is enabled for Bot Framework V1 protocol.	bool (required)
isV3Enabled	Whether this site is enabled for Bot Framework V1 protocol.	bool (required)
siteName	Site name	string (required)
trustedOrigins	List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True.	string[]

DirectLineSpeechChannel

Name	Description	Value
channelName	The channel name	"DirectLineSpeechChannel" (required)
properties	The set of properties specific to DirectLine Speech channel resource	DirectLineSpeechChannelProperties

DirectLineSpeechChannelProperties

Name	Description	Value
cognitiveServicesSubscriptionId	The cognitive service subscription ID to use with this channel registration.	string (required)
customSpeechModelId	Custom voice deployment id (optional).	string
customVoiceDeploymentId	Custom speech model id (optional).	string
isDefaultBotForCogSvcAccount	Make this a default bot for chosen cognitive service account.	bool
isEnabled	Whether this channel is enabled or not.	bool

EmailChannel

Name	Description	Value
channelName	The channel name	"EmailChannel" (required)
properties	The set of properties specific to email channel resource	EmailChannelProperties

EmailChannelProperties

Name	Description	Value
emailAddress	The email address	string (required)
isEnabled	Whether this channel is enabled for the bot	bool (required)
password	The password for the email address. Value only returned through POST to the action Channel List API, otherwise empty.	string

FacebookChannel

Name	Description	Value
channelName	The channel name	"FacebookChannel" (required)
properties	The set of properties specific to bot facebook channel	FacebookChannelProperties

FacebookChannelProperties

Name	Description	Value
appId	Facebook application id	string (required)
appSecret	Facebook application secret. Value only returned through POST to the action Channel List API, otherwise empty.	string
isEnabled	Whether this channel is enabled for the bot	bool (required)
pages	The list of Facebook pages	FacebookPage[]

FacebookPage

Name	Description	Value
accessToken	Facebook application access token. Value only returned through POST to the action Channel List API, otherwise empty.	string
id	Page id	string (required)

KikChannel

Name	Description	Value
channelName	The channel name	"KikChannel" (required)
properties	The set of properties specific to Kik channel resource	KikChannelProperties

KikChannelProperties

Name	Description	Value
apiKey	Kik API key. Value only returned through POST to the action Channel List API, otherwise empty.	string
isEnabled	Whether this channel is enabled for the bot	bool (required)
isValidated	Whether this channel is validated for the bot	bool
userName	The Kik user name	string (required)

LineChannel

Name	Description	Value
channelName	The channel name	"LineChannel" (required)
properties	The set of properties specific to line channel resource	LineChannelProperties

LineChannelProperties

Name	Description	Value
lineRegistrations	The list of line channel registrations	LineRegistration[] (required)

LineRegistration

Name	Description	Value
channelAccessToken	Access token for the line channel registration	string
channelSecret	Secret for the line channel registration	string

MsTeamsChannel

Name	Description	Value
channelName	The channel name	"MsTeamsChannel" (required)
properties	The set of properties specific to Microsoft Teams channel resource	MsTeamsChannelProperties

MsTeamsChannelProperties

Name	Description	Value
callingWebHook	Webhook for Microsoft Teams channel calls	string
enableCalling	Enable calling for Microsoft Teams channel	bool
isEnabled	Whether this channel is enabled for the bot	bool (required)

SkypeChannel

Name	Description	Value
channelName	The channel name	"SkypeChannel" (required)
properties	The set of properties specific to Skype channel resource	SkypeChannelProperties

SkypeChannelProperties

Name	Description	Value
callingWebHook	Calling web hook for Skype channel	string
enableCalling	Enable calling for Skype channel	bool
enableGroups	Enable groups for Skype channel	bool
enableMediaCards	Enable media cards for Skype channel	bool
enableMessaging	Enable messaging for Skype channel	bool
enableScreenSharing	Enable screen sharing for Skype channel	bool
enableVideo	Enable video for Skype channel	bool
groupsMode	Group mode for Skype channel	string
isEnabled	Whether this channel is enabled for the bot	bool (required)

SlackChannel

Name	Description	Value
channelName	The channel name	"SlackChannel" (required)
properties	The set of properties specific to Slack channel resource	SlackChannelProperties

SlackChannelProperties

Name	Description	Value
clientId	The Slack client id	string
clientSecret	The Slack client secret. Value only returned through POST to the action Channel List API, otherwise empty.	string
isEnabled	Whether this channel is enabled for the bot	bool (required)
landingPageUrl	The Slack landing page Url	string
signingSecret	The Slack signing secret.	string
verificationToken	The Slack verification token. Value only returned through POST to the action Channel List API, otherwise empty.	string

SmsChannel

Name	Description	Value
channelName	The channel name	"SmsChannel" (required)
properties	The set of properties specific to Sms channel resource	SmsChannelProperties

SmsChannelProperties

Name	Description	Value
accountSID	The Sms account SID. Value only returned through POST to the action Channel List API, otherwise empty.	string (required)
authToken	The Sms auth token. Value only returned through POST to the action Channel List API, otherwise empty.	string
isEnabled	Whether this channel is enabled for the bot	bool (required)
isValidated	Whether this channel is validated for the bot	bool
phone	The Sms phone	string (required)

TelegramChannel

Name	Description	Value
channelName	The channel name	"TelegramChannel" (required)
properties	The set of properties specific to Telegram channel resource	TelegramChannelProperties

TelegramChannelProperties

Name	Description	Value
accessToken	The Telegram access token. Value only returned through POST to the action Channel List API, otherwise empty.	string
isEnabled	Whether this channel is enabled for the bot	bool (required)
isValidated	Whether this channel is validated for the bot	bool

WebChatChannel

Name	Description	Value
channelName	The channel name	"WebChatChannel" (required)
properties	The set of properties specific to Web Chat channel resource	WebChatChannelProperties

WebChatChannelProperties

Name	Description	Value
sites	The list of Web Chat sites	WebChatSite[]

WebChatSite

Name	Description	Value
enablePreview	Whether this site is enabled for preview versions of Webchat	bool (required)
isEnabled	Whether this site is enabled for DirectLine channel	bool (required)
siteName	Site name	string (required)

Sku

Name	Description	Value
name	The sku name	"F0" "S1" (required)

Share via

Microsoft.BotService botServices/channels 2020-06-02

Bicep resource definition

Resource format

Channel objects

Property values

botServices/channels

Channel

AlexaChannel

AlexaChannelProperties

DirectLineChannel

DirectLineChannelProperties

DirectLineSite

DirectLineSpeechChannel

DirectLineSpeechChannelProperties

EmailChannel

EmailChannelProperties

FacebookChannel

FacebookChannelProperties

FacebookPage

KikChannel

KikChannelProperties

LineChannel

LineChannelProperties

LineRegistration

MsTeamsChannel

MsTeamsChannelProperties

SkypeChannel

SkypeChannelProperties

SlackChannel

SlackChannelProperties

SmsChannel

SmsChannelProperties

TelegramChannel

TelegramChannelProperties

WebChatChannel

WebChatChannelProperties

WebChatSite

Sku

ARM template resource definition

Resource format

Channel objects

Property values

botServices/channels

Channel

AlexaChannel

AlexaChannelProperties

DirectLineChannel

DirectLineChannelProperties

DirectLineSite

DirectLineSpeechChannel

DirectLineSpeechChannelProperties

EmailChannel

EmailChannelProperties

FacebookChannel

FacebookChannelProperties

FacebookPage

KikChannel

KikChannelProperties

LineChannel

LineChannelProperties

LineRegistration

MsTeamsChannel

MsTeamsChannelProperties

SkypeChannel

SkypeChannelProperties

SlackChannel

SlackChannelProperties

SmsChannel

SmsChannelProperties

TelegramChannel

TelegramChannelProperties

WebChatChannel

WebChatChannelProperties

WebChatSite

Sku

Terraform (AzAPI provider) resource definition

Resource format

Channel objects

Property values