Vue d’ensemble d’Azure Sphere CLI

  • Article

L’interface CLI Azure Sphere est un ensemble de commandes utilisées pour gérer vos ressources Azure Sphere.

Les commandes suivantes sont disponibles :

Interface CLI Azure Sphere et interface cli classique Azure Sphere

L’interface CLI Azure Sphere étant installée en même temps que l’interface CLI existante sur Windows et Linux, vous avez accès à l’une ou l’autre interface. L’interface CLI classique Azure Sphere continue de fonctionner comme elle l’a toujours fait.

Pour utiliser l’interface CLI Azure Sphere :

  • Sur Windows, utilisez PowerShell ou une invite de commandes Windows standard.
  • Sur Linux, utilisez n’importe quel interpréteur de commandes. Spécifiez la commande azsphere si vous définissez l’interface CLI Azure Sphere comme valeur par défaut lors de l’installation du Kit de développement logiciel (SDK), ou la commande azsphere_v2 si vous définissez l’interface CLI classique Azure Sphere comme valeur par défaut.

Pour plus d’informations sur les fonctionnalités et les commandes prises en charge par l’interface CLI Azure Sphere, consultez l’interface CLI Azure Sphere .

Important

  • Sur Windows, le raccourci d’invite de commandes développeur Classique Azure Sphere ne peut être utilisé qu’avec l’interface cli classique Azure Sphere.

Format de ligne de commande

La ligne de commande azsphere a le format suivant :

azsphere [command] [subcommand] operation [parameters]

En général, la commande et la sous-commande sont des noms et l’opération est un verbe, de sorte que la combinaison identifie à la fois une action et l’objet de l’action. La plupart des commandes et opérations ont à la fois un nom complet et une abréviation. Par exemple, la commande d’appareil est abrégée d.

La plupart des paramètres ont à la fois un nom long et une abréviation. Sur la ligne de commande, introduisez le nom long avec deux traits d’union et l’abréviation avec un seul trait d’union. Par exemple, les deux commandes suivantes sont équivalentes :

azsphere device wifi add --ssid MyNetwork --psk mynetworkkey

azsphere device wifi add -s MyNetwork -p mynetworkkey

Certaines commandes autorisent plusieurs valeurs pour un seul paramètre. Dans l’interface CLI Azure Sphere, vous pouvez fournir un seul paramètre 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 :

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

Guillemets et caractères d’échappement

Lorsque vous utilisez des commandes CLI Azure Sphere, tenez compte de la façon dont votre interpréteur de commandes utilise les guillemets et les caractères d’échappement. Si vous prenez en charge les scripts utilisés dans différents interpréteurs de commandes, vous devez comprendre en quoi ils diffèrent.

Par exemple :

Commandes dépendantes du cloud

Les commandes azsphere suivantes nécessitent une connexion cloud et une connexion au service de sécurité Azure Sphere :

  • ca-certificate
  • groupe d’appareils
  • get-support-data
  • Image
  • connectez-vous
  • Déconnexion
  • Produit
  • register-user
  • Rôle
  • show-user
  • Locataire

En outre, les commandes d’appareil azsphere suivantes nécessitent également une connexion cloud :

commande azsphere device Commentaires
Capacité Nécessite le service de sécurité Azure Sphere pour le téléchargement des fonctionnalités de l’appareil
Réclamation
enable-cloud-test
enable-development
Image
Liste
Récupérer Nécessite une connectivité Internet, mais pas une connexion au service de sécurité Azure Sphere
Montrer
show-count
show-deployment-status
show-os-version Nécessite une connectivité Internet, mais pas une connexion au service de sécurité Azure Sphere
mettre à jour

Commandes dépendantes des fonctionnalités de l’appareil

Les commandes d’appareil azsphere suivantes nécessitent l’utilisation d’une fonctionnalité d’appareil pour les appareils dans l’état de fabrication DeviceComplete :

Opération Description
Application Gérer les applications sur l’appareil attaché.
Capacité Gérer les configurations des fonctionnalités des appareils. Requis pour la mise à jour des fonctionnalités.
Certificat Gérer le magasin de certificats d’appareil.
Image Gérer les images d’appareil.
manufacturing-state Gérer l’état de fabrication des appareils attachés. Requis pour la mise à jour de l’état de fabrication.
Redémarrer Redémarrez l’appareil attaché.
show-deployment-status Afficher les status de déploiement du système d’exploitation et des applications sur l’appareil attaché.
show-os-version Afficher la version du système d’exploitation sur l’appareil attaché.
chargement indépendant Déployez et gérez des applications sur l’appareil attaché. Requis pour le déploiement de chargement indépendant et la suppression du chargement indépendant.
Wifi Gérer les configurations Wi-Fi pour l’appareil attaché.

Si vous essayez d’exécuter ces commandes sans fonctionnalité, vous recevez un message d’erreur vous indiquant d’exécuter azsphere device enable-development ou d’utiliser azsphere device capability pour télécharger et sélectionner un fichier de capacité pour l’appareil.