Teilen über

Übersicht über Azure Sphere CLI

  • Artikel

Wichtig

Dies ist die Dokumentation zu Azure Sphere (Legacy). Azure Sphere (Legacy) wird am 27. September 2027 eingestellt, und Benutzer müssen bis zu diesem Zeitpunkt zu Azure Sphere (integriert) migrieren. Verwenden Sie die Versionsauswahl oberhalb des Inhaltsverzeichniss, um die Dokumentation zu Azure Sphere (Integriert) anzuzeigen.

Die Azure Sphere CLI ist eine Reihe von Befehlen, die zum Verwalten Ihrer Azure Sphere-Ressourcen verwendet werden.

Die folgenden Befehle sind verfügbar:

Hinweis

Der Befehl "register-user " ist jetzt veraltet.

Klassische Azure Sphere CLI und Azure Sphere

Die Azure Sphere CLI wird neben der vorhandenen CLI sowohl unter Windows als auch unter Linux installiert, sodass Sie Zugriff auf beide Schnittstellen haben. Die klassische Azure Sphere CLI funktioniert weiterhin wie immer.

So verwenden Sie die Azure Sphere CLI:

  • Verwenden Sie unter Windows PowerShell oder eine Windows-Standard-Eingabeaufforderung.
  • Verwenden Sie unter Linux eine beliebige Befehlsshell. Geben Sie den Azsphere-Befehl an, wenn Sie Azure Sphere CLI während der SDK-Installation als Standard festlegen, oder den Befehl azsphere_v2 , wenn Sie die klassische Azure Sphere CLI als Standard festlegen.

Details zu den Features und Befehlen, die von Azure Sphere CLI unterstützt werden, finden Sie unter Azure Sphere CLI .

Wichtig

  • Unter Windows kann die absagende Azure Sphere Classic Developer-Eingabeaufforderungsverknüpfung nur mit der klassischen Azure Sphere CLI verwendet werden.

Befehlszeilenformat

Die Azsphere-Befehlszeile weist das folgende Format auf:

azsphere [command] [subcommand] operation [parameters]

Im Allgemeinen stellen command (Befehl) und subcommand (Unterbefehl) Nomen dar, und operation (Vorgang) steht für ein Verb, sodass die Kombination sowohl eine Aktion als auch das Objekt der Aktion identifiziert. Für die meisten Befehle und Vorgänge ist sowohl ein vollständiger Name als auch eine Abkürzung vorhanden. Beispielsweise wird der Gerätebefehl abgekürzt d.

Für die meisten Parameter gibt es sowohl einen langen Namen als auch eine Abkürzung. Geben Sie in der Befehlszeile den langen Namen mit zwei Bindestrichen und die Abkürzung mit einem Bindestrich an. Die folgenden zwei Befehle sind beispielsweise äquivalent:

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

azsphere device wifi add -s MyNetwork -p mynetworkkey

Einige Befehle ermöglichen mehrere Werte für einen einzelnen Parameter. In Azure Sphere CLI können Sie einen einzelnen Parameter gefolgt von einer Liste von Werten angeben, die durch Leerzeichen getrennt sind, und in der klassischen Azure Sphere CLI werden die Werteliste durch Kommas getrennt. Zum Beispiel:

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

Anführungszeichen und Escapezeichen

Wenn Sie mit Azure Sphere CLI-Befehlen arbeiten, beachten Sie, wie Ihre Shell Anführungszeichen und Escapezeichen verwendet. Wenn Sie in verschiedenen Shells verwendete Skripts unterstützen, müssen Sie verstehen, wie sich die Shells unterscheiden.

Zum Beispiel:

Cloudabhängige Befehle

Die folgenden azsphere-Befehle erfordern eine Cloudverbindung sowie die Anmeldung beim Azure Sphere-Sicherheitsdienst:

  • ca-certificate
  • device-group
  • get-support-data
  • image
  • login
  • logout
  • product
  • role
  • show-user
  • tenant

Zusätzlich erfordern die folgenden azsphere device-Befehle ebenfalls eine Cloudverbindung:

azsphere device-Befehl Kommentare
capability Erfordert den Azure Sphere-Sicherheitsdienst für das Herunterladen von Gerätefunktionen.
claim
enable-cloud-test
enable-development
Abbildung
list
recover Erfordert eine Internetverbindung, aber keine Anmeldung beim Azure Sphere-Sicherheitsdienst.
show
show-count
show-deployment-status
show-os-version Erfordert eine Internetverbindung, aber keine Anmeldung beim Azure Sphere-Sicherheitsdienst.
Aktualisierung

Gerätefunktionsabhängige Befehle

Für die folgenden Azsphere-Gerätebefehle ist eine Gerätefunktion erforderlich, die für Geräte im Fertigungszustand DeviceComplete verwendet werden kann:

Vorgang Beschreibung
app Dient zum Verwalten von Anwendungen auf dem angeschlossenen Gerät.
capability Dient zum Verwalten von Gerätefunktionskonfigurationen. Erforderlich für Funktionsupdates.
Zertifikat Dient zum Verwalten des Gerätezertifikatspeichers.
image Dient zum Verwalten von Geräteimages.
Fertigungszustand Dient zum Verwalten des Fertigungszustands des angeschlossenen Geräts. Erforderlich für die Aktualisierung des Fertigungszustands.
restart Dient zum Neustarten des angeschlossenen Geräts.
show-deployment-status Dient zum Anzeigen des Bereitstellungsstatus des Betriebssystems und der Anwendungen auf dem angeschlossenen Gerät.
show-os-version Zeigt die Betriebssystemversion auf dem angeschlossenen Gerät an.
Querladen Dient zum Bereitstellen und Verwalten von Anwendungen auf dem angeschlossenen Gerät. Erforderlich für das Querladen bereitstellen und Querladen löschen.
wifi Dient zum Verwalten der WLAN-Konfigurationen für das angeschlossene Gerät.

Wenn Sie versuchen, diese Befehle ohne Funktion auszuführen, erhalten Sie eine Fehlermeldung, die Sie angibt, entweder auszuführen azsphere device enable-development oder zum Herunterladen und Auswählen einer Funktionsdatei für das Gerät zu verwenden azsphere device capability .