Share via

Utiliser Azure CLI pour créer ou mettre à jour une ressource Azure Bot

  • Article

S'APPLIQUE À : SDK v4

Cet article explique comment créer ou mettre à jour une ressource Azure Bot avec Azure CLI et un modèle Azure Resource Manager (modèle ARM).

Il s'agit d'un processus plus large pour approvisionner et publier un bot.

Remarque

Les kits SDK JavaScript, C# et Python Bot Framework continueront d’être pris en charge. Toutefois, le kit de développement logiciel (SDK) Java est mis hors service avec une prise en charge finale à long terme se terminant en novembre 2023.

Les bots existants créés avec le kit de développement logiciel (SDK) Java continueront de fonctionner.

Pour la nouvelle génération de bots, envisagez d'utiliser Power Virtual Agents et découvrez comment choisir la solution de chatbot appropriée.

Pour plus d’informations, consultez Les futures versions de bot.

Prérequis

Pour utiliser Azure CLI pour approvisionner et publier des bots, vous avez besoin des éléments suivants :

  • Un compte Azure disposant d’un abonnement actif. Créer un compte gratuit.

  • Une version installée d’Azure CLI.

    Pour votre langage de programmation, utilisez la version suivante d'Azure CLI. Certaines étapes ne fonctionnent pas avec les versions ultérieures de l'interface CLI.

    Langue Version de la CLI
    C# et JavaScript 2.39.0 ou version ultérieure
    Python 2.55.0 ou version ultérieure
    Java 2.29.2

  • Ce processus utilise un modèle Azure Resource Manager (modèle ARM) pour créer une ressource Azure Bot pour votre bot.

    Si vous ne disposez pas des modèles actuels, créez une copie du dossier deploymentTemplates dans votre projet bot : C#, JavaScript, Python ou Java.

Conseil

Il s'agit d'un processus plus large pour approvisionner et publier un bot. Découvrez comment approvisionner et publier un bot pour obtenir la liste complète des prérequis.

Modification du fichier de paramètres

Modifiez le fichier de paramètres du modèle ARM pour contenir les valeurs que vous souhaitez utiliser.

Important

Vous devez utiliser les mêmes valeurs appType et appId lorsque vous créez vos ressources App Service et Azure Bot.

Si votre projet ne contient pas encore les fichiers de paramètres et de modèle ARM les plus récents, vous pouvez les copier à partir du référentiel du Kit de développement logiciel (SDK) Bot Framework pour votre langage : C#, JavaScript, Python ou Java.

Ce tableau décrit les paramètres de déploiement dans le fichier de paramètres, à utiliser avec l'option de commande parameters. Par défaut, le nom du fichier de paramètres est parameters-for-template-AzureBot-with-rg.json.

Paramètre Type Description
azureBotId Chaîne Obligatoire. Le gestionnaire unique et immuable de votre bot, par exemple ContosoCustomerService.
azureBotSku Chaîne facultatif. Le SKU de la ressource Azure Bot. Valeurs autorisées : « F0 » (gratuit) et « S1 » (standard). La valeur par défaut est « S1 ».
azureBotRegion Chaîne facultatif. L'emplacement de l'Azure Bot. Valeurs autorisées : « global », « westeurope », « westus » et « centralindia ». La valeur par défaut est « global ».
botEndpoint Chaîne facultatif. Point de terminaison de messagerie de votre bot, par exemple https://<appServiceName>.azurewebsites.net/api/messages.
appType Chaîne Obligatoire. Gestion des identités de vos ressources de bot. Les valeurs autorisées sont : « MultiTenant », « SingleTenant » et « UserAssignedMSI ». La valeur par défaut est « MultiTenant ».
appId Chaîne Obligatoire. ID client ou ID d'application de la ressource d'identité que vous avez créée précédemment. Il s'agit de L'ID d'application Microsoft du service d'application.
UMSIName Chaîne facultatif. Pour les types d'applications d'identité gérées attribuées par l'utilisateur, le nom de la ressource d'identité.
UMSIResourceGroupName Chaîne facultatif. Pour les types d'applications d'identité managée affectée par l'utilisateur, le groupe de ressources pour la ressource d'identité.
tenantId Chaîne facultatif. Pour l'identité managée affectée par l'utilisateur et les types d'applications à locataire unique, l'ID du locataire Microsoft Entra ID pour la ressource d'identité.

Conseil

Le point de terminaison de messagerie du bot doit être défini avant qu'un bot publié puisse recevoir des messages.

Tous les paramètres ne s'appliquent pas à tous les types d'applications.

Fournissez des valeurs pour UMSIName, UMSIResourceGroupNameet tenantId.

Créer la ressource Azure Bot

Pour créer la ressource Azure Bot pour votre bot, utilisez la commande suivante.

az deployment group create --resource-group <resource-group> --template-file <template-file-path> --parameters "@<parameters-file-path>"
Option Description
resource-group Nom du groupe de ressources Azure dans lequel créer l'App Service.
template-file Chemin d'accès au modèle ARM pour App Service. Le chemin peut être relatif ou absolu.
parameters Chemin d'accès au fichier de paramètres à utiliser avec le modèle ARM. Le chemin peut être relatif ou absolu.

Pour les projets créés avec les générateurs les plus récents, le modèle ARM et les fichiers de paramètres se trouvent dans le dossier DeploymentTemplates\DeployUseExistResourceGroup du projet. Les noms de fichiers par défaut sont template-AzureBot-with-rg.json et parameters-for-template-AzureBot-with-rg.json.

Pour mettre à jour votre ressource Azure Bot

Pour ajouter ou mettre à jour le point de terminaison de messagerie de votre bot Azure, utilisez la commande suivante.

az bot update --resource-group <resource group> --name <azureBotId> --endpoint <messaging-endpoint>
Option Description
resource-group Nom du groupe de ressources Azure qui contient l'App Service.
name Le gestionnaire unique et immuable de votre bot.
endpoint Point de terminaison de messagerie de votre bot, par exemple https://<appServiceName>.azurewebsites.net/api/messages.

Informations supplémentaires

Pour plus d'informations sur les modèles ARM, consultez Qu'est-ce que les modèles ARM ? et Comment utiliser des modèles de déploiement Azure Resource Manager (ARM) avec Azure CLI.

Étapes suivantes

Si vous avez créé App Service dans le cadre d'un déploiement de bot, consultez Créer des ressources avec des modèles ARM pour continuer le processus.