Создание или обновление ресурса Azure Bot с помощью Azure CLI

  • Статья

ОБЛАСТЬ ПРИМЕНЕНИЯ: ПАКЕТ SDK версии 4

В этой статье описывается создание или обновление ресурса Azure Bot с помощью Azure CLI и шаблона Azure Resource Manager (шаблона ARM).

Это часть более крупного процесса подготовки и публикации бота.

Примечание.

Пакеты SDK для JavaScript, C# и Python для Bot Framework по-прежнему будут поддерживаться, однако пакет SDK java отменяется с окончательной долгосрочной поддержкой, заканчивающейся в ноябре 2023 года.

Существующие боты, созданные с помощью пакета SDK для Java, будут продолжать функционировать.

Для создания нового бота рекомендуется использовать Power Virtual Agent и ознакомиться с выбором подходящего решения чат-бота.

Дополнительные сведения см. в статье "Будущее создания бота".

Необходимые компоненты

Чтобы использовать Azure CLI для подготовки и публикации ботов, вам потребуется:

  • Учетная запись Azure с активной подпиской. Создайте бесплатную учетную запись.

  • Установка Azure CLI.

    Для языка программирования используйте следующую версию Azure CLI. Некоторые шаги не будут работать с более поздними версиями интерфейса командной строки.

    Язык Версия интерфейса командной строки
    C# и JavaScript 2.39.0 или более поздней версии
    Python 2.55.0 или более поздней версии
    Java 2.29.2

  • Этот процесс использует шаблон Azure Resource Manager (шаблон ARM) для создания ресурса Azure Bot для бота.

    Если у вас нет текущих шаблонов, создайте копию в проекте бота папки deploymentTemplates: C#, JavaScript, Python или Java.

Совет

Это часть более крупного процесса подготовки и публикации бота. Узнайте, как подготовить и опубликовать бота для полного списка необходимых компонентов.

Изменение файла параметров

Измените файл параметров для шаблона ARM, чтобы он содержал значения, которые необходимо использовать.

Внимание

При создании Служба приложений и ресурсов Azure Bot необходимо использовать те же appTypeappId значения и значения.

Если проект еще не содержит последние файлы шаблонов и параметров ARM, их можно скопировать из репозитория пакета SDK Bot Framework для вашего языка: C#, JavaScript, Python или Java.

В этой таблице описываются параметры развертывания в файле параметров для использования с параметром parameters команды. По умолчанию имя файла параметров parameters-for-template-AzureBot-with-rg.json.

Параметр Тип Описание:
azureBotId Строка Обязательный. Глобальный уникальный и неизменяемый дескриптор для бота, например ContosoCustomerService.
azureBotSku Строка Необязательно. SKU ресурса Azure Bot. Допустимые значения: "F0" (бесплатный) и "S1" (стандартный). Значение по умолчанию — S1.
azureBotRegion Строка Необязательно. Расположение Azure Bot. Допустимые значения: "global", "westeurope", "westus" и "centralindia". Значение по умолчанию — "глобальный".
botEndpoint Строка Необязательно. Конечная точка обмена сообщениями для бота, например https://<appServiceName>.azurewebsites.net/api/messages.
appType Строка Обязательный. Управление удостоверениями ресурсов бота. Допустимые значения: MultiTenant, SingleTenant и UserAssignedMSI. Значение по умолчанию — MultiTenant.
appId Строка Обязательный. Идентификатор клиента или идентификатор приложения из созданного ранее ресурса удостоверения. Это идентификатор приложения Майкрософт службы приложений.
UMSIName Строка Необязательно. Для типов приложений управляемого удостоверения, назначаемых пользователем, имя ресурса удостоверения.
UMSIResourceGroupName Строка Необязательно. Для типов приложений управляемых удостоверений, назначаемых пользователем, группа ресурсов для ресурса удостоверения.
tenantId Строка Необязательно. Для управляемых удостоверений, назначаемых пользователем, и типов приложений с одним клиентом, идентификатор клиента Microsoft Entra ID для ресурса удостоверения.

Совет

Конечная точка обмена сообщениями бота должна быть задана, прежде чем опубликованный бот сможет получать сообщения.

Не все параметры применяются ко всем типам приложений.

Укажите значения для UMSIName, UMSIResourceGroupNameи tenantId.

Создание ресурса Azure Bot

Чтобы создать ресурс Azure Bot для бота, используйте следующую команду.

az deployment group create --resource-group <resource-group> --template-file <template-file-path> --parameters "@<parameters-file-path>"
Вариант Описание
resource-group Имя группы ресурсов Azure, в которой создается Служба приложений.
template-file Путь к шаблону ARM для Служба приложений. Путь может быть как относительным, так и абсолютным.
parameters Путь к файлу параметров для использования с шаблоном ARM. Путь может быть как относительным, так и абсолютным.

Для проектов, созданных с помощью последних генераторов, файлы шаблонов и параметров ARM находятся в папке DeploymentTemplates\DeployUseExistResourceGroup в проекте. Имена файлов по умолчанию template-AzureBot-with-rg.json и parameters-for-template-AzureBot-with-rg.json.

Обновление ресурса Azure Bot

Чтобы добавить или обновить конечную точку обмена сообщениями для Azure Bot, используйте следующую команду.

az bot update --resource-group <resource group> --name <azureBotId> --endpoint <messaging-endpoint>
Вариант Описание
resource-group Имя группы ресурсов Azure, содержащей Служба приложений.
name Глобально уникальный и неизменяемый дескриптор для бота.
конечная точка Конечная точка обмена сообщениями для бота, например https://<appServiceName>.azurewebsites.net/api/messages.

Дополнительная информация:

Дополнительные сведения о шаблонах ARM см. в статье "Что такое шаблоны ARM" и "Как использовать шаблоны развертывания Azure Resource Manager (ARM) с Azure CLI.

Следующие шаги

Если вы создали Служба приложений в рамках развертывания бота, см. статью "Создание ресурсов с помощью шаблонов ARM для продолжения процесса".