Partager via

az bot

  • Référence

Gérer Microsoft Azure Bot Service.

Commandes

Nom Description Type État
az bot authsetting

Gérer les paramètres de connexion OAuth sur un bot.

 Core GA
az bot authsetting create

Créez un paramètre de connexion OAuth sur un bot.

 Core GA
az bot authsetting delete

Supprimez un paramètre de connexion OAuth sur un bot.

 Core GA
az bot authsetting list

Afficher tous les paramètres de connexion OAuth sur un bot.

 Core GA
az bot authsetting list-providers

Répertoriez les détails de tous les fournisseurs de services disponibles pour créer des paramètres de connexion OAuth.

 Core GA
az bot authsetting show

Afficher les détails d’un paramètre de connexion OAuth sur un bot.

 Core GA
az bot create

Créez un bot sdk v4.

 Core GA
az bot delete

Supprimez un bot existant.

 Core GA
az bot directline

Gérez le canal Directline sur un bot.

 Core Aperçu
az bot directline create

Créez le canal DirectLine sur un bot avec uniquement le protocole v3 activé.

 Core Aperçu
az bot directline delete

Supprimez le canal Directline sur un bot.

 Core Aperçu
az bot directline show

Obtenez des détails sur le canal Directline sur un bot.

 Core Aperçu
az bot directline update

Mettez à jour le canal DirectLine sur un bot avec uniquement le protocole v3 activé.

 Core Aperçu
az bot download

Téléchargez un bot existant.

 Core Aperçu
az bot email

Gérez le canal de messagerie sur un bot.

 Core Aperçu
az bot email create

Créez le canal de messagerie sur un bot.

 Core Aperçu
az bot email delete

Supprimez le canal de messagerie sur un bot.

 Core Aperçu
az bot email show

Obtenez les détails du canal de messagerie sur un bot.

 Core Aperçu
az bot facebook

Gérez le canal Facebook sur un bot.

 Core Aperçu
az bot facebook create

Créez le canal Facebook sur un bot.

 Core Aperçu
az bot facebook delete

Supprimez le canal Facebook sur un bot.

 Core Aperçu
az bot facebook show

Obtenez des détails sur le canal Facebook sur un bot.

 Core Aperçu
az bot kik

Gérez le canal Kik sur un bot.

 Core Aperçu
az bot kik create

Créez le canal Kik sur un bot.

 Core Aperçu
az bot kik delete

Supprimez le canal Kik sur un bot.

 Core Aperçu
az bot kik show

Obtenez des détails sur le canal Kik sur un bot.

 Core Aperçu
az bot msteams

Gérez le canal Microsoft Teams sur un bot.

 Core Aperçu
az bot msteams create

Créez le canal Microsoft Teams sur un bot.

 Core Aperçu
az bot msteams delete

Supprimez le canal Microsoft Teams sur un bot.

 Core Aperçu
az bot msteams show

Obtenez des détails sur le canal Microsoft Teams sur un bot.

 Core Aperçu
az bot prepare-deploy

Ajoutez des scripts/fichiers de configuration pour la publication avec az webapp deployment.

 Core GA
az bot prepare-publish

(Mode maintenance) Ajoutez des scripts à votre répertoire de code source local pour pouvoir le publier à l’aide az bot publish de bots sdk v3.

 Core Aperçu
az bot publish

Publiez sur le service d’application associé d’un bot.

 Core Aperçu
az bot show

Obtenez un bot existant.

 Core GA
az bot skype

Gérez le canal Skype sur un bot.

 Core Aperçu
az bot skype create

Créez le canal Skype sur un bot.

 Core Aperçu
az bot skype delete

Supprimez le canal Skype sur un bot.

 Core Aperçu
az bot skype show

Obtenez des détails sur le canal Skype sur un bot.

 Core Aperçu
az bot slack

Gérez le canal Slack sur un bot.

 Core Aperçu
az bot slack create

Créez le canal Slack sur un bot.

 Core Aperçu
az bot slack delete

Supprimez le canal Slack sur un bot.

 Core Aperçu
az bot slack show

Obtenez des détails sur le canal Slack sur un bot.

 Core Aperçu
az bot sms

Gérez le canal SMS sur un bot.

 Core Aperçu
az bot sms create

Créez le canal SMS sur un bot.

 Core Aperçu
az bot sms delete

Supprimez le canal SMS sur un bot.

 Core Aperçu
az bot sms show

Obtenez les détails du canal SMS sur un bot.

 Core Aperçu
az bot telegram

Gérez le canal Telegram sur un bot.

 Core Aperçu
az bot telegram create

Créez le canal Telegram sur un bot.

 Core Aperçu
az bot telegram delete

Supprimez le canal Telegram sur un bot.

 Core Aperçu
az bot telegram show

Obtenez des détails sur le canal Telegram sur un bot.

 Core Aperçu
az bot update

Mettez à jour un bot existant.

 Core GA
az bot webchat

Gérez le canal Webchat sur un bot.

 Core GA
az bot webchat show

Obtenez des détails sur le canal Webchat sur un bot.

 Core GA

az bot create

Modifier

Créez un bot sdk v4.

az bot create --app-type
              --appid
              --name
              --resource-group
              [--cmk]
              [--description]
              [--display-name]
              [--endpoint]
              [--location]
              [--msi-resource-id]
              [--sku {F0, S1}]
              [--tags]
              [--tenant-id]

Paramètres obligatoires

--app-type

Type d’application Microsoft pour le bot. Les valeurs possibles sont les suivantes : « UserAssignedMSI », « SingleTenant », « MultiTenant ».

--appid

ID du compte Microsoft (ID MSA) à utiliser avec le bot.

--name -n

Nom de ressource du bot. Le nom du bot doit comporter entre 4 à 42 caractères. Il peut contenir uniquement les caractères suivants : a-z, A-Z, 0-9 et _.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres facultatifs

--cmk --cmk-key-vault-key-url

URL de clé du coffre de clés pour activer le chiffrement des clés gérées par le client.

--description -d

Description du bot.

--display-name

Nom complet du bot. S’il n’est pas spécifié, la valeur par défaut est le nom du bot.

--endpoint -e

Point de terminaison de messagerie du bot.

--location -l

Emplacement. Valeurs provenant de : az account list-locations. Vous pouvez configurer le lieu par défaut en utilisant az configure --defaults location=<location>.

Valeur par défaut: global
--msi-resource-id

ID de ressource d’identité managée Microsoft App pour le bot.

--sku

Référence SKU du bot.

Valeurs acceptées: F0, S1
Valeur par défaut: F0
--tags

Balises séparées par l’espace : key[=value] [key[=value] ...]. Utilisez « » pour effacer les balises existantes.

--tenant-id

ID de locataire de l’application Microsoft pour le bot.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az bot delete

Modifier

Supprimez un bot existant.

az bot delete --name
              --resource-group

Paramètres obligatoires

--name -n

Nom de ressource du bot. Le nom du bot doit comporter entre 4 à 42 caractères. Il peut contenir uniquement les caractères suivants : a-z, A-Z, 0-9 et _.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az bot download

Modifier
Préversion

Cette commande est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Téléchargez un bot existant.

Le code source est téléchargé à partir de l’application web associée au bot. Vous pouvez ensuite y apporter des modifications et les publier dans votre application.

az bot download --name
                --resource-group
                [--save-path]

Paramètres obligatoires

--name -n

Nom de ressource du bot. Le nom du bot doit comporter entre 4 à 42 caractères. Il peut contenir uniquement les caractères suivants : a-z, A-Z, 0-9 et _.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres facultatifs

--save-path

Répertoire dans lequel télécharger le code du bot.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az bot prepare-deploy

Modifier

Ajoutez des scripts/fichiers de configuration pour la publication avec az webapp deployment.

Ajoutez des scripts ou des fichiers de configuration à la racine de votre répertoire de code source local pour pouvoir publier à l’aide az webapp deploymentde . Lorsque votre code est déployé sur votre App Service, les scripts ou fichiers de configuration générés doivent apparaître dans D :\home\site\wwwroot sur la page web Kudu d’App Service.

az bot prepare-deploy --lang {Csharp, Javascript, Typescript}
                      [--code-dir]
                      [--proj-file-path]

Exemples

Préparez-vous à utiliser « az webapp » pour déployer un bot Javascript en récupérant un fichier web.config Node.js IIS.

az bot prepare-deploy --lang Javascript --code-dir "MyBotCode"

Préparez-vous à utiliser « az webapp » pour déployer un bot Csharp en créant un fichier .deployment.

az bot prepare-deploy --lang Csharp --code-dir "." --proj-file-path "MyBot.csproj"

Paramètres obligatoires

--lang

Langage ou runtime du bot.

Valeurs acceptées: Csharp, Javascript, Typescript

Paramètres facultatifs

--code-dir

Répertoire dans lequel placer les fichiers de déploiement générés. Par défaut, le répertoire actif à partir duquel la commande est appelée.

--proj-file-path

Chemin d’accès au fichier .csproj par rapport à --code-dir.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az bot prepare-publish

Modifier
Préversion

Cette commande est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

(Mode maintenance) Ajoutez des scripts à votre répertoire de code source local pour pouvoir le publier à l’aide az bot publish de bots sdk v3.

az bot prepare-publish --name
                       --proj-file-path
                       --resource-group
                       --sln-name
                       [--code-dir]
                       [--version {v3, v4}]

Paramètres obligatoires

--name -n

Nom de ressource du bot. Le nom du bot doit comporter entre 4 à 42 caractères. Il peut contenir uniquement les caractères suivants : a-z, A-Z, 0-9 et _.

--proj-file-path

Chemin d’accès au nom du fichier projet de démarrage. (Par exemple ,/EchoBotWithCounter.csproj ») Obligatoire uniquement pour C#.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--sln-name

Nom du nom du fichier de solution de démarrage. Obligatoire uniquement pour C#.

Paramètres facultatifs

--code-dir

Répertoire dans lequel télécharger des scripts de déploiement.

--version -v

Version du Kit de développement logiciel (SDK) Microsoft Bot Builder à utiliser dans le modèle de bot qui sera créé.

Valeurs acceptées: v3, v4
Valeur par défaut: v3
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az bot publish

Modifier
Préversion

Cette commande est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Publiez sur le service d’application associé d’un bot.

Publiez votre code source sur le service d’application associé à votre bot. Cela est DÉCONSEILLÉ pour les bots v4 et n’est plus recommandé pour la publication de bots v4 sur Azure. Utilisez et az webapp deployment déployez az bot prepare-deploy plutôt votre bot v4. Pour plus d’informations, consultez https://aka.ms/deploy-your-bot.

az bot publish --name
               --resource-group
               [--code-dir]
               [--keep-node-modules {false, true}]
               [--proj-file-path]
               [--timeout]
               [--version]

Exemples

Publier du code source dans votre application Azure, à partir du dossier de code du bot

az bot publish -n botName -g MyResourceGroup

Paramètres obligatoires

--name -n

Nom de ressource du bot. Le nom du bot doit comporter entre 4 à 42 caractères. Il peut contenir uniquement les caractères suivants : a-z, A-Z, 0-9 et _.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres facultatifs

--code-dir

Répertoire depuis lequel charger le code du bot.

--keep-node-modules

Conservez node_modules dossier et ne s’exécutez npm install pas sur App Service. Cela peut accélérer considérablement la publication des commandes pour les bots sdk Node.js.

Valeurs acceptées: false, true
--proj-file-path

Chemin d’accès au nom du fichier projet de démarrage. (Par exemple, ./EchoBotWithCounter.csproj »).

--timeout -t

Délai d’expiration configurable en secondes pour case activée l’état du déploiement.

--version -v

Version du Kit de développement logiciel (SDK) Microsoft Bot Builder du bot.

Valeur par défaut: v4
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az bot show

Modifier

Obtenez un bot existant.

Obtenez des informations sur un bot existant. Pour obtenir les informations nécessaires pour se connecter au bot, utilisez l’indicateur --msbot avec la commande.

az bot show --name
            --resource-group
            [--msbot {false, true}]

Exemples

Obtenir les informations nécessaires pour se connecter à un bot existant sur Azure

az bot show -n botName -g MyResourceGroup --msbot

Paramètres obligatoires

--name -n

Nom de ressource du bot. Le nom du bot doit comporter entre 4 à 42 caractères. Il peut contenir uniquement les caractères suivants : a-z, A-Z, 0-9 et _.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres facultatifs

--msbot

Affichez la sortie en tant que JSON compatible avec un fichier .bot.

Valeurs acceptées: false, true
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az bot update

Modifier

Mettez à jour un bot existant.

az bot update --name
              --resource-group
              [--ai-api-key]
              [--ai-app-id]
              [--ai-key]
              [--cmk]
              [--cmk-off]
              [--description]
              [--display-name]
              [--endpoint]
              [--icon-url]
              [--sku {F0, S1}]
              [--tags]

Exemples

Mettre à jour la description sur un bot

az bot update -n botName -g MyResourceGroup --endpoint "https://bing.com/api/messages" --display-name "Hello World"

Paramètres obligatoires

--name -n

Nom de ressource du bot. Le nom du bot doit comporter entre 4 à 42 caractères. Il peut contenir uniquement les caractères suivants : a-z, A-Z, 0-9 et _.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres facultatifs

--ai-api-key --app-insights-api-key

Azure Application Recommandations clé API utilisée pour lire les données d’analyse des bots. Fournissez une clé si vous souhaitez afficher l’analytique sur votre bot dans le panneau Analytics.

--ai-app-id --app-insights-app-id

Application Azure Recommandations ID d’application utilisé pour lire les données d’analyse de bot. Indiquez un ID si vous souhaitez afficher l’analyse de votre bot dans le panneau Analytics.

--ai-key --app-insights-key

Azure Application Recommandations Clé utilisée pour écrire des données d’analyse de bot. Fournissez une clé si vous souhaitez recevoir l’analytique des bots.

--cmk --cmk-key-vault-key-url

URL de clé du coffre de clés pour activer le chiffrement des clés gérées par le client.

--cmk-off

Définissez le chiffrement sur les clés gérées par Microsoft.

--description

Nouvelle description du bot.

--display-name -d

Nouveau nom d’affichage du bot.

--endpoint -e

Nouveau point de terminaison du bot. Doit commencer par « https:// ».

--icon-url

URL d’icône pour l’avatar du bot. Accepte les fichiers PNG avec une limite de taille de fichier de 30 Ko.

--sku

Référence SKU du bot.

Valeurs acceptées: F0, S1
--tags

Balises séparées par l’espace : key[=value] [key[=value] ...]. Utilisez « » pour effacer les balises existantes.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.