Migrer de l’interface CLI classique vers l’interface CLI Azure Sphere

Si vous utilisez toujours l’interface CLI classique d’Azure Sphere, nous vous recommandons de migrer vers la nouvelle interface CLI Azure Sphere. Actuellement, les deux versions de l’interface CLI peuvent être installées et utilisées côte à côte, mais l’interface CLI classique n’est désormais ni mise à jour ni entretenue et sera supprimée du SDK prochainement (pas avant fin 2022). Nous vous encourageons à vous familiariser avec ces différences et à migrer vos processus et scripts avant la fin de 2022 pour éviter toute interruption.

Pour effectuer une mise à jour vers le SDK le plus récent, consultez Installer le SDK Azure Sphere sur Linux ou Installer le SDK Azure Sphere pour Windows.

Pour utiliser Azure Sphere CLI sur Windows, utilisez PowerShell ou une invite de commandes Windows standard. Pour Linux, vous pouvez utiliser n’importe quel interpréteur de commandes. Consultez la rubrique Exécuter Azure Sphere CLI pour plus d’informations.

Sur Windows, l’invite de commandes de développeur Azure Sphere Classic en cours de mise hors service (disponible en raccourci dans le menu Démarrer sous Azure Sphere) ne peut être utilisée qu’avec Azure Sphere Classic CLI. Consultez la rubrique Exécuter Azure Sphere classic CLI pour plus d’informations.

Différences clés

• Dans l’interface CLI classique Azure Sphere, plusieurs paramètres peuvent être utilisés pour identifier chaque type d’objet. Dans Azure Sphere CLI, un seul paramètre est utilisé pour identifier chaque type d’objet. Cela signifie que vous pouvez utiliser le nom ou l’ID pour spécifier la valeur du paramètre. Cette opération a été implémentée pour les paramètres , et --tenant--product--device-group les --deviceparamètres.

  Type d'objet	Interface CLI Azure Sphere	Interface CLI classique Azure Sphere (en cours de retrait)
  Appareil	--device	--deviceid, --deviceip ou --devicelocation
  Groupe d’appareils	--device-group	--devicegroupid ou --devicegroupname
  Produit	--product	--productid ou --productname
  Locataire	--tenant	--tenantid

• Le formulaire court pour les commandes est pris en charge dans la version classique. Dans Azure Sphere CLI, nous vous recommandons d’utiliser la fonctionnalité d’achèvement de tabulation ou interactive pour afficher la liste des commandes disponibles. Par exemple, dans l’interface CLI classique, vous pouvez utiliser l’une azsphere device enable-development ou azsphere dev edv l’autre commande, tandis que dans la nouvelle interface CLI Azure Sphere, vous pouvez utiliser la saisie semi-automatique pour taper rapidement la azsphere device enable-development commande.

• Certaines commandes autorisent plusieurs valeurs pour un paramètre unique. Dans Azure Sphere CLI, vous pouvez fournir un paramètre unique suivi d’une liste de valeurs séparées par des espaces et dans l’interface CLI classique Azure Sphere, la liste des valeurs est séparée par des virgules. Par exemple :

  • Interface DE ligne de commande Azure Sphere
  • Azure Sphere classic CLI

  azsphere image-package pack-application --package-directory myDirectory --destination myImagePackage --executables filepath-1 filepath-2
  

• Dans la nouvelle interface CLI, le locataire par défaut n’est pas automatiquement sélectionné lors de la création d’un locataire. Vous devez exécuter la commande azsphere tenant select pour sélectionner le locataire par défaut à utiliser pour l’utilisateur actuel sur le PC. Cela permet de s’assurer que le locataire par défaut est le bon à utiliser lors de l’exécution d’une opération ponctuelle que vous ne pouvez pas annuler comme revendiquer l’appareil.

  Lorsque vous utilisez des scripts, vous pouvez sélectionner le locataire par défaut à l’aide du --tenant <tenant ID or tenant name> paramètre.

  Définissez le locataire par défaut au début du script à l’aide de :

  azsphere tenant select --tenant <tenant ID or tenant name>
  

  Vous pouvez également remplacer le locataire par défaut ou spécifier le locataire requis lors de l’exécution de la commande. Par exemple :

  azsphere get-support-data --destination logs.zip --tenant <tenant ID or tenant name>
  

• Le --device-group paramètre identifie le groupe d’appareils. L’ID de groupe d’appareils fournit un GUID, qui identifie de façon unique le groupe d’appareils sur tous les produits. Vous pouvez également utiliser le nom du produit et la <paire de noms de groupe d’appareils au format product-name>/<device-group-name> . Cette paire de noms identifie de façon univoque un groupe d’appareils pour un produit particulier.

• Les commandes suivantes étaient des commandes composées dans l’interface CLI classique. Cela signifie qu’une commande a effectué plusieurs tâches. Dans la nouvelle interface CLI, vous devez exécuter les deux commandes.

  • Dans l’interface CLI classique, la commande azsphere device-group deployment create a chargé le package d’images et a créé un nouveau déploiement.

    Dans la nouvelle interface CLI, vous devez :

    1. Chargez le package d’images sur votre locataire Azure Sphere à l’aide de l’ajout d’images azsphere.
    2. Créez un déploiement pour un groupe d’appareils pour les images chargées à l’aide d’azsphere device-group deployment create.

  • Dans l’interface CLI classique, la fonctionnalité azsphere device capability download --select command downloaded and temporarily selected device capability configuration for the attached device.

    Dans la nouvelle interface CLI, vous devez :

    1. Téléchargez le fichier de fonctionnalité à l’aide du téléchargement de la fonctionnalité d’appareil azsphere.
    2. Sélectionnez la fonctionnalité à l’aide de la fonctionnalité d’appareil azsphere sélectionnée.

  • Dans l’interface CLI classique, la fonctionnalité azsphere device capability download --apply command downloaded and applied the device capability configuration for the attached device.

    Dans la nouvelle interface CLI, vous devez :

    1. Téléchargez le fichier de fonctionnalité à l’aide du téléchargement de la fonctionnalité d’appareil azsphere.
    2. Appliquez la fonctionnalité à l’aide de la mise à jour des fonctionnalités d’appareil azsphere.

• Dans l’interface CLI classique, le ou --output le -o paramètre est utilisé pour spécifier un chemin d’accès et un nom de fichier auquel enregistrer un fichier. Dans la nouvelle interface CLI Azure Sphere, des paramètres spécifiques au contexte sont utilisés, par --destination exemple pour spécifier des chemins d’entrée et de sortie.

• Dans l’interface CLI classique, le ou le -d paramètre est utilisé dans la commande azsphere device app start pour démarrer l’application en mode --debug débogage. Dans la nouvelle interface CLI Azure Sphere, le --debug-mode paramètre est utilisé pour démarrer l’application en mode débogage et le --debug paramètre est utilisé comme paramètre global pour augmenter la détail de journalisation pour afficher tous les journaux de débogage.

• Dans l’interface CLI classique, il n’existe aucun contrôle sur le format de sortie. Dans Azure Sphere CLI, le ou --output le -o paramètre est utilisé pour spécifier le format de sortie dans lequel mettre en forme la sortie CLI.

• À partir de la version 21.02, les numéros de version explicites ont été supprimés des noms de produits Azure Sphere CLI. Cette modification élimine la confusion lors de la référence aux différentes versions du produit.

  • Azure Sphere CLI v2 et versions ultérieures sont désormais appelés « Azure Sphere CLI ».
  • Les versions antérieures de l’interface CLI Azure Sphere (CLI v1 et inférieure) sont désormais appelées « Cli classique Azure Sphere ».

• Si vous utilisez des scripts, ils peuvent ne pas être compatibles avec la nouvelle interface CLI Azure Sphere en raison des différences expliquées ci-dessus. Effectuez les mises à jour requises pour que les scripts s’exécutent correctement dans la nouvelle interface CLI.

Voir aussi

• Bien démarrer avec Azure Sphere CLI
• Interface CLI classique Azure Sphere (en cours de retrait)