Criar um recurso de Bot do Azure

APLICA-SE A: SDK v4

O recurso do Bot do Azure (recurso de bot) permite que você registre seu bot nos Serviços de Bot do Azure e conecte o bot aos canais. Você pode criar, conectar e gerenciar bots para interagir com seus usuários onde quer que estejam, desde seu aplicativo ou site até Teams, Messenger e muitos outros canais. Para saber como criar um bot, consulte o início rápido Criar um bot com o Início Rápido do SDK do Bot Framework .

Este artigo descreve como criar um recurso de bot por meio do portal do Azure. Para obter informações sobre como criar um recurso de bot por meio da CLI do Azure, confira como implantar seu bot no Azure.

Quando você cria um recurso de bot, o Azure cria recursos associados. Alguns dos recursos criados dependem de como você decide gerenciar a identidade do bot.

Sua identidade de bot pode ser gerenciada no Azure de algumas maneiras diferentes.

  • Como uma identidade gerenciada atribuída pelo usuário, para que você não precise gerenciar as credenciais do bot por conta própria.
  • Como um aplicativo de locatário único .
  • Como um aplicativo multilocatário .

O suporte para a identidade gerenciada atribuída pelo usuário e os tipos de aplicativo de locatário único foi adicionado para C# e JavaScript ao SDK do Bot Framework na versão 4.15.0. Esses tipos de aplicativo não têm suporte em outros idiomas ou em Bot Framework Composer, Bot Framework Emulator ou ngrok.

Tipo de aplicativo Suporte
Identidade gerenciada atribuída pelo usuário Azure Serviço de Bot e os SDKs C# e JavaScript
Locatário único Azure Serviço de Bot e os SDKs C# e JavaScript
Multilocatário Azure Serviço de Bot, todos os idiomas do SDK do Bot Framework, Composer, Emulator e ngrok

Pré-requisitos

  • Se você não tiver uma assinatura do Azure, crie uma conta gratuita antes de começar.
  • O SDK do Bot Framework para C# ou JavaScript versão 4.15.0 ou posterior, para bots de identidade gerenciada e de locatário único atribuídos pelo usuário.

Criar o recurso

Crie o recurso do Bot do Azure, que permitirá que você registre seu bot no Serviço de Bot do Azure.

Dica

Os tipos de recursos de Registro de Canais de Bot e Bot do Bot do Azure são preteridos. Os recursos configurados e implantados antes da substituição continuarão a funcionar. Os bots criados a partir de um modelo VSIX ou Yeoman do SDK versão 4.14.1.2 ou posterior contêm modelos do ARM que gerarão um recurso do Bot do Azure.

  1. Acesse o portal do Azure.

  2. No painel direito, selecione Criar um recurso.

  3. Na caixa de pesquisa, digite bote pressione Enter.

  4. Selecione o cartão bot do Azure .

    Select Azure bot resource

  5. Selecione Criar.

  6. Insira valores nos campos necessários. Escolha qual tipo de aplicativo criar e se deseja usar informações existentes ou criar novas identidades.

    Create a user-assigned managed identity Azure Bot resource with a new app ID.

  7. Selecione Examinar + criar.

  8. Se a validação for aprovada, selecione Criar.

  9. Depois que a implantação for concluída, selecione Ir para o recurso. Você deve ver o bot e os recursos relacionados listados no grupo de recursos selecionado.

  10. Se você ainda não tiver o SDK do Bot Framework, selecione Baixar de GitHub para saber como consumir os pacotes para o idioma preferido.

    Create bot in SDK

Agora você está pronto para criar seu bot com o SDK do Bot Framework.

Dica

Quando o Azure cria um novo recurso do Azure Bot de locatário único ou multilocatário com uma nova ID do aplicativo, ele também gera uma senha.

Informações de identidade do bot

Siga estas etapas para adicionar informações de identidade ao arquivo de configuração do bot. O arquivo difere dependendo da linguagem de programação que você usa para criar o bot.

Importante

As versões Java e Python do SDK do Bot Framework dão suporte apenas a bots multilocatários. As versões C# e JavaScript dão suporte a todos os três tipos de aplicativo para gerenciar a identidade do bot.

Linguagem Nome do arquivo Observações
C# appsettings.json Dá suporte aos três tipos de aplicativo para gerenciar a identidade do bot.
JavaScript .env Dá suporte aos três tipos de aplicativo para gerenciar a identidade do bot.
Java application.properties Só dá suporte a bots multilocatários.
Python config.py Só dá suporte a bots multilocatários. Forneça as propriedades de identidade como argumentos para as chamadas de os.environ.get método.

As informações de identidade que você precisa adicionar dependem do tipo de aplicativo do bot. Forneça os seguintes valores em seu arquivo de configuração.

Disponível somente para bots C# e JavaScript.

Propriedade Valor
MicrosoftAppType UserAssignedMSI
MicrosoftAppId A ID do cliente da identidade gerenciada atribuída pelo usuário.
MicrosoftAppPassword Não aplicável. Deixe isso em branco para um bot de identidade gerenciada atribuído pelo usuário.
MicrosoftAppTenantId A ID do locatário da identidade gerenciada atribuída pelo usuário.

Se você tiver um recurso de Aplicativo Web existente para o bot e seu bot for um aplicativo de identidade gerenciada atribuído pelo usuário , talvez seja necessário atualizar o aplicativo Web do bot:

  1. Vá para a folha Serviço de Aplicativo para o aplicativo Web do bot.
  2. Em Configurações, selecione Identidade.
  3. Na folha Identidade , selecione a guia Atribuída pelo usuário e Adicione (+).
  4. Na folha Adicionar identidade gerenciada atribuída pelo usuário :
    1. Selecione sua assinatura.

    2. Para identidades gerenciadas atribuídas pelo usuário, selecione a identidade gerenciada do bot. Se a identidade gerenciada foi gerada automaticamente para você, ela terá o mesmo nome que seu bot.

    3. Selecione Adicionar para usar essa identidade para o bot.

      The App Service Identity blade with the managed identity for the bot selected.

Para obter o aplicativo do bot ou a ID do locatário:

  1. Vá para a folha de recursos do Bot do Azure para o bot.
  2. Vá para a folha Configuração do bot. Nesta folha, você pode copiar a ID do Aplicativo Microsoft do bot ou a ID do Locatário do Aplicativo.

Bots de locatário único e multilocatário têm um segredo de aplicativo ou senha que você precisa para algumas operações. O Azure Serviço de Bot oculta o segredo do bot. No entanto, o proprietário do recurso de aplicativo Web do bot pode gerar uma nova senha:

  1. Vá para a folha de recursos do Bot do Azure para o bot.
  2. Vá para a folha Configuração do bot.
  3. Selecione Gerenciar, ao lado da ID de Aplicativo da Microsoft, para acessar a folha Certificados + segredos do aplicativo Web.
  4. Siga as instruções na folha para criar um novo segredo do cliente e registrar o valor em um local seguro.

Informações adicionais

Observação

Atualmente, o Bot Framework Composer e o Bot Framework Emulator dão suporte apenas a bots multilocatários. O SDK do Bot Framework para C# ou JavaScript versão 4.15.0 ou posterior é necessário para bots de identidade gerenciada e de locatário único atribuídos pelo usuário.

Suporte à habilidade

Alguns tipos de consumidores de habilidades não são capazes de usar alguns tipos de bots de habilidade. A tabela a seguir descreve quais combinações têm suporte.

  Habilidade multilocatário Habilidade de locatário único Habilidade de identidade gerenciada atribuída pelo usuário
Consumidor multilocatário Com suporte Sem suporte Sem suporte
Consumidor de locatário único Sem suporte Com suporte se ambos os aplicativos pertencerem ao mesmo locatário Com suporte se ambos os aplicativos pertencerem ao mesmo locatário
Consumidor de identidade gerenciada atribuído pelo usuário Sem suporte Com suporte se ambos os aplicativos pertencerem ao mesmo locatário Com suporte se ambos os aplicativos pertencerem ao mesmo locatário

Para obter informações sobre como configurar um consumidor de habilidades ou habilidades, consulte Implementar uma habilidade ou implementar um consumidor de habilidades.

Próximas etapas