Usar a CLI do Azure para criar um recurso do Serviço de Aplicativo

  • Artigo

APLICA-SE A: SDK v4

Este artigo descreve como criar um recurso do Serviço de Aplicativo com a CLI do Azure e um modelo do Azure Resource Manager (modelo ARM) como parte do processo para provisionar e publicar um bot. O serviço de aplicativo às vezes é chamado de aplicativo Web.

Importante

Os bots Python não podem ser implantados em um grupo de recursos que contenha serviços ou bots do Windows. Vários bots Python podem ser implantados no mesmo grupo de recursos; no entanto, você precisa criar outros serviços (como serviços de IA do Azure) em outro grupo de recursos.

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 Microsoft Copilot Studio e leia sobre como escolher a solução de copilot 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 do Serviço de Aplicativo 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 o mesmo appType valor para 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-BotApp-with-rg.json.

Parâmetro Tipo Description
appServiceName String Obrigatório. O nome globalmente exclusivo do serviço de aplicativo.
existingAppServicePlanName String Opcional. O nome de um plano de serviço de aplicativo existente com o qual criar o serviço de aplicativo para o bot.
existingAppServicePlanLocation String Opcional. A localização do plano de serviço de aplicativo existente .
newAppServicePlanName String Opcional. O nome do novo plano de serviço de aplicativo.
newAppServicePlanLocation String Opcional. A localização do novo plano de serviço de aplicativo.
newAppServicePlanSku Object Opcional. A SKU para o novo plano de serviço de aplicativo. O padrão é o plano de serviço S1 (Padrão).
appType String Obrigatório. Como as identidades dos recursos do bot são gerenciadas. Valores permitidos: "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. Isso é usado como a ID do aplicativo Microsoft do serviço de aplicativo.
appSecret String Opcional. Para os tipos de aplicativo de locatário único e multilocatário, a senha do recurso de identidade.
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.

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

  • Forneça valores para UMSIName, UMSIResourceGroupNamee tenantId.
  • Deixe appSecret em branco.

Alguns parâmetros são específicos para usar um plano de serviço de aplicativo novo ou existente.

  • Forneça valores para existingAppServicePlanName e existingAppServicePlanLocation.
  • Deixe newAppServicePlanName, newAppServicePlanLocatione newAppServicePlanSku em branco.

Criar o serviço de aplicativo

Crie o serviço de aplicativo para seu bot.

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-BotApp-with-rg.json e parameters-for-template-BotApp-with-rg.json.

Gorjeta

  • A URL base do serviço de aplicativo é baseada no nome do serviço de aplicativo: https:<app-service-name>.azurewebsites.net.
  • O ponto de extremidade de mensagens para seu bot será a URL base mais /api/messages, como https:<app-service-name>.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.