Übersicht über die Azure Sphere-CLI

  • Artikel

Die Azure Sphere-CLI besteht aus einer Reihe von Befehlen, die zum Verwalten Ihrer Azure Sphere-Ressourcen verwendet werden.

Die folgenden Befehle sind verfügbar:

Azure Sphere CLI und klassische Azure Sphere CLI

Die Azure Sphere-CLI wird zusammen mit der vorhandenen CLI unter Windows und Linux installiert, sodass Sie Zugriff auf beide Schnittstellen haben. Die klassische Azure Sphere-CLI funktioniert weiterhin wie bisher.

So verwenden Sie die Azure Sphere-CLI:

  • Verwenden Sie unter Windows PowerShell oder eine standardmäßige Windows-Eingabeaufforderung.
  • Verwenden Sie unter Linux eine beliebige Befehlsshell. Geben Sie den Befehl azsphere an, wenn Sie die 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.

Ausführliche Informationen zu den Features und Befehlen, die von der Azure Sphere-CLI unterstützt werden, finden Sie unter Azure Sphere CLI .

Wichtig

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

Befehlszeilenformat

Die azsphere-Befehlszeile hat das folgende Format:

azsphere [command] [subcommand] operation [parameters]

Im Allgemeinen sind Befehl und Unterbefehl Nomen, und operation ist ein Verb, sodass die Kombination sowohl eine Aktion als auch das Objekt der Aktion identifiziert. Die meisten Befehle und Vorgänge haben sowohl einen vollständigen Namen als auch eine Abkürzung. Der Gerätebefehl wird z. B. abgekürzt d.

Die meisten Parameter haben sowohl einen langen Namen als auch eine Abkürzung. Führen Sie in der Befehlszeile den langen Namen mit zwei Bindestrichen und die Abkürzung mit einem einzelnen Bindestrich ein. Die folgenden beiden Befehle sind z. B. gleichwertig:

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

azsphere device wifi add -s MyNetwork -p mynetworkkey

Einige Befehle lassen mehrere Werte für einen einzelnen Parameter zu. In der Azure Sphere-CLI können Sie einen einzelnen Parameter angeben, gefolgt von einer Liste von Werten, die durch Leerzeichen getrennt sind. In der klassischen Azure Sphere-CLI wird die Liste der Werte 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, dass Ihre Shell Anführungszeichen und Escapezeichen verwendet. Wenn Sie Skripts unterstützen, die in verschiedenen Shells verwendet werden, müssen Sie verstehen, wie sich diese unterscheiden.

Zum Beispiel:

Cloudabhängige Befehle

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

  • ca-certificate
  • device-group
  • get-support-data
  • Bild
  • einloggen
  • Logout
  • Produkt
  • register-user
  • Rolle
  • show-user
  • Mieter

Darüber hinaus erfordern die folgenden azsphere device-Befehle auch eine Cloudverbindung:

Befehl azsphere device Kommentare
Fähigkeit Erfordert Den Azure Sphere-Sicherheitsdienst für den Download der Gerätefunktion.
Anspruch
enable-cloud-test
Enable-Development
Bild
Liste
Wiederherstellen Erfordert Internetkonnektivität, aber keine Anmeldung beim Azure Sphere-Sicherheitsdienst
Zeigen
show-count
show-deployment-status
show-os-version Erfordert Internetkonnektivität, aber keine Anmeldung beim Azure Sphere-Sicherheitsdienst
aktualisieren

Gerätefunktionsabhängige Befehle

Für die folgenden azsphere device-Befehle muss eine Gerätefunktion für Geräte im Fertigungszustand DeviceComplete verwendet werden:

Vorgang Beschreibung
App Verwalten von Anwendungen auf dem angeschlossenen Gerät.
Fähigkeit Verwalten von Gerätefunktionskonfigurationen. Erforderlich für Funktionsupdates.
Zertifikat Verwalten des Gerätezertifikatspeichers.
Bild Verwalten von Geräteimages
Fertigungszustand Verwalten sie den Fertigungsstatus angeschlossener Geräte. Erforderlich für die Aktualisierung des Fertigungszustands.
Neu starten Starten Sie das angeschlossene Gerät neu.
show-deployment-status Zeigen Sie die Bereitstellung status des Betriebssystems und der Anwendungen auf dem angeschlossenen Gerät an.
show-os-version Zeigen Sie die Betriebssystemversion auf dem angeschlossenen Gerät an.
Querladen Bereitstellen und Verwalten von Anwendungen auf dem angeschlossenen Gerät. Erforderlich für das Querladen von Bereitstellung und Querladen des Löschens.
WLAN Verwalten sie Wi-Fi Konfigurationen für das angeschlossene Gerät.

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