Utiliser Azure CLI pour créer une ressource App Service

  • Article

S'APPLIQUE À : SDK v4

Cet article explique comment créer une ressource App Service avec Azure CLI et un modèle Azure Resource Manager (modèle ARM) dans le cadre du processus d’approvisionnement et de publication d’un bot. Le service d’application App Service est parfois appelé application Web.

Important

Vous ne pouvez pas déployer les bots Python sur un groupe de ressources qui contient des services ou bots Windows. Vous pouvez déployer plusieurs bots Python sur le même groupe de ressources, mais vous devez créer les autres services (comme les services Azure AI Services.) dans un autre groupe de ressources.

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 App Service 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 la même valeur appType pour 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-BotApp-with-rg.json.

Paramètre Type Description
appServiceName Chaîne Obligatoire. Nom global unique du service d’application.
existingAppServicePlanName Chaîne Facultatif. Nom d’un plan App Service existant avec lequel créer le service d’application pour le bot.
existingAppServicePlanLocation Chaîne facultatif. L’emplacement du plan App Service existant.
newAppServicePlanName Chaîne facultatif. Nom du nouveau plan App Service.
newAppServicePlanLocation Chaîne facultatif. Emplacement du nouveau plan App Service.
newAppServicePlanSku Objet facultatif. SKU pour le nouveau plan App Service. La valeur par défaut est le plan de services S1 (Standard).
appType Chaîne Obligatoire. Gestion des identités de vos ressources de bot. Valeurs autorisées : « 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. Utilisé en tant qu'ID d'application Microsoft du service d'application.
appSecret Chaîne facultatif. Pour les types d’applications monolocataires et multilocataires, le mot de passe de la ressource d’identité.
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é.

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

  • Fournissez des valeurs pour UMSIName, UMSIResourceGroupName et tenantId.
  • Laissez appSecret vide.

Certains paramètres sont spécifiques à l’utilisation d’un plan App Service existant ou nouveau.

  • Fournissez des valeurs pour existingAppServicePlanName et existingAppServicePlanLocation.
  • Laissez newAppServicePlanName, newAppServicePlanLocation, et newAppServicePlanSku vides.

Créer le service App Service

Créez le service d’application pour votre bot.

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

Conseil

  • L’URL de base de votre service d’application est basée sur le nom du service d’application : https:<app-service-name>.azurewebsites.net.
  • Le point de terminaison de messagerie de votre bot sera l’URL de base plus /api/messages, par exemple https:<app-service-name>.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.