Use a CLI do Azure para criar um recurso do Serviço de Aplicativos

  • 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 Resource Manager do Azure (modelo do ARM) como parte do processo para provisionar e publicar um bot. Às vezes, o serviço de aplicativo é chamado de aplicativo Web.

Importante

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

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

  • Esse processo usa um modelo do Resource Manager do Azure (modelo do 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.

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 o mesmo valor appType para os recursos do Serviço de Aplicativo e do Bot do Azure.

Se o seu projeto ainda não contiver os arquivos de parâmetros e modelos do ARM mais recentes, você poderá 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-BotApp-with-rg.json.

Parâmetro Tipo Descrição
appServiceName Cadeia de caracteres Obrigatória. O nome globalmente exclusivo do serviço de aplicativo.
existingAppServicePlanName String Opcional. O nome de um plano do serviço de aplicativo existente com o qual criar o serviço de aplicativo para o bot.
existingAppServicePlanLocation String Opcional. O local do plano do serviço de aplicativo existente.
newAppServicePlanName String Opcional. O nome do novo plano do serviço de aplicativo.
newAppServicePlanLocation String Opcional. O local do novo plano do serviço de aplicativo.
newAppServicePlanSku Objeto Opcional. O nome do novo plano do serviço de aplicativo do SKU. O padrão é o plano de serviço S1 (Standard).
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 criado anteriormente. Ela é usada como a ID do aplicativo da Microsoft do serviço de aplicativo.
appSecret String Opcional. Para tipos de aplicativo de locatário único e multilocatário, a senha do o Alexa
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 identidade gerenciada atribuída pelo usuário e tipos de aplicativo de locatário único, a ID do locatário do Microsoft Entra ID para o o Alexa

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

  • Forneça os valores de UMSIName, UMSIResourceGroupName e tenantId.
  • DeixeappSecret em branco.

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

  • Forneça os valores de existingAppServicePlanName e existingAppServicePlanLocation.
  • Deixe newAppServicePlanName, newAppServicePlanLocation e newAppServicePlanSku em branco.

Criar o serviço de aplicativo

Criar o serviço de aplicativo para o seu bot.

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 criar o serviço de aplicativo.
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-BotApp-with-rg.json e parameters-for-template-BotApp-with-rg.json.

Dica

  • 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 do 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 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.