Usar a CLI do Azure para criar ou atualizar um recurso de Bot do Azure

  • Artigo

APLICA-SE A: SDK v4

Este artigo descreve como criar ou atualizar um recurso de Bot do Azure com a CLI do Azure e um modelo do Azure Resource Manager (modelo do ARM).

Isso faz parte do processo mais amplo de provisionamento e publicação de um bot.

Observação

Os SDKs JavaScript, C# e Python do Bot Framework continuarão a ser compatíveis. No entanto, o SDK Java está sendo desativado, com o suporte final de longo prazo terminando em novembro de 2023.

Os bots existentes criados com o SDK para Java continuarão a funcionar.

Para a criação de novos bots, considere usar o Microsoft Copilot Studio e leia sobre como escolher a solução de copiloto certa.

Para obter mais informações, confira O futuro da criação de bots.

Pré-requisitos

Para usar a CLI do Azure para provisionar e publicar bots, você precisa:

  • Uma conta do Azure com uma assinatura ativa. Criar uma conta gratuita.

  • Instalar a CLI do Azure.

    Para a linguagem de programação, use a versão da CLI do Azure apresentada a seguir. Algumas etapas não funcionarão com versões posteriores da CLI.

    Idioma Versão da CLI
    C# e JavaScript 2.39.0 ou posterior
    Python 2.55.0 ou posterior
    Java 2.29.2

  • Este processo utiliza um modelo do Azure Resource Manager (modelo do ARM) para criar um recurso de Bot do Azure para o seu bot.

    Se você não tiver os modelos atuais, crie uma cópia em seu projeto de bot da pasta deploymentTemplates: C#, JavaScript, Python ou Java.

Dica

Essa etapa faz parte do processo grande para provisionar e publicar um bot. Veja como Provisionar e publicar um bot para obter uma lista completa de pré-requisitos.

Editar arquivo de parâmetros

Edite o arquivo de parâmetros do modelo do ARM para que ele contenha os valores que deseja usar.

Importante

Você deve usar os mesmos valores appType e appId ao criar os recursos do Serviço de Aplicativo e do Bot do Azure.

Se o projeto ainda não contém os arquivos de parâmetros e modelos do ARM mais recentes, é possível copiá-los do repositório do SDK do Bot Framework para a linguagem: C#, JavaScript, Python ou Java.

Esta tabela descreve os parâmetros de implantação no arquivo de parâmetros, para uso com a opção de comando parameters. Por padrão, o nome do arquivo de parâmetros é parameters-for-template-AzureBot-with-rg.json.

Parâmetro Tipo Descrição
azureBotId Cadeia de caracteres Obrigatória. O identificador globalmente exclusivo e imutável para o bot, como ContosoCustomerService.
azureBotSku String Opcional. O SKU do recurso de Bot do Azure. Os valores permitidos são “F0” (livre) e “S1” (padrão). O padrão é “S1”.
azureBotRegion String Opcional. A localização do Bot do Azure. Valores permitidos: "global", "westeurope", "westus" e "centralindia". O padrão é “global”.
botEndpoint String Opcional. O ponto de extremidade de mensagens para o bot, como https://<appServiceName>.azurewebsites.net/api/messages.
appType String Obrigatória. Como as identidades dos recursos do bot são gerenciadas. Os valores permitidos são “MultiTenant”, “SingleTenant” e “UserAssignedMSI”. O padrão é “MultiTenant”.
appId String Obrigatória. A ID do cliente ou a ID do aplicativo do recurso de identidade criada anteriormente. Esta é a ID do aplicativo da Microsoft do serviço de aplicativo.
UMSIName String Opcional. Para os tipos de aplicativo da identidade gerenciada atribuída pelo usuário, o nome do o Alexa
UMSIResourceGroupName String Opcional. Para tipos de aplicativo de identidade gerenciada atribuída pelo usuário, o grupo de recursos para o o Alexa
tenantId String Opcional. Para tipos de aplicativos de identidade gerenciada atribuída pelo usuário e de locatário único, a ID do locatário do Microsoft Entra ID para o recurso de identidade.

Dica

O ponto de extremidade de mensagens do bot deve ser definido antes que um bot publicado possa receber mensagens.

Não são todos os parâmetros que se aplicam a todos os tipos de aplicativos.

Forneça valores para UMSIName, UMSIResourceGroupName e tenantId.

Criar os recursos de Bot do Azure

Para criar o recurso de Bot do Azure para o seu bot, utilize o comando apresentado a seguir.

az deployment group create --resource-group <resource-group> --template-file <template-file-path> --parameters "@<parameters-file-path>"
Opção Descrição
resource-group Nome do grupo de recursos do Azure no qual o Serviço de Aplicativo será criado.
arquivo de modelo O caminho para o modelo do ARM do Serviço de Aplicativo. O caminho pode ser relativo ou absoluto.
parâmetros O caminho para o arquivo de parâmetros a ser usado com o modelo do ARM. O caminho pode ser relativo ou absoluto.

Para projetos criados com os geradores mais recentes, o modelo do ARM e os arquivos de parâmetro estão localizados na pasta DeploymentTemplates\DeployUseExistResourceGroup dentro do projeto. Os nomes de arquivo padrão são template-AzureBot-with-rg.json e parameters-for-template-AzureBot-with-rg.json.

Atualizar o recurso de Bot do Azure

Para adicionar ou atualizar o ponto de extremidade de mensagens para o Bot do Azure, utilize o comando apresentado a seguir.

az bot update --resource-group <resource group> --name <azureBotId> --endpoint <messaging-endpoint>
Opção Descrição
resource-group O nome do grupo de recursos do Azure que contém o Serviço de Aplicativo.
name O identificador globalmente exclusivo e imutável para o bot.
endpoint O ponto de extremidade de mensagens para o bot, como https://<appServiceName>.azurewebsites.net/api/messages.

Informações adicionais

Para obter mais informações sobre os modelos do ARM, confira O que são modelos do ARM? e Como usar modelos de implantação do Azure Resource Manager (ARM) com a CLI do Azure.

Próximas etapas

Se você criou o Serviço de Aplicativo como parte de uma implantação de bot, confira Criar recursos com modelos do ARM para continuar o processo.