Microsoft.BotService botServices/canales

Definición de recursos de Bicep

El tipo de recurso botServices/channels se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Ejemplos de uso

Ejemplos de Bicep

Un ejemplo básico de implementación de integración para un canal de bot.

param resourceName string = 'acctest0001'
param location string = 'westus'

resource botService 'Microsoft.BotService/botServices@2021-05-01-preview' = {
  name: resourceName
  location: location
  sku: {
    name: 'F0'
  }
  kind: 'bot'
  properties: {
    cmekKeyVaultUrl: ''
    description: ''
    developerAppInsightKey: ''
    developerAppInsightsApiKey: ''
    developerAppInsightsApplicationId: ''
    displayName: resourceName
    endpoint: ''
    iconUrl: 'https://docs.botframework.com/static/devportal/client/images/bot-framework-default.png'
    isCmekEnabled: false
    isStreamingSupported: false
    msaAppId: '12345678-1234-1234-1234-123456789012'
  }
}

resource channel 'Microsoft.BotService/botServices/channels@2021-05-01-preview' = {
  name: 'AlexaChannel'
  location: location
  parent: botService
  kind: 'bot'
  properties: {
    channelName: 'AlexaChannel'
    properties: {
      alexaSkillId: 'amzn1.ask.skill.19126e57-867f-4553-b953-ad0a720dddec'
      isEnabled: true
    }
  }
}

Formato de recurso

Para crear un recurso Microsoft.BotService/botServices/channels, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.BotService/botServices/channels@2023-09-15-preview' = {
  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'
  }
}

Objetos de canal

Establezca la propiedad channelName para especificar el tipo de objeto.

Para AcsChatChannel, use:

{
  channelName: 'AcsChatChannel'
}

Para AlexaChannel, use:

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

Para 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'
        ]
      }
    ]
  }
}

Para DirectLineSpeechChannel, use:

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

Para EmailChannel, use:

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

Para FacebookChannel, use:

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

Para KikChannel, use:

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

Para LineChannel, use:

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

Para M365Extensions, use:

{
  channelName: 'M365Extensions'
}

Para MsTeamsChannel, use:

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

Para la Plataforma omnicanal, use:

{
  channelName: 'Omnichannel'
}

Para OutlookChannel, use:

{
  channelName: 'OutlookChannel'
}

Para SearchAssistant, use:

{
  channelName: 'SearchAssistant'
}

Para 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
  }
}

Para SlackChannel, use:

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

Para SmsChannel, use:

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

Para TelegramChannel, use:

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

Para 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'
  }
}

Para 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'
        ]
      }
    ]
  }
}

Valores de propiedad

Microsoft.BotService/botServices/channels

Name Description Value
etag Etiqueta de entidad. string
kind Required. Obtiene o establece el tipo del recurso. 'azurebot'
'bot'
'designer'
'function'
'sdk'
location Especifica la ubicación del recurso. string
name El nombre del recurso 'AcsChatChannel'
'AlexaChannel'
'DirectLineChannel'
'DirectLineSpeechChannel'
'EmailChannel'
'FacebookChannel'
'KikChannel'
'LineChannel'
'M365Extensions'
'MsTeamsChannel'
'Omnichannel'
'OutlookChannel'
'SearchAssistant'
'SkypeChannel'
'SlackChannel'
'SmsChannel'
'TelegramChannel'
'TelephonyChannel'
'WebChatChannel' (obligatorio)
parent En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario.

Para obtener más información, consulte recurso secundario fuera del recurso primario.
Nombre simbólico para el recurso de tipo: botServices
properties Conjunto de propiedades específicas del recurso de canal de bot Channel
sku Obtiene o establece la SKU del recurso. Sku
tags Etiquetas de recursos Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas

AcsChatChannel

Name Description Value
channelName Nombre del canal 'AcsChatChannel' (obligatorio)

AlexaChannel

Name Description Value
channelName Nombre del canal 'AlexaChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso del canal alexa AlexaChannelProperties

AlexaChannelProperties

Name Description Value
alexaSkillId Id. de aptitud de Alexa string (obligatorio)
isEnabled Si este canal está habilitado para el bot bool (obligatorio)

Etiquetas de canal de bots

Name Description Value

Channel

Name Description Value
channelName Establézcalo en 'AcsChatChannel' para el tipo AcsChatChannel. Establezca en 'AlexaChannel' para el tipo AlexaChannel. Establézcalo en 'DirectLineChannel' para el tipo DirectLineChannel. Establézcalo en 'DirectLineSpeechChannel' para el tipo DirectLineSpeechChannel. Establézcalo en 'EmailChannel' para el tipo EmailChannel. Establézcalo en 'FacebookChannel' para el tipo FacebookChannel. Establezca en 'KikChannel' para el tipo KikChannel. Establézcalo en 'LineChannel' para el tipo LineChannel. Establézcalo en 'M365Extensions' para el tipo M365Extensions. Establézcalo en 'MsTeamsChannel' para el tipo MsTeamsChannel. Establézcalo en 'Omnicanal' para el tipo Omnicanal. Establézcalo en 'OutlookChannel' para el tipo OutlookChannel. Establézcalo en 'SearchAssistant' para el tipo SearchAssistant. Establezca en 'SkypeChannel' para el tipo SkypeChannel. Establézcalo en 'SlackChannel' para el tipo SlackChannel. Establézcalo en 'SmsChannel' para el tipo SmsChannel. Establezca en 'TelegramChannel' para el tipo TelegramChannel. Establézcalo en 'TelephonyChannel' para el tipo TelephonyChannel. Establézcalo en 'WebChatChannel' para el tipo WebChatChannel. 'AcsChatChannel'
'AlexaChannel'
'DirectLineChannel'
'DirectLineSpeechChannel'
'EmailChannel'
'FacebookChannel'
'KikChannel'
'LineChannel'
'M365Extensions'
'MsTeamsChannel'
'Omnichannel'
'OutlookChannel'
'SearchAssistant'
'SkypeChannel'
'SlackChannel'
'SmsChannel'
'TelegramChannel'
'TelephonyChannel'
'WebChatChannel' (obligatorio)
etag Etiqueta de entidad del recurso string
location Especifica la ubicación del recurso. string

DirectLineChannel

Name Description Value
channelName Nombre del canal 'DirectLineChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso de canal de Direct Line DirectLineChannelProperties

DirectLineChannelProperties

Name Description Value
DirectLineEmbedCode Código de inserción de Direct Line del recurso string
extensionKey1 ExtensionKey1 string
extensionKey2 ExtensionKey2 string
sites Lista de sitios de Direct Line DirectLineSite[]

DirectLineSite

Name Description Value
appId Identificador de la aplicación DirectLine string
eTag Etiqueta de entidad string
isBlockUserUploadEnabled Si este sitio está habilitado para bloquear la carga de usuarios. bool
isDetailedLoggingEnabled Indica si este sitio está deshabilitado para el registro detallado de bool
isEnabled Si este sitio está habilitado para el canal DirectLine bool (obligatorio)
isEndpointParametersEnabled Si este sitio es EndpointParameters habilitado para el canal bool
isNoStorageEnabled Si este sitio de no almacenamiento está deshabilitado el registro detallado para bool
isSecureSiteEnabled Si este sitio está habilitado para la autenticación con Bot Framework. bool
isV1Enabled Si este sitio está habilitado para el protocolo Bot Framework V1. bool
isV3Enabled Si este sitio está habilitado para el protocolo Bot Framework V3. bool
isWebchatPreviewEnabled Si este sitio está habilitado para versiones preliminares de Webchat bool
isWebChatSpeechEnabled Si este sitio está habilitado para Webchat Speech bool
siteName Nombre del sitio string (obligatorio)
tenantId Identificador de inquilino string
trustedOrigins Lista de direcciones URL de origen de confianza para este sitio. Este campo solo es aplicable si isSecureSiteEnabled es True. string[]

DirectLineSpeechChannel

Name Description Value
channelName Nombre del canal 'DirectLineSpeechChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso del canal directLine Speech DirectLineSpeechChannelProperties

DirectLineSpeechChannelProperties

Name Description Value
cognitiveServiceRegion Región de Cognitive Service con este registro de canal. string
cognitiveServiceResourceId Identificador de Cognitive Service con este registro de canal. string
cognitiveServiceSubscriptionKey Clave de suscripción de Cognitive Services que se va a usar con este registro de canal. string

Constraints:
Valor confidencial. Pase como parámetro seguro.
customSpeechModelId Identificador de implementación de voz personalizado (opcional). string
customVoiceDeploymentId Identificador del modelo de voz personalizado (opcional). string
isDefaultBotForCogSvcAccount Convierta este bot en un bot predeterminado para la cuenta de Cognitive Services elegida. bool
isEnabled Si este canal está habilitado o no. bool

EmailChannel

Name Description Value
channelName Nombre del canal 'EmailChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso de canal de correo electrónico EmailChannelProperties

EmailChannelProperties

Name Description Value
authMethod Método de autenticación del canal de correo electrónico. 0 Contraseña (valor predeterminado); 1 Gráfico. int
emailAddress La dirección de correo electrónico string (obligatorio)
isEnabled Si este canal está habilitado para el bot bool (obligatorio)
magicCode El código mágico para configurar la autenticación moderna. string
password Contraseña de la dirección de correo electrónico. El valor solo se devuelve a través de POST a la API de lista de canales de acción; de lo contrario, está vacío. string

FacebookChannel

Name Description Value
channelName Nombre del canal 'FacebookChannel' (obligatorio)
properties Conjunto de propiedades específicas del canal de Facebook del bot FacebookChannelProperties

FacebookChannelProperties

Name Description Value
appId Id. de aplicación de Facebook string (obligatorio)
appSecret Secreto de aplicación de Facebook. El valor solo se devuelve a través de POST a la API de lista de canales de acción; de lo contrario, está vacío. string

Constraints:
Valor confidencial. Pase como parámetro seguro.
isEnabled Si este canal está habilitado para el bot bool (obligatorio)
pages Lista de páginas de Facebook FacebookPage[]

FacebookPage

Name Description Value
accessToken Token de acceso de la aplicación de Facebook. El valor solo se devuelve a través de POST a la API de lista de canales de acción; de lo contrario, está vacío. string

Constraints:
Valor confidencial. Pase como parámetro seguro.
id Id. de página string (obligatorio)

KikChannel

Name Description Value
channelName Nombre del canal 'KikChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso del canal Kik KikChannelProperties

KikChannelProperties

Name Description Value
apiKey Clave de API de Kik. El valor solo se devuelve a través de POST a la API de lista de canales de acción; de lo contrario, está vacío. string
isEnabled Si este canal está habilitado para el bot bool (obligatorio)
isValidated Si este canal se valida para el bot bool
userName El nombre de usuario de Kik string (obligatorio)

LineChannel

Name Description Value
channelName Nombre del canal 'LineChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso de canal de línea LineChannelProperties

LineChannelProperties

Name Description Value
lineRegistrations Lista de registros de canales de línea LineRegistration[] (obligatorio)

LineRegistration

Name Description Value
channelAccessToken Token de acceso para el registro del canal de línea string

Constraints:
Valor confidencial. Pase como parámetro seguro.
channelSecret Secreto para el registro del canal de línea string

Constraints:
Valor confidencial. Pase como parámetro seguro.

M365Extensions

Name Description Value
channelName Nombre del canal 'M365Extensions' (obligatorio)

MsTeamsChannel

Name Description Value
channelName Nombre del canal 'MsTeamsChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso de canal de Microsoft Teams MsTeamsChannelProperties

MsTeamsChannelProperties

Name Description Value
acceptedTerms Si este canal aceptó términos bool
callingWebhook Webhook para llamadas de canal de Microsoft Teams string
deploymentEnvironment Entorno de implementación para llamadas de canal de Microsoft Teams string
enableCalling Habilitación de llamadas para el canal de Microsoft Teams bool
incomingCallRoute Webhook para llamadas de canal de Microsoft Teams string
isEnabled Si este canal está habilitado para el bot bool (obligatorio)

Omnichannel

Name Description Value
channelName Nombre del canal "Omnicanal" (obligatorio)

OutlookChannel

Name Description Value
channelName Nombre del canal 'OutlookChannel' (obligatorio)

SearchAssistant

Name Description Value
channelName Nombre del canal 'SearchAssistant' (obligatorio)

Sku

Name Description Value
name El nombre de la SKU 'F0'
'S1' (obligatorio)

SkypeChannel

Name Description Value
channelName Nombre del canal 'SkypeChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso del canal de Skype SkypeChannelProperties

SkypeChannelProperties

Name Description Value
callingWebHook Llamada a web hook para el canal de Skype string
enableCalling Habilitación de llamadas para el canal de Skype bool
enableGroups Habilitar grupos para el canal de Skype bool
enableMediaCards Habilitar tarjetas multimedia para el canal de Skype bool
enableMessaging Habilitación de la mensajería para el canal de Skype bool
enableScreenSharing Habilitar el uso compartido de pantalla para el canal de Skype bool
enableVideo Habilitar vídeo para el canal de Skype bool
groupsMode Modo de grupo para el canal de Skype string
incomingCallRoute Ruta de llamada entrante para el canal de Skype string
isEnabled Si este canal está habilitado para el bot bool (obligatorio)

SlackChannel

Name Description Value
channelName Nombre del canal 'SlackChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso de canal de Slack SlackChannelProperties

SlackChannelProperties

Name Description Value
clientId Identificador de cliente de Slack string
clientSecret Secreto de cliente de Slack. El valor solo se devuelve a través de POST a la API de lista de canales de acción; de lo contrario, está vacío. string

Constraints:
Valor confidencial. Pase como parámetro seguro.
isEnabled Si este canal está habilitado para el bot bool (obligatorio)
landingPageUrl Dirección URL de la página de aterrizaje de Slack string
registerBeforeOAuthFlow Indica si se va a registrar la configuración antes de que se realice la validación de OAuth. Se recomienda en True. bool
scopes Ámbitos de permisos de Slack. string
signingSecret Secreto de firma de Slack. string

Constraints:
Valor confidencial. Pase como parámetro seguro.
verificationToken Token de comprobación de Slack. El valor solo se devuelve a través de POST a la API de lista de canales de acción; de lo contrario, está vacío. string

Constraints:
Valor confidencial. Pase como parámetro seguro.

SmsChannel

Name Description Value
channelName Nombre del canal 'SmsChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso de canal sms SmsChannelProperties

SmsChannelProperties

Name Description Value
accountSID El SID de la cuenta sms. El valor solo se devuelve a través de POST a la API de lista de canales de acción; de lo contrario, está vacío. string (obligatorio)
authToken Token de autenticación sms. El valor solo se devuelve a través de POST a la API de lista de canales de acción; de lo contrario, está vacío. string

Constraints:
Valor confidencial. Pase como parámetro seguro.
isEnabled Si este canal está habilitado para el bot bool (obligatorio)
isValidated Si este canal se valida para el bot bool
phone El teléfono Sms string (obligatorio)

TelegramChannel

Name Description Value
channelName Nombre del canal 'TelegramChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso del canal de Telegram TelegramChannelProperties

TelegramChannelProperties

Name Description Value
accessToken Token de acceso de Telegram. El valor solo se devuelve a través de POST a la API de lista de canales de acción; de lo contrario, está vacío. string

Constraints:
Valor confidencial. Pase como parámetro seguro.
isEnabled Si este canal está habilitado para el bot bool (obligatorio)
isValidated Si este canal se valida para el bot bool

TelephonyChannel

Name Description Value
channelName Nombre del canal 'TelephonyChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso de canal de telefonía TelephonyChannelProperties

TelephonyChannelProperties

Name Description Value
apiConfigurations Lista de la configuración de la API de telefonía TelephonyChannelResourceApiConfiguration[]
cognitiveServiceRegion ExtensionKey2 string
cognitiveServiceSubscriptionKey ExtensionKey1 string
defaultLocale Configuración regional predeterminada del canal string
isEnabled Si el canal está habilitado bool
phoneNumbers Lista de números de teléfono de telefonía TelephonyPhoneNumbers[]
premiumSKU SKU premium aplicada al canal string

TelephonyChannelResourceApiConfiguration

Name Description Value
cognitiveServiceRegion Región del servicio cognitivo. string
cognitiveServiceResourceId ResourceId de Cognitive Service. string
cognitiveServiceSubscriptionKey Clave de suscripción de Cognitive Services. string
defaultLocale Configuración regional predeterminada. string
id Identificador de la configuración. string
providerName Nombre del proveedor. string

TelephonyPhoneNumbers

Name Description Value
acsEndpoint Punto de conexión de ACS. string
acsResourceId Identificador de recurso de ACS. string
acsSecret Secreto de ACS. string
cognitiveServiceRegion La región de servicio del servicio cognitivo. string
cognitiveServiceResourceId Identificador de recurso de Cognitive Service. string
cognitiveServiceSubscriptionKey Clave de suscripción de Cognitive Service. string
defaultLocale Configuración regional predeterminada del número de teléfono. string
id Identificador del elemento. string
offerType Propiedad opcional que determinará el tipo de oferta del teléfono. string
phoneNumber Número de teléfono. string

WebChatChannel

Name Description Value
channelName Nombre del canal 'WebChatChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso del canal de chat en web WebChatChannelProperties

WebChatChannelProperties

Name Description Value
sites Lista de sitios de chat web WebChatSite[]

WebChatSite

Name Description Value
appId Identificador de la aplicación DirectLine string
eTag Etiqueta de entidad string
isBlockUserUploadEnabled Si este sitio está habilitado para bloquear la carga de usuarios. bool
isDetailedLoggingEnabled Indica si este sitio está deshabilitado para el registro detallado de bool
isEnabled Si este sitio está habilitado para el canal DirectLine bool (obligatorio)
isEndpointParametersEnabled Si este sitio es EndpointParameters habilitado para el canal bool
isNoStorageEnabled Si este sitio de no almacenamiento está deshabilitado el registro detallado para bool
isSecureSiteEnabled Si este sitio está habilitado para la autenticación con Bot Framework. bool
isV1Enabled Si este sitio está habilitado para el protocolo Bot Framework V1. bool
isV3Enabled Si este sitio está habilitado para el protocolo Bot Framework V3. bool
isWebchatPreviewEnabled Si este sitio está habilitado para versiones preliminares de Webchat bool
isWebChatSpeechEnabled Si este sitio está habilitado para Webchat Speech bool
siteName Nombre del sitio string (obligatorio)
tenantId Identificador de inquilino string
trustedOrigins Lista de direcciones URL de origen de confianza para este sitio. Este campo solo es aplicable si isSecureSiteEnabled es True. string[]

Definición de recursos de plantilla de ARM

El tipo de recurso botServices/channels se puede implementar con operaciones destinadas a:

Ejemplos de uso

Formato de recurso

Para crear un recurso Microsoft.BotService/botServices/channels, agregue el siguiente JSON a la plantilla.

{
  "type": "Microsoft.BotService/botServices/channels",
  "apiVersion": "2023-09-15-preview",
  "name": "string",
  "etag": "string",
  "kind": "string",
  "location": "string",
  "properties": {
    "etag": "string",
    "location": "string",
    "channelName": "string"
    // For remaining properties, see Channel objects
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Objetos de canal

Establezca la propiedad channelName para especificar el tipo de objeto.

Para AcsChatChannel, use:

{
  "channelName": "AcsChatChannel"
}

Para AlexaChannel, use:

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

Para 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" ]
      }
    ]
  }
}

Para DirectLineSpeechChannel, use:

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

Para EmailChannel, use:

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

Para FacebookChannel, use:

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

Para KikChannel, use:

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

Para LineChannel, use:

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

Para M365Extensions, use:

{
  "channelName": "M365Extensions"
}

Para MsTeamsChannel, use:

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

Para la Plataforma omnicanal, use:

{
  "channelName": "Omnichannel"
}

Para OutlookChannel, use:

{
  "channelName": "OutlookChannel"
}

Para SearchAssistant, use:

{
  "channelName": "SearchAssistant"
}

Para 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"
  }
}

Para SlackChannel, use:

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

Para SmsChannel, use:

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

Para TelegramChannel, use:

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

Para 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"
  }
}

Para 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" ]
      }
    ]
  }
}

Valores de propiedad

Microsoft.BotService/botServices/channels

Name Description Value
apiVersion La versión de api '2023-09-15-preview'
etag Etiqueta de entidad. string
kind Required. Obtiene o establece el tipo del recurso. 'azurebot'
'bot'
'designer'
'function'
'sdk'
location Especifica la ubicación del recurso. string
name El nombre del recurso 'AcsChatChannel'
'AlexaChannel'
'DirectLineChannel'
'DirectLineSpeechChannel'
'EmailChannel'
'FacebookChannel'
'KikChannel'
'LineChannel'
'M365Extensions'
'MsTeamsChannel'
'Omnichannel'
'OutlookChannel'
'SearchAssistant'
'SkypeChannel'
'SlackChannel'
'SmsChannel'
'TelegramChannel'
'TelephonyChannel'
'WebChatChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso de canal de bot Channel
sku Obtiene o establece la SKU del recurso. Sku
tags Etiquetas de recursos Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
type El tipo de recurso 'Microsoft.BotService/botServices/channels'

AcsChatChannel

Name Description Value
channelName Nombre del canal 'AcsChatChannel' (obligatorio)

AlexaChannel

Name Description Value
channelName Nombre del canal 'AlexaChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso del canal alexa AlexaChannelProperties

AlexaChannelProperties

Name Description Value
alexaSkillId Id. de aptitud de Alexa string (obligatorio)
isEnabled Si este canal está habilitado para el bot bool (obligatorio)

Etiquetas de canal de bots

Name Description Value

Channel

Name Description Value
channelName Establézcalo en 'AcsChatChannel' para el tipo AcsChatChannel. Establezca en 'AlexaChannel' para el tipo AlexaChannel. Establézcalo en 'DirectLineChannel' para el tipo DirectLineChannel. Establézcalo en 'DirectLineSpeechChannel' para el tipo DirectLineSpeechChannel. Establézcalo en 'EmailChannel' para el tipo EmailChannel. Establézcalo en 'FacebookChannel' para el tipo FacebookChannel. Establezca en 'KikChannel' para el tipo KikChannel. Establézcalo en 'LineChannel' para el tipo LineChannel. Establézcalo en 'M365Extensions' para el tipo M365Extensions. Establézcalo en 'MsTeamsChannel' para el tipo MsTeamsChannel. Establézcalo en 'Omnicanal' para el tipo Omnicanal. Establézcalo en 'OutlookChannel' para el tipo OutlookChannel. Establézcalo en 'SearchAssistant' para el tipo SearchAssistant. Establezca en 'SkypeChannel' para el tipo SkypeChannel. Establézcalo en 'SlackChannel' para el tipo SlackChannel. Establézcalo en 'SmsChannel' para el tipo SmsChannel. Establezca en 'TelegramChannel' para el tipo TelegramChannel. Establézcalo en 'TelephonyChannel' para el tipo TelephonyChannel. Establézcalo en 'WebChatChannel' para el tipo WebChatChannel. 'AcsChatChannel'
'AlexaChannel'
'DirectLineChannel'
'DirectLineSpeechChannel'
'EmailChannel'
'FacebookChannel'
'KikChannel'
'LineChannel'
'M365Extensions'
'MsTeamsChannel'
'Omnichannel'
'OutlookChannel'
'SearchAssistant'
'SkypeChannel'
'SlackChannel'
'SmsChannel'
'TelegramChannel'
'TelephonyChannel'
'WebChatChannel' (obligatorio)
etag Etiqueta de entidad del recurso string
location Especifica la ubicación del recurso. string

DirectLineChannel

Name Description Value
channelName Nombre del canal 'DirectLineChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso de canal de Direct Line DirectLineChannelProperties

DirectLineChannelProperties

Name Description Value
DirectLineEmbedCode Código de inserción de Direct Line del recurso string
extensionKey1 ExtensionKey1 string
extensionKey2 ExtensionKey2 string
sites Lista de sitios de Direct Line DirectLineSite[]

DirectLineSite

Name Description Value
appId Identificador de la aplicación DirectLine string
eTag Etiqueta de entidad string
isBlockUserUploadEnabled Si este sitio está habilitado para bloquear la carga de usuarios. bool
isDetailedLoggingEnabled Indica si este sitio está deshabilitado para el registro detallado de bool
isEnabled Si este sitio está habilitado para el canal DirectLine bool (obligatorio)
isEndpointParametersEnabled Si este sitio es EndpointParameters habilitado para el canal bool
isNoStorageEnabled Si este sitio de no almacenamiento está deshabilitado el registro detallado para bool
isSecureSiteEnabled Si este sitio está habilitado para la autenticación con Bot Framework. bool
isV1Enabled Si este sitio está habilitado para el protocolo Bot Framework V1. bool
isV3Enabled Si este sitio está habilitado para el protocolo Bot Framework V3. bool
isWebchatPreviewEnabled Si este sitio está habilitado para versiones preliminares de Webchat bool
isWebChatSpeechEnabled Si este sitio está habilitado para Webchat Speech bool
siteName Nombre del sitio string (obligatorio)
tenantId Identificador de inquilino string
trustedOrigins Lista de direcciones URL de origen de confianza para este sitio. Este campo solo es aplicable si isSecureSiteEnabled es True. string[]

DirectLineSpeechChannel

Name Description Value
channelName Nombre del canal 'DirectLineSpeechChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso del canal directLine Speech DirectLineSpeechChannelProperties

DirectLineSpeechChannelProperties

Name Description Value
cognitiveServiceRegion Región de Cognitive Service con este registro de canal. string
cognitiveServiceResourceId Identificador de Cognitive Service con este registro de canal. string
cognitiveServiceSubscriptionKey Clave de suscripción de Cognitive Services que se va a usar con este registro de canal. string

Constraints:
Valor confidencial. Pase como parámetro seguro.
customSpeechModelId Identificador de implementación de voz personalizado (opcional). string
customVoiceDeploymentId Identificador del modelo de voz personalizado (opcional). string
isDefaultBotForCogSvcAccount Convierta este bot en un bot predeterminado para la cuenta de Cognitive Services elegida. bool
isEnabled Si este canal está habilitado o no. bool

EmailChannel

Name Description Value
channelName Nombre del canal 'EmailChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso de canal de correo electrónico EmailChannelProperties

EmailChannelProperties

Name Description Value
authMethod Método de autenticación del canal de correo electrónico. 0 Contraseña (valor predeterminado); 1 Gráfico. int
emailAddress La dirección de correo electrónico string (obligatorio)
isEnabled Si este canal está habilitado para el bot bool (obligatorio)
magicCode El código mágico para configurar la autenticación moderna. string
password Contraseña de la dirección de correo electrónico. El valor solo se devuelve a través de POST a la API de lista de canales de acción; de lo contrario, está vacío. string

FacebookChannel

Name Description Value
channelName Nombre del canal 'FacebookChannel' (obligatorio)
properties Conjunto de propiedades específicas del canal de Facebook del bot FacebookChannelProperties

FacebookChannelProperties

Name Description Value
appId Id. de aplicación de Facebook string (obligatorio)
appSecret Secreto de aplicación de Facebook. El valor solo se devuelve a través de POST a la API de lista de canales de acción; de lo contrario, está vacío. string

Constraints:
Valor confidencial. Pase como parámetro seguro.
isEnabled Si este canal está habilitado para el bot bool (obligatorio)
pages Lista de páginas de Facebook FacebookPage[]

FacebookPage

Name Description Value
accessToken Token de acceso de la aplicación de Facebook. El valor solo se devuelve a través de POST a la API de lista de canales de acción; de lo contrario, está vacío. string

Constraints:
Valor confidencial. Pase como parámetro seguro.
id Id. de página string (obligatorio)

KikChannel

Name Description Value
channelName Nombre del canal 'KikChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso del canal Kik KikChannelProperties

KikChannelProperties

Name Description Value
apiKey Clave de API de Kik. El valor solo se devuelve a través de POST a la API de lista de canales de acción; de lo contrario, está vacío. string
isEnabled Si este canal está habilitado para el bot bool (obligatorio)
isValidated Si este canal se valida para el bot bool
userName El nombre de usuario de Kik string (obligatorio)

LineChannel

Name Description Value
channelName Nombre del canal 'LineChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso de canal de línea LineChannelProperties

LineChannelProperties

Name Description Value
lineRegistrations Lista de registros de canales de línea LineRegistration[] (obligatorio)

LineRegistration

Name Description Value
channelAccessToken Token de acceso para el registro del canal de línea string

Constraints:
Valor confidencial. Pase como parámetro seguro.
channelSecret Secreto para el registro del canal de línea string

Constraints:
Valor confidencial. Pase como parámetro seguro.

M365Extensions

Name Description Value
channelName Nombre del canal 'M365Extensions' (obligatorio)

MsTeamsChannel

Name Description Value
channelName Nombre del canal 'MsTeamsChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso de canal de Microsoft Teams MsTeamsChannelProperties

MsTeamsChannelProperties

Name Description Value
acceptedTerms Si este canal aceptó términos bool
callingWebhook Webhook para llamadas de canal de Microsoft Teams string
deploymentEnvironment Entorno de implementación para llamadas de canal de Microsoft Teams string
enableCalling Habilitación de llamadas para el canal de Microsoft Teams bool
incomingCallRoute Webhook para llamadas de canal de Microsoft Teams string
isEnabled Si este canal está habilitado para el bot bool (obligatorio)

Omnichannel

Name Description Value
channelName Nombre del canal "Omnicanal" (obligatorio)

OutlookChannel

Name Description Value
channelName Nombre del canal 'OutlookChannel' (obligatorio)

SearchAssistant

Name Description Value
channelName Nombre del canal 'SearchAssistant' (obligatorio)

Sku

Name Description Value
name El nombre de la SKU 'F0'
'S1' (obligatorio)

SkypeChannel

Name Description Value
channelName Nombre del canal 'SkypeChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso del canal de Skype SkypeChannelProperties

SkypeChannelProperties

Name Description Value
callingWebHook Llamada a web hook para el canal de Skype string
enableCalling Habilitación de llamadas para el canal de Skype bool
enableGroups Habilitar grupos para el canal de Skype bool
enableMediaCards Habilitar tarjetas multimedia para el canal de Skype bool
enableMessaging Habilitación de la mensajería para el canal de Skype bool
enableScreenSharing Habilitar el uso compartido de pantalla para el canal de Skype bool
enableVideo Habilitar vídeo para el canal de Skype bool
groupsMode Modo de grupo para el canal de Skype string
incomingCallRoute Ruta de llamada entrante para el canal de Skype string
isEnabled Si este canal está habilitado para el bot bool (obligatorio)

SlackChannel

Name Description Value
channelName Nombre del canal 'SlackChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso de canal de Slack SlackChannelProperties

SlackChannelProperties

Name Description Value
clientId Identificador de cliente de Slack string
clientSecret Secreto de cliente de Slack. El valor solo se devuelve a través de POST a la API de lista de canales de acción; de lo contrario, está vacío. string

Constraints:
Valor confidencial. Pase como parámetro seguro.
isEnabled Si este canal está habilitado para el bot bool (obligatorio)
landingPageUrl Dirección URL de la página de aterrizaje de Slack string
registerBeforeOAuthFlow Indica si se va a registrar la configuración antes de que se realice la validación de OAuth. Se recomienda en True. bool
scopes Ámbitos de permisos de Slack. string
signingSecret Secreto de firma de Slack. string

Constraints:
Valor confidencial. Pase como parámetro seguro.
verificationToken Token de comprobación de Slack. El valor solo se devuelve a través de POST a la API de lista de canales de acción; de lo contrario, está vacío. string

Constraints:
Valor confidencial. Pase como parámetro seguro.

SmsChannel

Name Description Value
channelName Nombre del canal 'SmsChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso de canal sms SmsChannelProperties

SmsChannelProperties

Name Description Value
accountSID El SID de la cuenta sms. El valor solo se devuelve a través de POST a la API de lista de canales de acción; de lo contrario, está vacío. string (obligatorio)
authToken Token de autenticación sms. El valor solo se devuelve a través de POST a la API de lista de canales de acción; de lo contrario, está vacío. string

Constraints:
Valor confidencial. Pase como parámetro seguro.
isEnabled Si este canal está habilitado para el bot bool (obligatorio)
isValidated Si este canal se valida para el bot bool
phone El teléfono Sms string (obligatorio)

TelegramChannel

Name Description Value
channelName Nombre del canal 'TelegramChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso del canal de Telegram TelegramChannelProperties

TelegramChannelProperties

Name Description Value
accessToken Token de acceso de Telegram. El valor solo se devuelve a través de POST a la API de lista de canales de acción; de lo contrario, está vacío. string

Constraints:
Valor confidencial. Pase como parámetro seguro.
isEnabled Si este canal está habilitado para el bot bool (obligatorio)
isValidated Si este canal se valida para el bot bool

TelephonyChannel

Name Description Value
channelName Nombre del canal 'TelephonyChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso de canal de telefonía TelephonyChannelProperties

TelephonyChannelProperties

Name Description Value
apiConfigurations Lista de la configuración de la API de telefonía TelephonyChannelResourceApiConfiguration[]
cognitiveServiceRegion ExtensionKey2 string
cognitiveServiceSubscriptionKey ExtensionKey1 string
defaultLocale Configuración regional predeterminada del canal string
isEnabled Si el canal está habilitado bool
phoneNumbers Lista de números de teléfono de telefonía TelephonyPhoneNumbers[]
premiumSKU SKU premium aplicada al canal string

TelephonyChannelResourceApiConfiguration

Name Description Value
cognitiveServiceRegion Región del servicio cognitivo. string
cognitiveServiceResourceId ResourceId de Cognitive Service. string
cognitiveServiceSubscriptionKey Clave de suscripción de Cognitive Services. string
defaultLocale Configuración regional predeterminada. string
id Identificador de la configuración. string
providerName Nombre del proveedor. string

TelephonyPhoneNumbers

Name Description Value
acsEndpoint Punto de conexión de ACS. string
acsResourceId Identificador de recurso de ACS. string
acsSecret Secreto de ACS. string
cognitiveServiceRegion La región de servicio del servicio cognitivo. string
cognitiveServiceResourceId Identificador de recurso de Cognitive Service. string
cognitiveServiceSubscriptionKey Clave de suscripción de Cognitive Service. string
defaultLocale Configuración regional predeterminada del número de teléfono. string
id Identificador del elemento. string
offerType Propiedad opcional que determinará el tipo de oferta del teléfono. string
phoneNumber Número de teléfono. string

WebChatChannel

Name Description Value
channelName Nombre del canal 'WebChatChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso del canal de chat en web WebChatChannelProperties

WebChatChannelProperties

Name Description Value
sites Lista de sitios de chat web WebChatSite[]

WebChatSite

Name Description Value
appId Identificador de la aplicación DirectLine string
eTag Etiqueta de entidad string
isBlockUserUploadEnabled Si este sitio está habilitado para bloquear la carga de usuarios. bool
isDetailedLoggingEnabled Indica si este sitio está deshabilitado para el registro detallado de bool
isEnabled Si este sitio está habilitado para el canal DirectLine bool (obligatorio)
isEndpointParametersEnabled Si este sitio es EndpointParameters habilitado para el canal bool
isNoStorageEnabled Si este sitio de no almacenamiento está deshabilitado el registro detallado para bool
isSecureSiteEnabled Si este sitio está habilitado para la autenticación con Bot Framework. bool
isV1Enabled Si este sitio está habilitado para el protocolo Bot Framework V1. bool
isV3Enabled Si este sitio está habilitado para el protocolo Bot Framework V3. bool
isWebchatPreviewEnabled Si este sitio está habilitado para versiones preliminares de Webchat bool
isWebChatSpeechEnabled Si este sitio está habilitado para Webchat Speech bool
siteName Nombre del sitio string (obligatorio)
tenantId Identificador de inquilino string
trustedOrigins Lista de direcciones URL de origen de confianza para este sitio. Este campo solo es aplicable si isSecureSiteEnabled es True. string[]

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso botServices/channels se puede implementar con operaciones destinadas a:

  • Grupos de recursos Para una lista de propiedades modificadas en cada versión de la API, consulte registro de cambios.

Ejemplos de uso

Ejemplos de Terraform

Un ejemplo básico de implementación de integración para un canal de bot.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westus"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "botService" {
  type      = "Microsoft.BotService/botServices@2021-05-01-preview"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "bot"
    properties = {
      cmekKeyVaultUrl                   = ""
      description                       = ""
      developerAppInsightKey            = ""
      developerAppInsightsApiKey        = ""
      developerAppInsightsApplicationId = ""
      displayName                       = var.resource_name
      endpoint                          = ""
      iconUrl                           = "https://docs.botframework.com/static/devportal/client/images/bot-framework-default.png"
      isCmekEnabled                     = false
      isStreamingSupported              = false
      msaAppId                          = "12345678-1234-1234-1234-123456789012"
    }
    sku = {
      name = "F0"
    }
  }
  tags = {
    environment = "production"
  }
}

resource "azapi_resource" "channel" {
  type      = "Microsoft.BotService/botServices/channels@2021-05-01-preview"
  parent_id = azapi_resource.botService.id
  name      = "AlexaChannel"
  location  = var.location
  body = {
    kind = "bot"
    properties = {
      channelName = "AlexaChannel"
      properties = {
        alexaSkillId = "amzn1.ask.skill.19126e57-867f-4553-b953-ad0a720dddec"
        isEnabled    = true
      }
    }
  }
}

Formato de recurso

Para crear un recurso Microsoft.BotService/botServices/channels, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.BotService/botServices/channels@2023-09-15-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    etag = "string"
    kind = "string"
    properties = {
      etag = "string"
      location = "string"
      channelName = "string"
      // For remaining properties, see Channel objects
    }
    sku = {
      name = "string"
    }
  }
}

Objetos de canal

Establezca la propiedad channelName para especificar el tipo de objeto.

Para AcsChatChannel, use:

{
  channelName = "AcsChatChannel"
}

Para AlexaChannel, use:

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

Para 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"
        ]
      }
    ]
  }
}

Para DirectLineSpeechChannel, use:

{
  channelName = "DirectLineSpeechChannel"
  properties = {
    cognitiveServiceRegion = "string"
    cognitiveServiceResourceId = "string"
    cognitiveServiceSubscriptionKey = "string"
    customSpeechModelId = "string"
    customVoiceDeploymentId = "string"
    isDefaultBotForCogSvcAccount = bool
    isEnabled = bool
  }
}

Para EmailChannel, use:

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

Para FacebookChannel, use:

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

Para KikChannel, use:

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

Para LineChannel, use:

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

Para M365Extensions, use:

{
  channelName = "M365Extensions"
}

Para MsTeamsChannel, use:

{
  channelName = "MsTeamsChannel"
  properties = {
    acceptedTerms = bool
    callingWebhook = "string"
    deploymentEnvironment = "string"
    enableCalling = bool
    incomingCallRoute = "string"
    isEnabled = bool
  }
}

Para la Plataforma omnicanal, use:

{
  channelName = "Omnichannel"
}

Para OutlookChannel, use:

{
  channelName = "OutlookChannel"
}

Para SearchAssistant, use:

{
  channelName = "SearchAssistant"
}

Para 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
  }
}

Para SlackChannel, use:

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

Para SmsChannel, use:

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

Para TelegramChannel, use:

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

Para 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"
  }
}

Para 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"
        ]
      }
    ]
  }
}

Valores de propiedad

Microsoft.BotService/botServices/channels

Name Description Value
etag Etiqueta de entidad. string
kind Required. Obtiene o establece el tipo del recurso. 'azurebot'
'bot'
'designer'
'function'
'sdk'
location Especifica la ubicación del recurso. string
name El nombre del recurso 'AcsChatChannel'
'AlexaChannel'
'DirectLineChannel'
'DirectLineSpeechChannel'
'EmailChannel'
'FacebookChannel'
'KikChannel'
'LineChannel'
'M365Extensions'
'MsTeamsChannel'
'Omnichannel'
'OutlookChannel'
'SearchAssistant'
'SkypeChannel'
'SlackChannel'
'SmsChannel'
'TelegramChannel'
'TelephonyChannel'
'WebChatChannel' (obligatorio)
parent_id Identificador del recurso que es el elemento primario de este recurso. ID para el recurso de tipo: botServices
properties Conjunto de propiedades específicas del recurso de canal de bot Channel
sku Obtiene o establece la SKU del recurso. Sku
tags Etiquetas de recursos Diccionario de nombres y valores de etiqueta.
type El tipo de recurso "Microsoft.BotService/botServices/channels@2023-09-15-preview"

AcsChatChannel

Name Description Value
channelName Nombre del canal 'AcsChatChannel' (obligatorio)

AlexaChannel

Name Description Value
channelName Nombre del canal 'AlexaChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso del canal alexa AlexaChannelProperties

AlexaChannelProperties

Name Description Value
alexaSkillId Id. de aptitud de Alexa string (obligatorio)
isEnabled Si este canal está habilitado para el bot bool (obligatorio)

Etiquetas de canal de bots

Name Description Value

Channel

Name Description Value
channelName Establézcalo en 'AcsChatChannel' para el tipo AcsChatChannel. Establezca en 'AlexaChannel' para el tipo AlexaChannel. Establézcalo en 'DirectLineChannel' para el tipo DirectLineChannel. Establézcalo en 'DirectLineSpeechChannel' para el tipo DirectLineSpeechChannel. Establézcalo en 'EmailChannel' para el tipo EmailChannel. Establézcalo en 'FacebookChannel' para el tipo FacebookChannel. Establezca en 'KikChannel' para el tipo KikChannel. Establézcalo en 'LineChannel' para el tipo LineChannel. Establézcalo en 'M365Extensions' para el tipo M365Extensions. Establézcalo en 'MsTeamsChannel' para el tipo MsTeamsChannel. Establézcalo en 'Omnicanal' para el tipo Omnicanal. Establézcalo en 'OutlookChannel' para el tipo OutlookChannel. Establézcalo en 'SearchAssistant' para el tipo SearchAssistant. Establezca en 'SkypeChannel' para el tipo SkypeChannel. Establézcalo en 'SlackChannel' para el tipo SlackChannel. Establézcalo en 'SmsChannel' para el tipo SmsChannel. Establezca en 'TelegramChannel' para el tipo TelegramChannel. Establézcalo en 'TelephonyChannel' para el tipo TelephonyChannel. Establézcalo en 'WebChatChannel' para el tipo WebChatChannel. 'AcsChatChannel'
'AlexaChannel'
'DirectLineChannel'
'DirectLineSpeechChannel'
'EmailChannel'
'FacebookChannel'
'KikChannel'
'LineChannel'
'M365Extensions'
'MsTeamsChannel'
'Omnichannel'
'OutlookChannel'
'SearchAssistant'
'SkypeChannel'
'SlackChannel'
'SmsChannel'
'TelegramChannel'
'TelephonyChannel'
'WebChatChannel' (obligatorio)
etag Etiqueta de entidad del recurso string
location Especifica la ubicación del recurso. string

DirectLineChannel

Name Description Value
channelName Nombre del canal 'DirectLineChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso de canal de Direct Line DirectLineChannelProperties

DirectLineChannelProperties

Name Description Value
DirectLineEmbedCode Código de inserción de Direct Line del recurso string
extensionKey1 ExtensionKey1 string
extensionKey2 ExtensionKey2 string
sites Lista de sitios de Direct Line DirectLineSite[]

DirectLineSite

Name Description Value
appId Identificador de la aplicación DirectLine string
eTag Etiqueta de entidad string
isBlockUserUploadEnabled Si este sitio está habilitado para bloquear la carga de usuarios. bool
isDetailedLoggingEnabled Indica si este sitio está deshabilitado para el registro detallado de bool
isEnabled Si este sitio está habilitado para el canal DirectLine bool (obligatorio)
isEndpointParametersEnabled Si este sitio es EndpointParameters habilitado para el canal bool
isNoStorageEnabled Si este sitio de no almacenamiento está deshabilitado el registro detallado para bool
isSecureSiteEnabled Si este sitio está habilitado para la autenticación con Bot Framework. bool
isV1Enabled Si este sitio está habilitado para el protocolo Bot Framework V1. bool
isV3Enabled Si este sitio está habilitado para el protocolo Bot Framework V3. bool
isWebchatPreviewEnabled Si este sitio está habilitado para versiones preliminares de Webchat bool
isWebChatSpeechEnabled Si este sitio está habilitado para Webchat Speech bool
siteName Nombre del sitio string (obligatorio)
tenantId Identificador de inquilino string
trustedOrigins Lista de direcciones URL de origen de confianza para este sitio. Este campo solo es aplicable si isSecureSiteEnabled es True. string[]

DirectLineSpeechChannel

Name Description Value
channelName Nombre del canal 'DirectLineSpeechChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso del canal directLine Speech DirectLineSpeechChannelProperties

DirectLineSpeechChannelProperties

Name Description Value
cognitiveServiceRegion Región de Cognitive Service con este registro de canal. string
cognitiveServiceResourceId Identificador de Cognitive Service con este registro de canal. string
cognitiveServiceSubscriptionKey Clave de suscripción de Cognitive Services que se va a usar con este registro de canal. string

Constraints:
Valor confidencial. Pase como parámetro seguro.
customSpeechModelId Identificador de implementación de voz personalizado (opcional). string
customVoiceDeploymentId Identificador del modelo de voz personalizado (opcional). string
isDefaultBotForCogSvcAccount Convierta este bot en un bot predeterminado para la cuenta de Cognitive Services elegida. bool
isEnabled Si este canal está habilitado o no. bool

EmailChannel

Name Description Value
channelName Nombre del canal 'EmailChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso de canal de correo electrónico EmailChannelProperties

EmailChannelProperties

Name Description Value
authMethod Método de autenticación del canal de correo electrónico. 0 Contraseña (valor predeterminado); 1 Gráfico. int
emailAddress La dirección de correo electrónico string (obligatorio)
isEnabled Si este canal está habilitado para el bot bool (obligatorio)
magicCode El código mágico para configurar la autenticación moderna. string
password Contraseña de la dirección de correo electrónico. El valor solo se devuelve a través de POST a la API de lista de canales de acción; de lo contrario, está vacío. string

FacebookChannel

Name Description Value
channelName Nombre del canal 'FacebookChannel' (obligatorio)
properties Conjunto de propiedades específicas del canal de Facebook del bot FacebookChannelProperties

FacebookChannelProperties

Name Description Value
appId Id. de aplicación de Facebook string (obligatorio)
appSecret Secreto de aplicación de Facebook. El valor solo se devuelve a través de POST a la API de lista de canales de acción; de lo contrario, está vacío. string

Constraints:
Valor confidencial. Pase como parámetro seguro.
isEnabled Si este canal está habilitado para el bot bool (obligatorio)
pages Lista de páginas de Facebook FacebookPage[]

FacebookPage

Name Description Value
accessToken Token de acceso de la aplicación de Facebook. El valor solo se devuelve a través de POST a la API de lista de canales de acción; de lo contrario, está vacío. string

Constraints:
Valor confidencial. Pase como parámetro seguro.
id Id. de página string (obligatorio)

KikChannel

Name Description Value
channelName Nombre del canal 'KikChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso del canal Kik KikChannelProperties

KikChannelProperties

Name Description Value
apiKey Clave de API de Kik. El valor solo se devuelve a través de POST a la API de lista de canales de acción; de lo contrario, está vacío. string
isEnabled Si este canal está habilitado para el bot bool (obligatorio)
isValidated Si este canal se valida para el bot bool
userName El nombre de usuario de Kik string (obligatorio)

LineChannel

Name Description Value
channelName Nombre del canal 'LineChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso de canal de línea LineChannelProperties

LineChannelProperties

Name Description Value
lineRegistrations Lista de registros de canales de línea LineRegistration[] (obligatorio)

LineRegistration

Name Description Value
channelAccessToken Token de acceso para el registro del canal de línea string

Constraints:
Valor confidencial. Pase como parámetro seguro.
channelSecret Secreto para el registro del canal de línea string

Constraints:
Valor confidencial. Pase como parámetro seguro.

M365Extensions

Name Description Value
channelName Nombre del canal 'M365Extensions' (obligatorio)

MsTeamsChannel

Name Description Value
channelName Nombre del canal 'MsTeamsChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso de canal de Microsoft Teams MsTeamsChannelProperties

MsTeamsChannelProperties

Name Description Value
acceptedTerms Si este canal aceptó términos bool
callingWebhook Webhook para llamadas de canal de Microsoft Teams string
deploymentEnvironment Entorno de implementación para llamadas de canal de Microsoft Teams string
enableCalling Habilitación de llamadas para el canal de Microsoft Teams bool
incomingCallRoute Webhook para llamadas de canal de Microsoft Teams string
isEnabled Si este canal está habilitado para el bot bool (obligatorio)

Omnichannel

Name Description Value
channelName Nombre del canal "Omnicanal" (obligatorio)

OutlookChannel

Name Description Value
channelName Nombre del canal 'OutlookChannel' (obligatorio)

SearchAssistant

Name Description Value
channelName Nombre del canal 'SearchAssistant' (obligatorio)

Sku

Name Description Value
name El nombre de la SKU 'F0'
'S1' (obligatorio)

SkypeChannel

Name Description Value
channelName Nombre del canal 'SkypeChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso del canal de Skype SkypeChannelProperties

SkypeChannelProperties

Name Description Value
callingWebHook Llamada a web hook para el canal de Skype string
enableCalling Habilitación de llamadas para el canal de Skype bool
enableGroups Habilitar grupos para el canal de Skype bool
enableMediaCards Habilitar tarjetas multimedia para el canal de Skype bool
enableMessaging Habilitación de la mensajería para el canal de Skype bool
enableScreenSharing Habilitar el uso compartido de pantalla para el canal de Skype bool
enableVideo Habilitar vídeo para el canal de Skype bool
groupsMode Modo de grupo para el canal de Skype string
incomingCallRoute Ruta de llamada entrante para el canal de Skype string
isEnabled Si este canal está habilitado para el bot bool (obligatorio)

SlackChannel

Name Description Value
channelName Nombre del canal 'SlackChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso de canal de Slack SlackChannelProperties

SlackChannelProperties

Name Description Value
clientId Identificador de cliente de Slack string
clientSecret Secreto de cliente de Slack. El valor solo se devuelve a través de POST a la API de lista de canales de acción; de lo contrario, está vacío. string

Constraints:
Valor confidencial. Pase como parámetro seguro.
isEnabled Si este canal está habilitado para el bot bool (obligatorio)
landingPageUrl Dirección URL de la página de aterrizaje de Slack string
registerBeforeOAuthFlow Indica si se va a registrar la configuración antes de que se realice la validación de OAuth. Se recomienda en True. bool
scopes Ámbitos de permisos de Slack. string
signingSecret Secreto de firma de Slack. string

Constraints:
Valor confidencial. Pase como parámetro seguro.
verificationToken Token de comprobación de Slack. El valor solo se devuelve a través de POST a la API de lista de canales de acción; de lo contrario, está vacío. string

Constraints:
Valor confidencial. Pase como parámetro seguro.

SmsChannel

Name Description Value
channelName Nombre del canal 'SmsChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso de canal sms SmsChannelProperties

SmsChannelProperties

Name Description Value
accountSID El SID de la cuenta sms. El valor solo se devuelve a través de POST a la API de lista de canales de acción; de lo contrario, está vacío. string (obligatorio)
authToken Token de autenticación sms. El valor solo se devuelve a través de POST a la API de lista de canales de acción; de lo contrario, está vacío. string

Constraints:
Valor confidencial. Pase como parámetro seguro.
isEnabled Si este canal está habilitado para el bot bool (obligatorio)
isValidated Si este canal se valida para el bot bool
phone El teléfono Sms string (obligatorio)

TelegramChannel

Name Description Value
channelName Nombre del canal 'TelegramChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso del canal de Telegram TelegramChannelProperties

TelegramChannelProperties

Name Description Value
accessToken Token de acceso de Telegram. El valor solo se devuelve a través de POST a la API de lista de canales de acción; de lo contrario, está vacío. string

Constraints:
Valor confidencial. Pase como parámetro seguro.
isEnabled Si este canal está habilitado para el bot bool (obligatorio)
isValidated Si este canal se valida para el bot bool

TelephonyChannel

Name Description Value
channelName Nombre del canal 'TelephonyChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso de canal de telefonía TelephonyChannelProperties

TelephonyChannelProperties

Name Description Value
apiConfigurations Lista de la configuración de la API de telefonía TelephonyChannelResourceApiConfiguration[]
cognitiveServiceRegion ExtensionKey2 string
cognitiveServiceSubscriptionKey ExtensionKey1 string
defaultLocale Configuración regional predeterminada del canal string
isEnabled Si el canal está habilitado bool
phoneNumbers Lista de números de teléfono de telefonía TelephonyPhoneNumbers[]
premiumSKU SKU premium aplicada al canal string

TelephonyChannelResourceApiConfiguration

Name Description Value
cognitiveServiceRegion Región del servicio cognitivo. string
cognitiveServiceResourceId ResourceId de Cognitive Service. string
cognitiveServiceSubscriptionKey Clave de suscripción de Cognitive Services. string
defaultLocale Configuración regional predeterminada. string
id Identificador de la configuración. string
providerName Nombre del proveedor. string

TelephonyPhoneNumbers

Name Description Value
acsEndpoint Punto de conexión de ACS. string
acsResourceId Identificador de recurso de ACS. string
acsSecret Secreto de ACS. string
cognitiveServiceRegion La región de servicio del servicio cognitivo. string
cognitiveServiceResourceId Identificador de recurso de Cognitive Service. string
cognitiveServiceSubscriptionKey Clave de suscripción de Cognitive Service. string
defaultLocale Configuración regional predeterminada del número de teléfono. string
id Identificador del elemento. string
offerType Propiedad opcional que determinará el tipo de oferta del teléfono. string
phoneNumber Número de teléfono. string

WebChatChannel

Name Description Value
channelName Nombre del canal 'WebChatChannel' (obligatorio)
properties Conjunto de propiedades específicas del recurso del canal de chat en web WebChatChannelProperties

WebChatChannelProperties

Name Description Value
sites Lista de sitios de chat web WebChatSite[]

WebChatSite

Name Description Value
appId Identificador de la aplicación DirectLine string
eTag Etiqueta de entidad string
isBlockUserUploadEnabled Si este sitio está habilitado para bloquear la carga de usuarios. bool
isDetailedLoggingEnabled Indica si este sitio está deshabilitado para el registro detallado de bool
isEnabled Si este sitio está habilitado para el canal DirectLine bool (obligatorio)
isEndpointParametersEnabled Si este sitio es EndpointParameters habilitado para el canal bool
isNoStorageEnabled Si este sitio de no almacenamiento está deshabilitado el registro detallado para bool
isSecureSiteEnabled Si este sitio está habilitado para la autenticación con Bot Framework. bool
isV1Enabled Si este sitio está habilitado para el protocolo Bot Framework V1. bool
isV3Enabled Si este sitio está habilitado para el protocolo Bot Framework V3. bool
isWebchatPreviewEnabled Si este sitio está habilitado para versiones preliminares de Webchat bool
isWebChatSpeechEnabled Si este sitio está habilitado para Webchat Speech bool
siteName Nombre del sitio string (obligatorio)
tenantId Identificador de inquilino string
trustedOrigins Lista de direcciones URL de origen de confianza para este sitio. Este campo solo es aplicable si isSecureSiteEnabled es True. string[]