Vue d’ensemble de l’extension Azure Sphere pour Azure CLI

  • Article

L’outil en ligne de commande pour la gestion des appareils attachés à Azure Sphere et des déploiements cloud est distribué en tant qu’extension Azure CLI.

Installer Azure CLI et l’extension Azure Sphere

Pour acquérir l’extension Azure Sphere pour Azure CLI :

  1. Installez Azure CLI si vous ne l’avez pas encore fait.

  2. Pour ajouter l’extension Azure Sphere, exécutez la commande suivante :

    az extension add --name azure-sphere

Vous devez vous connecter avec Azure CLI pour vous connecter à l’abonnement Azure que vous souhaitez utiliser pour gérer les appareils Azure Sphere.

Une fois qu’une extension est installée, son emplacement se trouve sous la valeur de la $AZURE_EXTENSION_DIR variable shell. Si cette variable n’est pas définie, la valeur par défaut est $HOME/.azure/cliextensions sur Linux et macOS, et %USERPROFILE%\.azure\cliextensions sur Windows.

Pointe

Une fois connecté, vous verrez une liste d’abonnements associés à votre compte Azure. Veillez à sélectionner l’abonnement avec les autorisations requises à l’aide de la az account set commande pour que l’extension Azure Sphere fonctionne correctement. Pour plus d’informations sur la sélection des abonnements, consultez Utiliser plusieurs abonnements Azure.

Gestion de l’extension Azure Sphere

Pour afficher les versions installées des extensions Azure CLI, utilisez la commande :

az version

Pour mettre à jour l’extension Azure Sphere vers la dernière version, utilisez :

az extension update --name azure-sphere

Pour désinstaller l’extension Azure Sphere, utilisez :

az extension remove --name azure-sphere

Commandes courantes de l’interface CLI Azure Sphere

Vous pouvez utiliser les commandes Azure Sphere en tapant az sphere à partir de l’invite de commandes Windows ou de PowerShell. Sur Linux, vous pouvez utiliser n’importe quelle interface de ligne de commande (CLI). L’interface CLI dispose d’une saisie semi-automatique par tabulation complète pour les commandes sous l’interpréteur de commandes bash.

Ce tableau répertorie certaines commandes Azure Sphere courantes et des liens vers leur documentation de référence.

Commande Description
az sphere catalog Gérez votre catalogue.
az sphere ca-certificate Gérer les certificats dans votre catalogue.
az sphere deployment Gérer les déploiements dans votre catalogue.
az sphere device Gérer les appareils Azure Sphere.
az sphere device-group Gérer les groupes d’appareils dans votre catalogue.
az sphere image Gérer les images dans votre catalogue.
az sphere product Gérer les produits de votre catalogue.
az sphere get-support-data Collectez des données de diagnostic sur vos configurations système, cloud et d’appareil.

Azure CLI vous permet de configurer des options de configuration qui simplifient l’utilisation des commandes CLI Azure Sphere en fournissant des valeurs par défaut pour des paramètres tels que --resource-group, --subscriptionou --catalog.

Commandes dépendantes de l’appareil

La commande fonctionne avec un appareil Azure Sphere attaché localement. Si vous essayez la commande sans appareil attaché, vous recevrez une erreur. Pour plus d’informations sur les commandes d’appareil, consultez az sphere device

  • az sphere device claim
  • az sphere device recover
  • az sphere device restart
  • az sphere device show-attached
  • az sphere device show-os-version
  • az sphere device app show-memory-status
  • az sphere device app show-quota
  • az sphere device app show-status
  • az sphere device app start
  • az sphere device app stop
  • az sphere device capability show-attached
  • az sphere device capability update
  • az sphere device certificate add
  • az sphere device certificate delete
  • az sphere device certificate list
  • az sphere device certificate show
  • az sphere device certificate show-quota
  • az sphere device image list-installed
  • az sphere image-package show
  • az sphere device manufacturing-state show
  • az sphere device manufacturing-state update
  • az sphere device network proxy apply
  • az sphere device network proxy delete
  • az sphere device network proxy show
  • az sphere device network disable
  • az sphere device network enable
  • az sphere device network list-firewall-rules
  • az sphere device network list-interfaces
  • az sphere device network show-diagnostics
  • az sphere device network show-status
  • az sphere device network update-interface
  • az sphere device sideload delete
  • az sphere device sideload deploy
  • az sphere device wifi add
  • az sphere device wifi disable
  • az sphere device wifi enable
  • az sphere device wifi forget
  • az sphere device wifi list
  • az sphere device wifi reload-config
  • az sphere device wifi scan
  • az sphere device wifi show
  • az sphere device wifi show-status

Arguments disponibles dans le monde entier

Les paramètres globaux suivants sont disponibles pour l’extension Azure Sphere :

Paramètre Description
--debug Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
--help -h Affiche le message d’aide.
--only-show-errors Affiche uniquement les erreurs, en supprimant les avertissements.
--output -o Format de sortie. Valeurs autorisées : json, jsonc, none, table, tsv, yaml, yamlc. Valeur par défaut : json.
--query Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.
--verbose Augmentez le niveau de détail de la journalisation. Utilisez pour les --debug journaux de débogage complets.