Microsoft.BotService botServices/channels 2022-09-15

2024-12-09

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@2022-09-15' = {
  parent: resourceSymbolicName
  etag: 'string'
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    etag: 'string'
    location: 'string'
    channelName: 'string'
    // For remaining properties, see Channel objects
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Channel objects

Set the channelName property to specify the type of object.

For AcsChatChannel, use:

{
  channelName: 'AcsChatChannel'
}

For AlexaChannel, use:

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

For DirectLineChannel, use:

{
  channelName: 'DirectLineChannel'
  properties: {
    DirectLineEmbedCode: 'string'
    extensionKey1: 'string'
    extensionKey2: 'string'
    sites: [
      {
        appId: 'string'
        eTag: 'string'
        isBlockUserUploadEnabled: bool
        isDetailedLoggingEnabled: bool
        isEnabled: bool
        isEndpointParametersEnabled: bool
        isNoStorageEnabled: bool
        isSecureSiteEnabled: bool
        isV1Enabled: bool
        isV3Enabled: bool
        isWebchatPreviewEnabled: bool
        isWebChatSpeechEnabled: bool
        siteName: 'string'
        tenantId: 'string'
        trustedOrigins: [
          'string'
        ]
      }
    ]
  }
}

For DirectLineSpeechChannel, use:

{
  channelName: 'DirectLineSpeechChannel'
  properties: {
    cognitiveServiceRegion: 'string'
    cognitiveServiceResourceId: 'string'
    cognitiveServiceSubscriptionKey: 'string'
    customSpeechModelId: 'string'
    customVoiceDeploymentId: 'string'
    isDefaultBotForCogSvcAccount: bool
    isEnabled: bool
  }
}

For EmailChannel, use:

{
  channelName: 'EmailChannel'
  properties: {
    authMethod: int
    emailAddress: 'string'
    isEnabled: bool
    magicCode: 'string'
    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 M365Extensions, use:

{
  channelName: 'M365Extensions'
}

For MsTeamsChannel, use:

{
  channelName: 'MsTeamsChannel'
  properties: {
    acceptedTerms: bool
    callingWebhook: 'string'
    deploymentEnvironment: 'string'
    enableCalling: bool
    incomingCallRoute: 'string'
    isEnabled: bool
  }
}

For Omnichannel, use:

{
  channelName: 'Omnichannel'
}

For OutlookChannel, use:

{
  channelName: 'OutlookChannel'
}

For SearchAssistant, use:

{
  channelName: 'SearchAssistant'
}

For SkypeChannel, use:

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

For SlackChannel, use:

{
  channelName: 'SlackChannel'
  properties: {
    clientId: 'string'
    clientSecret: 'string'
    isEnabled: bool
    landingPageUrl: 'string'
    registerBeforeOAuthFlow: bool
    scopes: '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 TelephonyChannel, use:

{
  channelName: 'TelephonyChannel'
  properties: {
    apiConfigurations: [
      {
        cognitiveServiceRegion: 'string'
        cognitiveServiceResourceId: 'string'
        cognitiveServiceSubscriptionKey: 'string'
        defaultLocale: 'string'
        id: 'string'
        providerName: 'string'
      }
    ]
    cognitiveServiceRegion: 'string'
    cognitiveServiceSubscriptionKey: 'string'
    defaultLocale: 'string'
    isEnabled: bool
    phoneNumbers: [
      {
        acsEndpoint: 'string'
        acsResourceId: 'string'
        acsSecret: 'string'
        cognitiveServiceRegion: 'string'
        cognitiveServiceResourceId: 'string'
        cognitiveServiceSubscriptionKey: 'string'
        defaultLocale: 'string'
        id: 'string'
        offerType: 'string'
        phoneNumber: 'string'
      }
    ]
    premiumSKU: 'string'
  }
}

For WebChatChannel, use:

{
  channelName: 'WebChatChannel'
  properties: {
    sites: [
      {
        appId: 'string'
        eTag: 'string'
        isBlockUserUploadEnabled: bool
        isDetailedLoggingEnabled: bool
        isEnabled: bool
        isEndpointParametersEnabled: bool
        isNoStorageEnabled: bool
        isSecureSiteEnabled: bool
        isV1Enabled: bool
        isV3Enabled: bool
        isWebchatPreviewEnabled: bool
        isWebChatSpeechEnabled: bool
        siteName: 'string'
        tenantId: 'string'
        trustedOrigins: [
          'string'
        ]
      }
    ]
  }
}

Property Values