Share via

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 ARM).

Isso faz parte do processo maior para provisionar e publicar um bot.

Nota

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

Os bots existentes construídos com o Java SDK continuarão a funcionar.

Para a criação de novos bots, considere usar o Power Virtual Agents e leia sobre como escolher a solução de chatbot certa.

Para obter mais informações, consulte 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 que tenha uma assinatura ativa. Crie uma conta gratuita.

  • Uma instalação da CLI do Azure.

    Para sua linguagem de programação, use a seguinte versão da CLI do Azure. 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

  • Esse processo usa um modelo do Azure Resource Manager (modelo ARM) para criar um recurso de Bot do Azure para 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.

Gorjeta

Isso faz parte do processo maior 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 ARM para conter os valores que você deseja usar.

Importante

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

Se seu projeto ainda não contém os arquivos de modelo e parâmetros ARM mais recentes, você pode copiá-los do repositório do SDK do Bot Framework para sua 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 parameters comando. Por padrão, o nome do arquivo de parâmetros é parameters-for-template-AzureBot-with-rg.json.

Parâmetro Tipo Description
azureBotId String Obrigatório. O identificador globalmente exclusivo e imutável para seu bot, como ContosoCustomerServiceo .
azureBotSku String Opcional. A SKU do recurso de Bot do Azure. Valores permitidos: "F0" (livre) e "S1" (padrão). O padrão é "S1".
azureBotRegion String Opcional. O local 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 seu bot, como https://<appServiceName>.azurewebsites.net/api/messages.
appType String Obrigatório. 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ório. A ID do cliente ou a ID do aplicativo do recurso de identidade criado anteriormente. Este é o ID do aplicativo Microsoft do serviço de aplicativo.
UMSIName String Opcional. Para tipos de aplicativo de identidade gerenciada atribuídos pelo usuário, o nome do recurso de identidade.
UMSIResourceGroupName String Opcional. Para tipos de aplicativo de identidade gerenciada atribuídos pelo usuário, o grupo de recursos para o recurso de identidade.
tenantId String Opcional. Para identidade gerenciada atribuída pelo usuário e tipos de aplicativo de locatário único, a ID de locatário do Microsoft Entra ID para o recurso de identidade.

Gorjeta

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

Nem todos os parâmetros se aplicam a todos os tipos de aplicativos.

Forneça valores para UMSIName, UMSIResourceGroupNamee tenantId.

Criar o recurso de Bot do Azure

Para criar o recurso de Bot do Azure para seu bot, use o seguinte comando.

az deployment group create --resource-group <resource-group> --template-file <template-file-path> --parameters "@<parameters-file-path>"
Opção Description
resource-group Nome do grupo de recursos do Azure no qual criar o Serviço de Aplicativo.
arquivo-modelo O caminho para o modelo ARM para o 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 ARM. O caminho pode ser relativo ou absoluto.

Para projetos criados com os geradores mais recentes, o modelo 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.

Para atualizar seu recurso de Bot do Azure

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

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

Informações adicionais

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

Próximos passos

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