Uso de la CLI de Azure para crear o actualizar un recurso de Azure Bot

  • Artículo

SE APLICA A: SDK v4

En este artículo se describe cómo crear o actualizar un recurso de Azure Bot con la CLI de Azure y una plantilla de Azure Resource Manager (plantilla de ARM).

Esto forma parte del proceso más grande para aprovisionar y publicar un bot.

Nota:

Los SDK de JavaScript, C# y Python de Bot Framework seguirán siendo compatibles, pero el SDK de Java se va a retirar con la compatibilidad final a largo plazo que finaliza en noviembre de 2023.

Los bots existentes creados con el SDK de Java seguirán funcionando.

Para la creación de nuevos bots, considera el uso de Power Virtual Agents y lee sobre cómo elegir la solución de bot de chat adecuada.

Para obtener más información, consulta El futuro de la creación de bots.

Requisitos previos

Para usar la CLI de Azure para aprovisionar y publicar bots, necesitas:

  • Una cuenta de Azure que tenga una suscripción activa. Crear una cuenta gratuita.

  • Una Instalación de la CLI de Azure.

    Para el lenguaje de programación, usa la siguiente versión de la CLI de Azure. Algunos pasos no funcionarán con versiones posteriores de la CLI.

    Lenguaje Versión de la CLI
    C# y JavaScript 2.39.0 o posterior
    Python 2.55.0 o posterior
    Java 2.29.2

  • Este proceso usa una plantilla de Azure Resource Manager (plantilla de ARM) para crear un recurso de Azure Bot para el bot.

    Si no tiene las plantillas actuales, cree una copia en el proyecto de bot de la carpeta deploymentTemplates: C#, JavaScript, Python o Java.

Sugerencia

Esto forma parte del proceso más grande para aprovisionar y publicar un bot. Consulte cómo Aprovisionar y publicar un bot para obtener una lista completa de los requisitos previos.

Edición del archivo de parámetros

Edite el archivo de parámetros de la plantilla de ARM para que contenga los valores que desea usar.

Importante

Debe usar los mismos valores appType y appId al crear los recursos de App Service y Azure Bot.

Si el proyecto aún no contiene los archivos de parámetros y plantillas de ARM más recientes, puede copiarlos desde el repositorio del SDK de Bot Framework para su lenguaje: C#, JavaScript, Python o Java.

En esta tabla se describen los parámetros de implementación del archivo de parámetros, para usarlos con la opción de comando parameters. De forma predeterminada, el nombre del archivo de parámetros es parameters-for-template-AzureBot-with-rg.json.

Parámetro Tipo Description
azureBotId String Necesario. Identificador único e inmutable global del bot, como ContosoCustomerService.
azureBotSku Cadena Opcional. La SKU del recurso Azure Bot. Valores permitidos: "F0" (gratis) y "S1" (estándar). Valor predeterminado: "S1".
azureBotRegion Cadena Opcional. Ubicación de Azure Bot. Valores permitidos: "global", "westeurope", "westus" y "centralindia". El valor predeterminado es "global".
botEndpoint Cadena Opcional. El punto de conexión de mensajería del bot, como https://<appServiceName>.azurewebsites.net/api/messages.
appType Cadena Necesario. Cómo se administran las identidades de los recursos del bot. Los valores permitidos son: "MultiTenant", "SingleTenant" y "UserAssignedMSI". El valor predeterminado es "MultiTenant".
appId Cadena Necesario. Id. de cliente o identificador de aplicación del recurso de identidad que creó anteriormente. Este es el identificador de aplicación de Microsoft del servicio de aplicación.
UMSIName Cadena Opcional. Para los tipos de aplicación de identidad administrada asignada por el usuario, el nombre del recurso de identidad.
UMSIResourceGroupName Cadena Opcional. En el caso de los tipos de aplicación de identidad administrada asignadas por el usuario, el grupo de recursos para el recurso de identidad.
tenantId Cadena Opcional. En el caso de la identidad administrada asignada por el usuario y los tipos de aplicación de un solo inquilino, el identificador de inquilino de Microsoft Entra ID para el recurso de identidad.

Sugerencia

El punto de conexión de mensajería del bot debe establecerse para que un bot publicado pueda recibir mensajes.

No todos los parámetros se aplican a todos los tipos de aplicación.

Proporcione valores para UMSIName, UMSIResourceGroupName y tenantId.

Creación del recurso de Azure Bot

Para crear el recurso de Azure Bot, use el siguiente comando.

az deployment group create --resource-group <resource-group> --template-file <template-file-path> --parameters "@<parameters-file-path>"
Opción Descripción
resource-group Nombre del grupo de recursos de Azure en el que se crea App Service.
template-file Ruta de acceso a la plantilla de ARM para App Service. La ruta de acceso puede ser relativa o absoluta.
parámetros Ruta de acceso al archivo de parámetros que se va a usar con la plantilla de ARM. La ruta de acceso puede ser relativa o absoluta.

En el caso de los proyectos creados con los generadores más recientes, la plantilla de ARM y los archivos de parámetros se encuentran en la carpeta DeploymentTemplates\DeployUseExistResourceGroup del proyecto. Los nombres de archivo predeterminados son template-AzureBot-with-rg.json y parameters-for-template-AzureBot-with-rg.json.

Para actualizar el recurso de Azure Bot

Para agregar o actualizar el punto de conexión de mensajería de Azure Bot, use el siguiente comando.

az bot update --resource-group <resource group> --name <azureBotId> --endpoint <messaging-endpoint>
Opción Descripción
resource-group El nombre del grupo de recursos de Azure que contiene la aplicación de App Service.
nombre Identificador único e inmutable global del bot.
endpoint El punto de conexión de mensajería del bot, como https://<appServiceName>.azurewebsites.net/api/messages.

Información adicional

Para más información sobre las plantillas de ARM, consulte ¿Qué son las plantillas de ARM? y Cómo usar plantillas de implementación de Azure Resource Manager (ARM) con la CLI de Azure.

Pasos siguientes

Si creó App Service como parte de una implementación de bot, consulte Creación de recursos con plantillas de ARM para continuar el proceso.