Übersicht über die Azure Sphere-Erweiterung für die Azure CLI

  • Artikel

Das Befehlszeilentool zum Verwalten von angefügten Azure Sphere-Geräten und Cloudbereitstellungen wird als Azure CLI-Erweiterung verteilt.

Installieren der Azure CLI und der Azure Sphere-Erweiterung

So beziehen Sie die Azure Sphere-Erweiterung für die Azure CLI:

  1. Installieren Sie die Azure CLI , wenn Sie dies noch nicht getan haben.

  2. Führen Sie den folgenden Befehl aus, um die Azure Sphere-Erweiterung hinzuzufügen:

    az extension add --name azure-sphere

Sie müssen sich mit der Azure CLI anmelden , um sich bei dem Azure-Abonnement anzumelden, das Sie zum Verwalten von Azure Sphere-Geräten verwenden möchten.

Sobald eine Erweiterung installiert ist, wird deren Speicherort unter dem Wert der $AZURE_EXTENSION_DIR Shellvariablen gefunden. Wenn diese Variable nicht festgelegt ist, lautet $HOME/.azure/cliextensions der Wert standardmäßig unter Linux und macOS sowie %USERPROFILE%\.azure\cliextensions unter Windows.

Tipp

Nach der Anmeldung wird eine Liste der Abonnements angezeigt, die Ihrem Azure-Konto zugeordnet sind. Stellen Sie sicher, dass Sie das Abonnement mit den erforderlichen Berechtigungen auswählen, indem Sie den az account set Befehl verwenden, damit die Azure Sphere-Erweiterung ordnungsgemäß funktioniert. Weitere Informationen zur Abonnementauswahl finden Sie unter Verwenden mehrerer Azure-Abonnements.

Verwalten der Azure Sphere-Erweiterung

Verwenden Sie den Befehl, um die installierten Versionen von Azure CLI-Erweiterungen anzuzeigen:

az version

Um die Azure Sphere-Erweiterung auf die neueste Version zu aktualisieren, verwenden Sie Folgendes:

az extension update --name azure-sphere

Verwenden Sie zum Deinstallieren der Azure Sphere-Erweiterung Folgendes:

az extension remove --name azure-sphere

Allgemeine Azure Sphere-CLI-Befehle

Sie können Azure Sphere-Befehle verwenden, indem Sie entweder über die Windows-Eingabeaufforderung oder PowerShell eingeben az sphere . Unter Linux können Sie eine beliebige Befehlszeilenschnittstelle (CLI) verwenden. Die CLI verfügt über vollständige Tabstopps für Befehle unter der Bash-Shell.

In dieser Tabelle sind einige gängige Azure Sphere-Befehle und Links zu deren Referenzdokumentation aufgeführt.

Befehl Beschreibung
az sphere catalog Verwalten Sie Ihren Katalog.
az sphere ca-certificate Verwalten von Zertifikaten in Ihrem Katalog.
az sphere deployment Verwalten von Bereitstellungen in Ihrem Katalog.
az sphere device Verwalten von Azure Sphere-Geräten
az sphere device-group Verwalten von Gerätegruppen in Ihrem Katalog.
az sphere image Verwalten sie Bilder in Ihrem Katalog.
az sphere product Verwalten von Produkten in Ihrem Katalog.
az sphere get-support-data Sammeln Sie Diagnosedaten zu Ihren System-, Cloud- und Gerätekonfigurationen.

Mit der Azure CLI können Sie Konfigurationsoptionen einrichten, die die Verwendung von Azure Sphere-CLI-Befehlen vereinfachen, indem Sie Standardwerte für Parameter wie --resource-group, --subscriptionoder --catalogbereitstellen.

Geräteabhängige Befehle

Der Befehl funktioniert mit einem lokal angeschlossenen Azure Sphere-Gerät. Wenn Sie den Befehl ohne angeschlossenes Gerät versuchen, erhalten Sie eine Fehlermeldung. Weitere Informationen zu Gerätebefehlen finden Sie unter 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

Global verfügbare Argumente

Die folgenden globalen Parameter sind für die Azure Sphere-Erweiterung verfügbar:

Parameter Beschreibung
--debug Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.
--help -h Zeigt die Hilfenachricht an.
--only-show-errors Zeigt nur Fehler an, wobei Warnungen unterdrückt werden.
--output -o Ausgabeformat. Zulässige Werte: json, jsonc, none, table, tsv, yaml, . yamlc Standard: json.
--query JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie http://jmespath.org/ unter .
--subscription : Name oder ID des Abonnements. Sie können das Standardabonnement mit az account set -s NAME_OR_IDkonfigurieren.
--verbose Erweitern Sie die Ausführlichkeit der Protokollierung. Verwenden Sie --debug für vollständige Debugprotokolle.