Partilhar via


Microsoft.BotService botServiços/canais 2021-03-01

Definição de recursos do bíceps

O tipo de recurso botServices/channels pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.BotService/botServices/channels, adicione o seguinte Bíceps ao seu modelo.

resource symbolicname 'Microsoft.BotService/botServices/channels@2021-03-01' = {
  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

Defina a propriedade channelName para especificar o 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 Omnichannel, 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'
    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 propriedade

Microsoft.BotService/botServices/canais

Designação Descrição Valor
etag Tag de entidade corda
tipo Necessário. Obtém ou define o Tipo do recurso. 'AzureBot'
'bot'
'Designer'
'Função'
'SDK'
Localização Especifica o local do recurso. corda
Designação O nome do recurso 'AcsChatChannel'
'AlexaChannel'
'DirectLineChannel'
'DirectLineSpeechChannel'
'EmailChannel'
'FacebookChannel'
'KikChannel'
'LineChannel'
'M365Extensões'
'MsTeamsChannel'
'Omnichannel'
'OutlookChannel'
'Assistente de pesquisa'
'SkypeChannel'
'SlackChannel'
'SmsChannel'
'TelegramChannel'
'TelephonyChannel'
'WebChatChannel' (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.
Nome simbólico para recurso do tipo: botServices
propriedades O conjunto de propriedades específicas do recurso de canal de bot Canal
SKU Obtém ou define a SKU do recurso. Referência
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos

AcsChatChannel

Designação Descrição Valor
nome_canal O nome do canal 'AcsChatChannel' (obrigatório)

AlexaCanal

Designação Descrição Valor
nome_canal O nome do canal 'AlexaChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal do Alexa AlexaChannelProperties

AlexaChannelProperties

Designação Descrição Valor
alexaSkillId O ID da habilidade Alexa string (obrigatório)
estáAtivado Se esse canal está habilitado para o bot bool (obrigatório)

Canal

Designação Descrição Valor
nome_canal Defina como 'AcsChatChannel' para o tipo AcsChatChannel. Defina como 'AlexaChannel' para o tipo AlexaChannel. Defina como 'DirectLineChannel' para o tipo DirectLineChannel. Defina como 'DirectLineSpeechChannel' para o tipo DirectLineSpeechChannel. Defina como 'EmailChannel' para digitar EmailChannel. Defina como 'FacebookChannel' para digitar FacebookChannel. Defina como 'KikChannel' para o tipo KikChannel. Defina como 'LineChannel' para o tipo LineChannel. Defina como 'M365Extensions' para o tipo M365Extensions. Defina como 'MsTeamsChannel' para o tipo MsTeamsChannel. Defina como 'Omnichannel' para o tipo Omnichannel. Defina como 'OutlookChannel' para o tipo OutlookChannel. Defina como 'SearchAssistant' para digitar SearchAssistant. Defina como 'SkypeChannel' para digitar SkypeChannel. Defina como 'SlackChannel' para o tipo SlackChannel. Defina como 'SmsChannel' para o tipo SmsChannel. Defina como 'TelegramChannel' para digitar TelegramChannel. Defina como 'TelephonyChannel' para o tipo TelephonyChannel. Defina como 'WebChatChannel' para digitar WebChatChannel. 'AcsChatChannel'
'AlexaChannel'
'DirectLineChannel'
'DirectLineSpeechChannel'
'EmailChannel'
'FacebookChannel'
'KikChannel'
'LineChannel'
'M365Extensões'
'MsTeamsChannel'
'Omnichannel'
'OutlookChannel'
'Assistente de pesquisa'
'SkypeChannel'
'SlackChannel'
'SmsChannel'
'TelegramChannel'
'TelephonyChannel'
'WebChatChannel' (obrigatório)
etag Tag de entidade do recurso corda
Localização Especifica o local do recurso. corda

Canal DirectLineChannel

Designação Descrição Valor
nome_canal O nome do canal 'DirectLineChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal de Linha Direta DirectLineChannelProperties

DirectLineChannelProperties

Designação Descrição Valor
DirectLineEmbedCode Código de incorporação de linha direta do recurso corda
extensionKey1 A extensionKey1 corda
extensãoKey2 O extensionKey2 corda
Sítios Web A lista de sites de Linha Direta DirectLineSite[]

DirectLineSite

Designação Descrição Valor
ID do aplicativo ID do aplicativo DirectLine corda
eTag Tag de entidade corda
isBlockUserUploadEnabled Se este site está habilitado para bloquear o upload do usuário. Bool
isDetailedLoggingEnabled Se este site está desativado, registro detalhado para Bool
estáAtivado Se este site está habilitado para o canal DirectLine bool (obrigatório)
isEndpointParametersEnabled Se este site é EndpointParameters ativado para canal Bool
isNoStorageEnabled Se este site sem armazenamento está desativado, registro detalhado para Bool
isSecureSiteEnabled Se este site está habilitado para autenticação com o Bot Framework. Bool
isV1Habilitado Se este site está habilitado para o protocolo Bot Framework V1. Bool
isV3Habilitado Se este site está habilitado para o protocolo Bot Framework V3. Bool
isWebchatPreviewEnabled Se este site está habilitado para versões de visualização do Webchat Bool
isWebChatSpeechEnabled Se este site está habilitado para Fala no Webchat Bool
Nome do site Nome do site string (obrigatório)
inquilinoId ID do inquilino corda
trustedOrigins Lista de URLs de origem confiável para este site. Este campo é aplicável somente se isSecureSiteEnabled for True. string[]

DirectLineSpeechChannel

Designação Descrição Valor
nome_canal O nome do canal 'DirectLineSpeechChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal de Fala DirectLine DirectLineSpeechChannelProperties

DirectLineSpeechChannelProperties

Designação Descrição Valor
cognitiveServiceRegion A região de atendimento cognitivo com este cadastro de canal. corda
cognitiveServiceResourceId O ID do serviço cognitivo com este registro de canal. corda
cognitiveServiceSubscriptionKey A chave de subscrição do serviço cognitivo a utilizar com este registo de canal. cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.
customSpeechModelId ID de implantação de voz personalizada (opcional). corda
customVoiceDeploymentId ID do modelo de fala personalizado (opcional). corda
isDefaultBotForCogSvcAccount Faça disso um bot padrão para a conta de serviço cognitivo escolhida. Bool
estáAtivado Se este canal está habilitado ou não. Bool

Canal de e-mail

Designação Descrição Valor
nome_canal O nome do canal 'EmailChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal de email EmailChannelProperties

EmailChannelProperties

Designação Descrição Valor
authMethod Método de autenticação do canal de e-mail. 0 Senha (padrão); 1 Gráfico. Int
endereço de e-mail O endereço de e-mail string (obrigatório)
estáAtivado Se esse canal está habilitado para o bot bool (obrigatório)
magicCode O código mágico para configurar a autenticação moderna. corda
palavra-passe A senha do endereço de e-mail. Valor retornado somente por meio de POST para a ação Channel List API, caso contrário, vazio. corda

FacebookCanal

Designação Descrição Valor
nome_canal O nome do canal 'FacebookChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do canal do facebook do bot FacebookChannelProperties

FacebookChannelProperties

Designação Descrição Valor
ID do aplicativo ID do aplicativo do Facebook string (obrigatório)
appSecret Segredo do aplicativo do Facebook. Valor retornado somente por meio de POST para a ação Channel List API, caso contrário, vazio. cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.
estáAtivado Se esse canal está habilitado para o bot bool (obrigatório)
páginas A lista de páginas do Facebook Página do Facebook[]

Página do Facebook

Designação Descrição Valor
accessToken Token de acesso ao aplicativo do Facebook. Valor retornado somente por meio de POST para a ação Channel List API, caso contrário, vazio. cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.
ID ID da página string (obrigatório)

KikChannel

Designação Descrição Valor
nome_canal O nome do canal 'KikChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal Kik KikChannelProperties

KikChannelProperties

Designação Descrição Valor
apiKey Chave da API do Kik. Valor retornado somente por meio de POST para a ação Channel List API, caso contrário, vazio. corda
estáAtivado Se esse canal está habilitado para o bot bool (obrigatório)
isValidated Se esse canal é validado para o bot Bool
nome de utilizador O nome de utilizador do Kik string (obrigatório)

LineChannel

Designação Descrição Valor
nome_canal O nome do canal 'LineChannel' (obrigatório)
propriedades O conjunto de propriedades específicas para o recurso de canal de linha LineChannelProperties

LineChannelProperties

Designação Descrição Valor
lineInscrições A lista de registros de canal de linha LineRegistration[] (obrigatório)

LineRegistration

Designação Descrição Valor
canalAccessToken Token de acesso para o registro do canal de linha cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.
channelSecret Segredo para o registro do canal de linha cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.

M365Extensões

Designação Descrição Valor
nome_canal O nome do canal 'M365Extensions' (obrigatório)

MsTeamsChannel

Designação Descrição Valor
nome_canal O nome do canal 'MsTeamsChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal do Microsoft Teams MsTeamsChannelProperties

MsTeamsChannelProperties

Designação Descrição Valor
aceitoTermos aceitos Se este canal aceitou termos Bool
chamandoWebhook Webhook para chamadas de canal do Microsoft Teams corda
ambiente de implantação Ambiente de implantação para chamadas de canal do Microsoft Teams corda
habilitarChamando Ativar chamadas para o canal do Microsoft Teams Bool
incomingCallRoute Webhook para chamadas de canal do Microsoft Teams corda
estáAtivado Se esse canal está habilitado para o bot bool (obrigatório)

Omnicanal

Designação Descrição Valor
nome_canal O nome do canal 'Omnichannel' (obrigatório)

OutlookCanal

Designação Descrição Valor
nome_canal O nome do canal 'OutlookChannel' (obrigatório)

Tags de Recursos

Designação Descrição Valor

Assistente de Pesquisa

Designação Descrição Valor
nome_canal O nome do canal 'SearchAssistant' (obrigatório)

Referência

Designação Descrição Valor
Designação O nome do sku «F0»
«S1» (obrigatório)

SkypeCanal

Designação Descrição Valor
nome_canal O nome do canal 'SkypeChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal do Skype SkypeChannelProperties

SkypeChannelProperties

Designação Descrição Valor
chamandoWebHook Chamando o gancho da Web para o canal do Skype corda
habilitarChamando Ativar chamadas para o canal Skype Bool
enableGroups Habilitar grupos para o canal do Skype Bool
habilitarMediaCards Habilitar cartões de mídia para o canal Skype Bool
enableMessaging Habilitar mensagens para o canal do Skype Bool
enableScreenSharing Habilitar o compartilhamento de tela para o canal do Skype Bool
ativarVídeo Ativar vídeo para o canal Skype Bool
gruposModo Modo de grupo para o canal Skype corda
incomingCallRoute Rota de chamadas recebidas para o canal Skype corda
estáAtivado Se esse canal está habilitado para o bot bool (obrigatório)

SlackChannel

Designação Descrição Valor
nome_canal O nome do canal 'SlackChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal do Slack SlackChannelProperties

SlackChannelProperties

Designação Descrição Valor
ID do cliente O ID do cliente Slack corda
clientSecret (segredo do cliente) O segredo do cliente Slack. Valor retornado somente por meio de POST para a ação Channel List API, caso contrário, vazio. cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.
estáAtivado Se esse canal está habilitado para o bot bool (obrigatório)
landingPageUrl O URL da página de destino do Slack corda
Âmbitos de aplicação Os escopos de permissão do Slack. corda
assinandoSecret O segredo de assinatura do Slack. cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.
Token de verificação O token de verificação do Slack. Valor retornado somente por meio de POST para a ação Channel List API, caso contrário, vazio. cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.

SmsChannel

Designação Descrição Valor
nome_canal O nome do canal 'SmsChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal Sms SmsChannelProperties

SmsChannelProperties

Designação Descrição Valor
accountSID O SID da conta SMS. Valor retornado somente por meio de POST para a ação Channel List API, caso contrário, vazio. string (obrigatório)
authToken O token de autenticação SMS. Valor retornado somente por meio de POST para a ação Channel List API, caso contrário, vazio. cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.
estáAtivado Se esse canal está habilitado para o bot bool (obrigatório)
isValidated Se esse canal é validado para o bot Bool
Telefone O telefone Sms string (obrigatório)

TelegramChannel

Designação Descrição Valor
nome_canal O nome do canal 'TelegramChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso do canal do Telegram TelegramChannelProperties

TelegramChannelProperties

Designação Descrição Valor
accessToken O token de acesso do Telegram. Valor retornado somente por meio de POST para a ação Channel List API, caso contrário, vazio. cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.
estáAtivado Se esse canal está habilitado para o bot bool (obrigatório)
isValidated Se esse canal é validado para o bot Bool

TelephonyChannel

Designação Descrição Valor
nome_canal O nome do canal 'TelephonyChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal de telefonia TelephonyChannelProperties

TelephonyChannelProperties

Designação Descrição Valor
apiConfigurations A lista de configuração da api de telefonia TelephonyChannelResourceApiConfiguration []
cognitiveServiceRegion O extensionKey2 corda
cognitiveServiceSubscriptionKey A extensionKey1 corda
padrãoLocale A localidade padrão do canal corda
estáAtivado Se o canal está ativado Bool
Números de telefone A lista de números de telefone de telefonia Números de telefone de telefonia[]
premiumSKU O SKU premium aplicado ao canal corda

TelephonyChannelResourceApiConfiguration

Designação Descrição Valor
cognitiveServiceRegion A região do serviço cognitivo. corda
cognitiveServiceResourceId O serviço cognitivo resourceId. corda
cognitiveServiceSubscriptionKey A chave de subscrição do serviço cognitivo. corda
padrãoLocale A localidade padrão. corda
ID O id da configuração. corda
nomedoprovedor O nome do provedor. corda

Números de telefone de telefonia

Designação Descrição Valor
acsEndpoint O parâmetro de avaliação da ACS. corda
acsResourceId A id do recurso do ACS. corda
acsSecret O segredo da ACS. corda
cognitiveServiceRegion A região de serviço do serviço cognitivo. corda
cognitiveServiceResourceId O id do recurso do serviço cognitivo. corda
cognitiveServiceSubscriptionKey A chave de subscrição do serviço cognitivo. corda
padrãoLocale A localidade padrão do número de telefone. corda
ID O elemento id. corda
offerType Propriedade opcional que determinará o tipo de oferta do telefone. corda
Número de telefone O número de telefone. corda

WebChatChannel

Designação Descrição Valor
nome_canal O nome do canal 'WebChatChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal do Web Chat WebChatChannelProperties

WebChatChannelProperties

Designação Descrição Valor
Sítios Web A lista de sites de Web Chat WebChatSite[]

WebChatSite

Designação Descrição Valor
ID do aplicativo ID do aplicativo DirectLine corda
eTag Tag de entidade corda
isBlockUserUploadEnabled Se este site está habilitado para bloquear o upload do usuário. Bool
isDetailedLoggingEnabled Se este site está desativado, registro detalhado para Bool
estáAtivado Se este site está habilitado para o canal DirectLine bool (obrigatório)
isEndpointParametersEnabled Se este site é EndpointParameters ativado para canal Bool
isNoStorageEnabled Se este site sem armazenamento está desativado, registro detalhado para Bool
isSecureSiteEnabled Se este site está habilitado para autenticação com o Bot Framework. Bool
isV1Habilitado Se este site está habilitado para o protocolo Bot Framework V1. Bool
isV3Habilitado Se este site está habilitado para o protocolo Bot Framework V3. Bool
isWebchatPreviewEnabled Se este site está habilitado para versões de visualização do Webchat Bool
isWebChatSpeechEnabled Se este site está habilitado para Fala no Webchat Bool
Nome do site Nome do site string (obrigatório)
inquilinoId ID do inquilino corda
trustedOrigins Lista de URLs de origem confiável para este site. Este campo é aplicável somente se isSecureSiteEnabled for True. string[]

Definição de recurso de modelo ARM

O tipo de recurso botServices/channels pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.BotService/botServices/channels, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.BotService/botServices/channels",
  "apiVersion": "2021-03-01",
  "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

Defina a propriedade channelName para especificar o 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 Omnichannel, 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",
    "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 propriedade

Microsoft.BotService/botServices/canais

Designação Descrição Valor
Versão da API A versão api '2021-03-01'
etag Tag de entidade corda
tipo Necessário. Obtém ou define o Tipo do recurso. 'AzureBot'
'bot'
'Designer'
'Função'
'SDK'
Localização Especifica o local do recurso. corda
Designação O nome do recurso 'AcsChatChannel'
'AlexaChannel'
'DirectLineChannel'
'DirectLineSpeechChannel'
'EmailChannel'
'FacebookChannel'
'KikChannel'
'LineChannel'
'M365Extensões'
'MsTeamsChannel'
'Omnichannel'
'OutlookChannel'
'Assistente de pesquisa'
'SkypeChannel'
'SlackChannel'
'SmsChannel'
'TelegramChannel'
'TelephonyChannel'
'WebChatChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal de bot Canal
SKU Obtém ou define a SKU do recurso. Referência
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo O tipo de recurso 'Microsoft.BotService/botServices/channels'

AcsChatChannel

Designação Descrição Valor
nome_canal O nome do canal 'AcsChatChannel' (obrigatório)

AlexaCanal

Designação Descrição Valor
nome_canal O nome do canal 'AlexaChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal do Alexa AlexaChannelProperties

AlexaChannelProperties

Designação Descrição Valor
alexaSkillId O ID da habilidade Alexa string (obrigatório)
estáAtivado Se esse canal está habilitado para o bot bool (obrigatório)

Canal

Designação Descrição Valor
nome_canal Defina como 'AcsChatChannel' para o tipo AcsChatChannel. Defina como 'AlexaChannel' para o tipo AlexaChannel. Defina como 'DirectLineChannel' para o tipo DirectLineChannel. Defina como 'DirectLineSpeechChannel' para o tipo DirectLineSpeechChannel. Defina como 'EmailChannel' para digitar EmailChannel. Defina como 'FacebookChannel' para digitar FacebookChannel. Defina como 'KikChannel' para o tipo KikChannel. Defina como 'LineChannel' para o tipo LineChannel. Defina como 'M365Extensions' para o tipo M365Extensions. Defina como 'MsTeamsChannel' para o tipo MsTeamsChannel. Defina como 'Omnichannel' para o tipo Omnichannel. Defina como 'OutlookChannel' para o tipo OutlookChannel. Defina como 'SearchAssistant' para digitar SearchAssistant. Defina como 'SkypeChannel' para digitar SkypeChannel. Defina como 'SlackChannel' para o tipo SlackChannel. Defina como 'SmsChannel' para o tipo SmsChannel. Defina como 'TelegramChannel' para digitar TelegramChannel. Defina como 'TelephonyChannel' para o tipo TelephonyChannel. Defina como 'WebChatChannel' para digitar WebChatChannel. 'AcsChatChannel'
'AlexaChannel'
'DirectLineChannel'
'DirectLineSpeechChannel'
'EmailChannel'
'FacebookChannel'
'KikChannel'
'LineChannel'
'M365Extensões'
'MsTeamsChannel'
'Omnichannel'
'OutlookChannel'
'Assistente de pesquisa'
'SkypeChannel'
'SlackChannel'
'SmsChannel'
'TelegramChannel'
'TelephonyChannel'
'WebChatChannel' (obrigatório)
etag Tag de entidade do recurso corda
Localização Especifica o local do recurso. corda

Canal DirectLineChannel

Designação Descrição Valor
nome_canal O nome do canal 'DirectLineChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal de Linha Direta DirectLineChannelProperties

DirectLineChannelProperties

Designação Descrição Valor
DirectLineEmbedCode Código de incorporação de linha direta do recurso corda
extensionKey1 A extensionKey1 corda
extensãoKey2 O extensionKey2 corda
Sítios Web A lista de sites de Linha Direta DirectLineSite[]

DirectLineSite

Designação Descrição Valor
ID do aplicativo ID do aplicativo DirectLine corda
eTag Tag de entidade corda
isBlockUserUploadEnabled Se este site está habilitado para bloquear o upload do usuário. Bool
isDetailedLoggingEnabled Se este site está desativado, registro detalhado para Bool
estáAtivado Se este site está habilitado para o canal DirectLine bool (obrigatório)
isEndpointParametersEnabled Se este site é EndpointParameters ativado para canal Bool
isNoStorageEnabled Se este site sem armazenamento está desativado, registro detalhado para Bool
isSecureSiteEnabled Se este site está habilitado para autenticação com o Bot Framework. Bool
isV1Habilitado Se este site está habilitado para o protocolo Bot Framework V1. Bool
isV3Habilitado Se este site está habilitado para o protocolo Bot Framework V3. Bool
isWebchatPreviewEnabled Se este site está habilitado para versões de visualização do Webchat Bool
isWebChatSpeechEnabled Se este site está habilitado para Fala no Webchat Bool
Nome do site Nome do site string (obrigatório)
inquilinoId ID do inquilino corda
trustedOrigins Lista de URLs de origem confiável para este site. Este campo é aplicável somente se isSecureSiteEnabled for True. string[]

DirectLineSpeechChannel

Designação Descrição Valor
nome_canal O nome do canal 'DirectLineSpeechChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal de Fala DirectLine DirectLineSpeechChannelProperties

DirectLineSpeechChannelProperties

Designação Descrição Valor
cognitiveServiceRegion A região de atendimento cognitivo com este cadastro de canal. corda
cognitiveServiceResourceId O ID do serviço cognitivo com este registro de canal. corda
cognitiveServiceSubscriptionKey A chave de subscrição do serviço cognitivo a utilizar com este registo de canal. cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.
customSpeechModelId ID de implantação de voz personalizada (opcional). corda
customVoiceDeploymentId ID do modelo de fala personalizado (opcional). corda
isDefaultBotForCogSvcAccount Faça disso um bot padrão para a conta de serviço cognitivo escolhida. Bool
estáAtivado Se este canal está habilitado ou não. Bool

Canal de e-mail

Designação Descrição Valor
nome_canal O nome do canal 'EmailChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal de email EmailChannelProperties

EmailChannelProperties

Designação Descrição Valor
authMethod Método de autenticação do canal de e-mail. 0 Senha (padrão); 1 Gráfico. Int
endereço de e-mail O endereço de e-mail string (obrigatório)
estáAtivado Se esse canal está habilitado para o bot bool (obrigatório)
magicCode O código mágico para configurar a autenticação moderna. corda
palavra-passe A senha do endereço de e-mail. Valor retornado somente por meio de POST para a ação Channel List API, caso contrário, vazio. corda

FacebookCanal

Designação Descrição Valor
nome_canal O nome do canal 'FacebookChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do canal do facebook do bot FacebookChannelProperties

FacebookChannelProperties

Designação Descrição Valor
ID do aplicativo ID do aplicativo do Facebook string (obrigatório)
appSecret Segredo do aplicativo do Facebook. Valor retornado somente por meio de POST para a ação Channel List API, caso contrário, vazio. cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.
estáAtivado Se esse canal está habilitado para o bot bool (obrigatório)
páginas A lista de páginas do Facebook Página do Facebook[]

Página do Facebook

Designação Descrição Valor
accessToken Token de acesso ao aplicativo do Facebook. Valor retornado somente por meio de POST para a ação Channel List API, caso contrário, vazio. cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.
ID ID da página string (obrigatório)

KikChannel

Designação Descrição Valor
nome_canal O nome do canal 'KikChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal Kik KikChannelProperties

KikChannelProperties

Designação Descrição Valor
apiKey Chave da API do Kik. Valor retornado somente por meio de POST para a ação Channel List API, caso contrário, vazio. corda
estáAtivado Se esse canal está habilitado para o bot bool (obrigatório)
isValidated Se esse canal é validado para o bot Bool
nome de utilizador O nome de utilizador do Kik string (obrigatório)

LineChannel

Designação Descrição Valor
nome_canal O nome do canal 'LineChannel' (obrigatório)
propriedades O conjunto de propriedades específicas para o recurso de canal de linha LineChannelProperties

LineChannelProperties

Designação Descrição Valor
lineInscrições A lista de registros de canal de linha LineRegistration[] (obrigatório)

LineRegistration

Designação Descrição Valor
canalAccessToken Token de acesso para o registro do canal de linha cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.
channelSecret Segredo para o registro do canal de linha cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.

M365Extensões

Designação Descrição Valor
nome_canal O nome do canal 'M365Extensions' (obrigatório)

MsTeamsChannel

Designação Descrição Valor
nome_canal O nome do canal 'MsTeamsChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal do Microsoft Teams MsTeamsChannelProperties

MsTeamsChannelProperties

Designação Descrição Valor
aceitoTermos aceitos Se este canal aceitou termos Bool
chamandoWebhook Webhook para chamadas de canal do Microsoft Teams corda
ambiente de implantação Ambiente de implantação para chamadas de canal do Microsoft Teams corda
habilitarChamando Ativar chamadas para o canal do Microsoft Teams Bool
incomingCallRoute Webhook para chamadas de canal do Microsoft Teams corda
estáAtivado Se esse canal está habilitado para o bot bool (obrigatório)

Omnicanal

Designação Descrição Valor
nome_canal O nome do canal 'Omnichannel' (obrigatório)

OutlookCanal

Designação Descrição Valor
nome_canal O nome do canal 'OutlookChannel' (obrigatório)

Tags de Recursos

Designação Descrição Valor

Assistente de Pesquisa

Designação Descrição Valor
nome_canal O nome do canal 'SearchAssistant' (obrigatório)

Referência

Designação Descrição Valor
Designação O nome do sku «F0»
«S1» (obrigatório)

SkypeCanal

Designação Descrição Valor
nome_canal O nome do canal 'SkypeChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal do Skype SkypeChannelProperties

SkypeChannelProperties

Designação Descrição Valor
chamandoWebHook Chamando o gancho da Web para o canal do Skype corda
habilitarChamando Ativar chamadas para o canal Skype Bool
enableGroups Habilitar grupos para o canal do Skype Bool
habilitarMediaCards Habilitar cartões de mídia para o canal Skype Bool
enableMessaging Habilitar mensagens para o canal do Skype Bool
enableScreenSharing Habilitar o compartilhamento de tela para o canal do Skype Bool
ativarVídeo Ativar vídeo para o canal Skype Bool
gruposModo Modo de grupo para o canal Skype corda
incomingCallRoute Rota de chamadas recebidas para o canal Skype corda
estáAtivado Se esse canal está habilitado para o bot bool (obrigatório)

SlackChannel

Designação Descrição Valor
nome_canal O nome do canal 'SlackChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal do Slack SlackChannelProperties

SlackChannelProperties

Designação Descrição Valor
ID do cliente O ID do cliente Slack corda
clientSecret (segredo do cliente) O segredo do cliente Slack. Valor retornado somente por meio de POST para a ação Channel List API, caso contrário, vazio. cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.
estáAtivado Se esse canal está habilitado para o bot bool (obrigatório)
landingPageUrl O URL da página de destino do Slack corda
Âmbitos de aplicação Os escopos de permissão do Slack. corda
assinandoSecret O segredo de assinatura do Slack. cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.
Token de verificação O token de verificação do Slack. Valor retornado somente por meio de POST para a ação Channel List API, caso contrário, vazio. cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.

SmsChannel

Designação Descrição Valor
nome_canal O nome do canal 'SmsChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal Sms SmsChannelProperties

SmsChannelProperties

Designação Descrição Valor
accountSID O SID da conta SMS. Valor retornado somente por meio de POST para a ação Channel List API, caso contrário, vazio. string (obrigatório)
authToken O token de autenticação SMS. Valor retornado somente por meio de POST para a ação Channel List API, caso contrário, vazio. cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.
estáAtivado Se esse canal está habilitado para o bot bool (obrigatório)
isValidated Se esse canal é validado para o bot Bool
Telefone O telefone Sms string (obrigatório)

TelegramChannel

Designação Descrição Valor
nome_canal O nome do canal 'TelegramChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso do canal do Telegram TelegramChannelProperties

TelegramChannelProperties

Designação Descrição Valor
accessToken O token de acesso do Telegram. Valor retornado somente por meio de POST para a ação Channel List API, caso contrário, vazio. cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.
estáAtivado Se esse canal está habilitado para o bot bool (obrigatório)
isValidated Se esse canal é validado para o bot Bool

TelephonyChannel

Designação Descrição Valor
nome_canal O nome do canal 'TelephonyChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal de telefonia TelephonyChannelProperties

TelephonyChannelProperties

Designação Descrição Valor
apiConfigurations A lista de configuração da api de telefonia TelephonyChannelResourceApiConfiguration []
cognitiveServiceRegion O extensionKey2 corda
cognitiveServiceSubscriptionKey A extensionKey1 corda
padrãoLocale A localidade padrão do canal corda
estáAtivado Se o canal está ativado Bool
Números de telefone A lista de números de telefone de telefonia Números de telefone de telefonia[]
premiumSKU O SKU premium aplicado ao canal corda

TelephonyChannelResourceApiConfiguration

Designação Descrição Valor
cognitiveServiceRegion A região do serviço cognitivo. corda
cognitiveServiceResourceId O serviço cognitivo resourceId. corda
cognitiveServiceSubscriptionKey A chave de subscrição do serviço cognitivo. corda
padrãoLocale A localidade padrão. corda
ID O id da configuração. corda
nomedoprovedor O nome do provedor. corda

Números de telefone de telefonia

Designação Descrição Valor
acsEndpoint O parâmetro de avaliação da ACS. corda
acsResourceId A id do recurso do ACS. corda
acsSecret O segredo da ACS. corda
cognitiveServiceRegion A região de serviço do serviço cognitivo. corda
cognitiveServiceResourceId O id do recurso do serviço cognitivo. corda
cognitiveServiceSubscriptionKey A chave de subscrição do serviço cognitivo. corda
padrãoLocale A localidade padrão do número de telefone. corda
ID O elemento id. corda
offerType Propriedade opcional que determinará o tipo de oferta do telefone. corda
Número de telefone O número de telefone. corda

WebChatChannel

Designação Descrição Valor
nome_canal O nome do canal 'WebChatChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal do Web Chat WebChatChannelProperties

WebChatChannelProperties

Designação Descrição Valor
Sítios Web A lista de sites de Web Chat WebChatSite[]

WebChatSite

Designação Descrição Valor
ID do aplicativo ID do aplicativo DirectLine corda
eTag Tag de entidade corda
isBlockUserUploadEnabled Se este site está habilitado para bloquear o upload do usuário. Bool
isDetailedLoggingEnabled Se este site está desativado, registro detalhado para Bool
estáAtivado Se este site está habilitado para o canal DirectLine bool (obrigatório)
isEndpointParametersEnabled Se este site é EndpointParameters ativado para canal Bool
isNoStorageEnabled Se este site sem armazenamento está desativado, registro detalhado para Bool
isSecureSiteEnabled Se este site está habilitado para autenticação com o Bot Framework. Bool
isV1Habilitado Se este site está habilitado para o protocolo Bot Framework V1. Bool
isV3Habilitado Se este site está habilitado para o protocolo Bot Framework V3. Bool
isWebchatPreviewEnabled Se este site está habilitado para versões de visualização do Webchat Bool
isWebChatSpeechEnabled Se este site está habilitado para Fala no Webchat Bool
Nome do site Nome do site string (obrigatório)
inquilinoId ID do inquilino corda
trustedOrigins Lista de URLs de origem confiável para este site. Este campo é aplicável somente se isSecureSiteEnabled for True. string[]

Exemplos de uso

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso botServices/channels pode ser implantado com operações que visam:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.BotService/botServices/channels, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.BotService/botServices/channels@2021-03-01"
  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

Defina a propriedade channelName para especificar o 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 Omnichannel, 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"
    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 propriedade

Microsoft.BotService/botServices/canais

Designação Descrição Valor
etag Tag de entidade corda
tipo Necessário. Obtém ou define o Tipo do recurso. 'AzureBot'
'bot'
'Designer'
'Função'
'SDK'
Localização Especifica o local do recurso. corda
Designação O nome do recurso 'AcsChatChannel'
'AlexaChannel'
'DirectLineChannel'
'DirectLineSpeechChannel'
'EmailChannel'
'FacebookChannel'
'KikChannel'
'LineChannel'
'M365Extensões'
'MsTeamsChannel'
'Omnichannel'
'OutlookChannel'
'Assistente de pesquisa'
'SkypeChannel'
'SlackChannel'
'SmsChannel'
'TelegramChannel'
'TelephonyChannel'
'WebChatChannel' (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID do recurso do tipo: botServices
propriedades O conjunto de propriedades específicas do recurso de canal de bot Canal
SKU Obtém ou define a SKU do recurso. Referência
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.BotService/botServices/channels@2021-03-01"

AcsChatChannel

Designação Descrição Valor
nome_canal O nome do canal 'AcsChatChannel' (obrigatório)

AlexaCanal

Designação Descrição Valor
nome_canal O nome do canal 'AlexaChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal do Alexa AlexaChannelProperties

AlexaChannelProperties

Designação Descrição Valor
alexaSkillId O ID da habilidade Alexa string (obrigatório)
estáAtivado Se esse canal está habilitado para o bot bool (obrigatório)

Canal

Designação Descrição Valor
nome_canal Defina como 'AcsChatChannel' para o tipo AcsChatChannel. Defina como 'AlexaChannel' para o tipo AlexaChannel. Defina como 'DirectLineChannel' para o tipo DirectLineChannel. Defina como 'DirectLineSpeechChannel' para o tipo DirectLineSpeechChannel. Defina como 'EmailChannel' para digitar EmailChannel. Defina como 'FacebookChannel' para digitar FacebookChannel. Defina como 'KikChannel' para o tipo KikChannel. Defina como 'LineChannel' para o tipo LineChannel. Defina como 'M365Extensions' para o tipo M365Extensions. Defina como 'MsTeamsChannel' para o tipo MsTeamsChannel. Defina como 'Omnichannel' para o tipo Omnichannel. Defina como 'OutlookChannel' para o tipo OutlookChannel. Defina como 'SearchAssistant' para digitar SearchAssistant. Defina como 'SkypeChannel' para digitar SkypeChannel. Defina como 'SlackChannel' para o tipo SlackChannel. Defina como 'SmsChannel' para o tipo SmsChannel. Defina como 'TelegramChannel' para digitar TelegramChannel. Defina como 'TelephonyChannel' para o tipo TelephonyChannel. Defina como 'WebChatChannel' para digitar WebChatChannel. 'AcsChatChannel'
'AlexaChannel'
'DirectLineChannel'
'DirectLineSpeechChannel'
'EmailChannel'
'FacebookChannel'
'KikChannel'
'LineChannel'
'M365Extensões'
'MsTeamsChannel'
'Omnichannel'
'OutlookChannel'
'Assistente de pesquisa'
'SkypeChannel'
'SlackChannel'
'SmsChannel'
'TelegramChannel'
'TelephonyChannel'
'WebChatChannel' (obrigatório)
etag Tag de entidade do recurso corda
Localização Especifica o local do recurso. corda

Canal DirectLineChannel

Designação Descrição Valor
nome_canal O nome do canal 'DirectLineChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal de Linha Direta DirectLineChannelProperties

DirectLineChannelProperties

Designação Descrição Valor
DirectLineEmbedCode Código de incorporação de linha direta do recurso corda
extensionKey1 A extensionKey1 corda
extensãoKey2 O extensionKey2 corda
Sítios Web A lista de sites de Linha Direta DirectLineSite[]

DirectLineSite

Designação Descrição Valor
ID do aplicativo ID do aplicativo DirectLine corda
eTag Tag de entidade corda
isBlockUserUploadEnabled Se este site está habilitado para bloquear o upload do usuário. Bool
isDetailedLoggingEnabled Se este site está desativado, registro detalhado para Bool
estáAtivado Se este site está habilitado para o canal DirectLine bool (obrigatório)
isEndpointParametersEnabled Se este site é EndpointParameters ativado para canal Bool
isNoStorageEnabled Se este site sem armazenamento está desativado, registro detalhado para Bool
isSecureSiteEnabled Se este site está habilitado para autenticação com o Bot Framework. Bool
isV1Habilitado Se este site está habilitado para o protocolo Bot Framework V1. Bool
isV3Habilitado Se este site está habilitado para o protocolo Bot Framework V3. Bool
isWebchatPreviewEnabled Se este site está habilitado para versões de visualização do Webchat Bool
isWebChatSpeechEnabled Se este site está habilitado para Fala no Webchat Bool
Nome do site Nome do site string (obrigatório)
inquilinoId ID do inquilino corda
trustedOrigins Lista de URLs de origem confiável para este site. Este campo é aplicável somente se isSecureSiteEnabled for True. string[]

DirectLineSpeechChannel

Designação Descrição Valor
nome_canal O nome do canal 'DirectLineSpeechChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal de Fala DirectLine DirectLineSpeechChannelProperties

DirectLineSpeechChannelProperties

Designação Descrição Valor
cognitiveServiceRegion A região de atendimento cognitivo com este cadastro de canal. corda
cognitiveServiceResourceId O ID do serviço cognitivo com este registro de canal. corda
cognitiveServiceSubscriptionKey A chave de subscrição do serviço cognitivo a utilizar com este registo de canal. cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.
customSpeechModelId ID de implantação de voz personalizada (opcional). corda
customVoiceDeploymentId ID do modelo de fala personalizado (opcional). corda
isDefaultBotForCogSvcAccount Faça disso um bot padrão para a conta de serviço cognitivo escolhida. Bool
estáAtivado Se este canal está habilitado ou não. Bool

Canal de e-mail

Designação Descrição Valor
nome_canal O nome do canal 'EmailChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal de email EmailChannelProperties

EmailChannelProperties

Designação Descrição Valor
authMethod Método de autenticação do canal de e-mail. 0 Senha (padrão); 1 Gráfico. Int
endereço de e-mail O endereço de e-mail string (obrigatório)
estáAtivado Se esse canal está habilitado para o bot bool (obrigatório)
magicCode O código mágico para configurar a autenticação moderna. corda
palavra-passe A senha do endereço de e-mail. Valor retornado somente por meio de POST para a ação Channel List API, caso contrário, vazio. corda

FacebookCanal

Designação Descrição Valor
nome_canal O nome do canal 'FacebookChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do canal do facebook do bot FacebookChannelProperties

FacebookChannelProperties

Designação Descrição Valor
ID do aplicativo ID do aplicativo do Facebook string (obrigatório)
appSecret Segredo do aplicativo do Facebook. Valor retornado somente por meio de POST para a ação Channel List API, caso contrário, vazio. cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.
estáAtivado Se esse canal está habilitado para o bot bool (obrigatório)
páginas A lista de páginas do Facebook Página do Facebook[]

Página do Facebook

Designação Descrição Valor
accessToken Token de acesso ao aplicativo do Facebook. Valor retornado somente por meio de POST para a ação Channel List API, caso contrário, vazio. cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.
ID ID da página string (obrigatório)

KikChannel

Designação Descrição Valor
nome_canal O nome do canal 'KikChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal Kik KikChannelProperties

KikChannelProperties

Designação Descrição Valor
apiKey Chave da API do Kik. Valor retornado somente por meio de POST para a ação Channel List API, caso contrário, vazio. corda
estáAtivado Se esse canal está habilitado para o bot bool (obrigatório)
isValidated Se esse canal é validado para o bot Bool
nome de utilizador O nome de utilizador do Kik string (obrigatório)

LineChannel

Designação Descrição Valor
nome_canal O nome do canal 'LineChannel' (obrigatório)
propriedades O conjunto de propriedades específicas para o recurso de canal de linha LineChannelProperties

LineChannelProperties

Designação Descrição Valor
lineInscrições A lista de registros de canal de linha LineRegistration[] (obrigatório)

LineRegistration

Designação Descrição Valor
canalAccessToken Token de acesso para o registro do canal de linha cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.
channelSecret Segredo para o registro do canal de linha cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.

M365Extensões

Designação Descrição Valor
nome_canal O nome do canal 'M365Extensions' (obrigatório)

MsTeamsChannel

Designação Descrição Valor
nome_canal O nome do canal 'MsTeamsChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal do Microsoft Teams MsTeamsChannelProperties

MsTeamsChannelProperties

Designação Descrição Valor
aceitoTermos aceitos Se este canal aceitou termos Bool
chamandoWebhook Webhook para chamadas de canal do Microsoft Teams corda
ambiente de implantação Ambiente de implantação para chamadas de canal do Microsoft Teams corda
habilitarChamando Ativar chamadas para o canal do Microsoft Teams Bool
incomingCallRoute Webhook para chamadas de canal do Microsoft Teams corda
estáAtivado Se esse canal está habilitado para o bot bool (obrigatório)

Omnicanal

Designação Descrição Valor
nome_canal O nome do canal 'Omnichannel' (obrigatório)

OutlookCanal

Designação Descrição Valor
nome_canal O nome do canal 'OutlookChannel' (obrigatório)

Tags de Recursos

Designação Descrição Valor

Assistente de Pesquisa

Designação Descrição Valor
nome_canal O nome do canal 'SearchAssistant' (obrigatório)

Referência

Designação Descrição Valor
Designação O nome do sku «F0»
«S1» (obrigatório)

SkypeCanal

Designação Descrição Valor
nome_canal O nome do canal 'SkypeChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal do Skype SkypeChannelProperties

SkypeChannelProperties

Designação Descrição Valor
chamandoWebHook Chamando o gancho da Web para o canal do Skype corda
habilitarChamando Ativar chamadas para o canal Skype Bool
enableGroups Habilitar grupos para o canal do Skype Bool
habilitarMediaCards Habilitar cartões de mídia para o canal Skype Bool
enableMessaging Habilitar mensagens para o canal do Skype Bool
enableScreenSharing Habilitar o compartilhamento de tela para o canal do Skype Bool
ativarVídeo Ativar vídeo para o canal Skype Bool
gruposModo Modo de grupo para o canal Skype corda
incomingCallRoute Rota de chamadas recebidas para o canal Skype corda
estáAtivado Se esse canal está habilitado para o bot bool (obrigatório)

SlackChannel

Designação Descrição Valor
nome_canal O nome do canal 'SlackChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal do Slack SlackChannelProperties

SlackChannelProperties

Designação Descrição Valor
ID do cliente O ID do cliente Slack corda
clientSecret (segredo do cliente) O segredo do cliente Slack. Valor retornado somente por meio de POST para a ação Channel List API, caso contrário, vazio. cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.
estáAtivado Se esse canal está habilitado para o bot bool (obrigatório)
landingPageUrl O URL da página de destino do Slack corda
Âmbitos de aplicação Os escopos de permissão do Slack. corda
assinandoSecret O segredo de assinatura do Slack. cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.
Token de verificação O token de verificação do Slack. Valor retornado somente por meio de POST para a ação Channel List API, caso contrário, vazio. cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.

SmsChannel

Designação Descrição Valor
nome_canal O nome do canal 'SmsChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal Sms SmsChannelProperties

SmsChannelProperties

Designação Descrição Valor
accountSID O SID da conta SMS. Valor retornado somente por meio de POST para a ação Channel List API, caso contrário, vazio. string (obrigatório)
authToken O token de autenticação SMS. Valor retornado somente por meio de POST para a ação Channel List API, caso contrário, vazio. cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.
estáAtivado Se esse canal está habilitado para o bot bool (obrigatório)
isValidated Se esse canal é validado para o bot Bool
Telefone O telefone Sms string (obrigatório)

TelegramChannel

Designação Descrição Valor
nome_canal O nome do canal 'TelegramChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso do canal do Telegram TelegramChannelProperties

TelegramChannelProperties

Designação Descrição Valor
accessToken O token de acesso do Telegram. Valor retornado somente por meio de POST para a ação Channel List API, caso contrário, vazio. cadeia de caracteres

Restrições:
Valor sensível. Passe como um parâmetro seguro.
estáAtivado Se esse canal está habilitado para o bot bool (obrigatório)
isValidated Se esse canal é validado para o bot Bool

TelephonyChannel

Designação Descrição Valor
nome_canal O nome do canal 'TelephonyChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal de telefonia TelephonyChannelProperties

TelephonyChannelProperties

Designação Descrição Valor
apiConfigurations A lista de configuração da api de telefonia TelephonyChannelResourceApiConfiguration []
cognitiveServiceRegion O extensionKey2 corda
cognitiveServiceSubscriptionKey A extensionKey1 corda
padrãoLocale A localidade padrão do canal corda
estáAtivado Se o canal está ativado Bool
Números de telefone A lista de números de telefone de telefonia Números de telefone de telefonia[]
premiumSKU O SKU premium aplicado ao canal corda

TelephonyChannelResourceApiConfiguration

Designação Descrição Valor
cognitiveServiceRegion A região do serviço cognitivo. corda
cognitiveServiceResourceId O serviço cognitivo resourceId. corda
cognitiveServiceSubscriptionKey A chave de subscrição do serviço cognitivo. corda
padrãoLocale A localidade padrão. corda
ID O id da configuração. corda
nomedoprovedor O nome do provedor. corda

Números de telefone de telefonia

Designação Descrição Valor
acsEndpoint O parâmetro de avaliação da ACS. corda
acsResourceId A id do recurso do ACS. corda
acsSecret O segredo da ACS. corda
cognitiveServiceRegion A região de serviço do serviço cognitivo. corda
cognitiveServiceResourceId O id do recurso do serviço cognitivo. corda
cognitiveServiceSubscriptionKey A chave de subscrição do serviço cognitivo. corda
padrãoLocale A localidade padrão do número de telefone. corda
ID O elemento id. corda
offerType Propriedade opcional que determinará o tipo de oferta do telefone. corda
Número de telefone O número de telefone. corda

WebChatChannel

Designação Descrição Valor
nome_canal O nome do canal 'WebChatChannel' (obrigatório)
propriedades O conjunto de propriedades específicas do recurso de canal do Web Chat WebChatChannelProperties

WebChatChannelProperties

Designação Descrição Valor
Sítios Web A lista de sites de Web Chat WebChatSite[]

WebChatSite

Designação Descrição Valor
ID do aplicativo ID do aplicativo DirectLine corda
eTag Tag de entidade corda
isBlockUserUploadEnabled Se este site está habilitado para bloquear o upload do usuário. Bool
isDetailedLoggingEnabled Se este site está desativado, registro detalhado para Bool
estáAtivado Se este site está habilitado para o canal DirectLine bool (obrigatório)
isEndpointParametersEnabled Se este site é EndpointParameters ativado para canal Bool
isNoStorageEnabled Se este site sem armazenamento está desativado, registro detalhado para Bool
isSecureSiteEnabled Se este site está habilitado para autenticação com o Bot Framework. Bool
isV1Habilitado Se este site está habilitado para o protocolo Bot Framework V1. Bool
isV3Habilitado Se este site está habilitado para o protocolo Bot Framework V3. Bool
isWebchatPreviewEnabled Se este site está habilitado para versões de visualização do Webchat Bool
isWebChatSpeechEnabled Se este site está habilitado para Fala no Webchat Bool
Nome do site Nome do site string (obrigatório)
inquilinoId ID do inquilino corda
trustedOrigins Lista de URLs de origem confiável para este site. Este campo é aplicável somente se isSecureSiteEnabled for True. string[]