Migrieren von der klassischen CLI zur Azure Sphere-CLI

  • Artikel

Wenn Sie weiterhin die klassische Azure Sphere-CLI verwenden, wird empfohlen, zur neuen Azure Sphere-CLI zu migrieren. Derzeit können beide Versionen der CLI parallel installiert und verwendet werden, aber die klassische CLI wird nicht mehr aktualisiert oder verwaltet und wird zu einem späteren Zeitpunkt (nicht vor Ende 2022) aus dem SDK entfernt. Wir empfehlen Ihnen, sich mit diesen Unterschieden vertraut zu machen und Ihre Prozesse und Skripts vor Ende 2022 zu migrieren, um Unterbrechungen zu vermeiden.

Informationen zum Aktualisieren auf das neueste SDK finden Sie unter Installieren des Azure Sphere SDK unter Linux oder Installieren eines Azure Sphere SDK für Windows.

Verwenden Sie PowerShell oder eine Standardmäßige Windows-Eingabeaufforderung, um die Azure Sphere CLI unter Windows zu verwenden. Verwenden Sie für Linux eine beliebige Befehlsshell. Weitere Informationen finden Sie unter Ausführen der Azure Sphere-CLI.

Unter Windows kann die eingestellte benutzerdefinierte klassische Azure Sphere Developer-Eingabeaufforderung (als Verknüpfung im Startmenü unter Azure Sphere verfügbar) nur mit der klassischen Azure Sphere-Befehlszeilenschnittstelle verwendet werden. Weitere Informationen finden Sie unter Ausführen der klassischen Azure Sphere-CLI.

Wichtige Unterschiede

  • In der klassischen Azure Sphere-Befehlszeilenschnittstelle können mehrere Parameter verwendet werden, um jeden Objekttyp zu identifizieren. In der Azure Sphere-CLI wird ein einzelner Parameter verwendet, um jeden Objekttyp zu identifizieren. Dies bedeutet, dass Sie entweder den Namen oder die ID verwenden können, um den Parameterwert anzugeben. Dies wurde für die --deviceParameter , --tenant, --productund --device-group implementiert.

    Objekttyp Azure Sphere CLI Klassische Azure Sphere-CLI (außerBetriebnahme)
    Gerät --device --deviceid, --deviceipoder --devicelocation
    Gerätegruppe --device-group --devicegroupid Oder --devicegroupname
    Produkt --product --productid Oder --productname
    Mieter --tenant --tenantid

  • Kurzform für Befehle wird in der klassischen Version unterstützt. In der Azure Sphere-Befehlszeilenschnittstelle wird empfohlen, die Tabstopp-Vervollständigung oder interaktive Funktion zu verwenden, um die Liste der verfügbaren Befehle anzuzeigen. In der klassischen CLI können Sie beispielsweise den azsphere device enable-development Befehl oder azsphere dev edv verwenden, während Sie in der neuen Azure Sphere-BEFEHLSZEILEnschnittstelle autoVervollständigen verwenden können, um den azsphere device enable-development Befehl schnell einzugeben.

  • 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

  • In der neuen CLI wird der Standardmandant nicht automatisch ausgewählt, wenn ein Mandant erstellt wird. Sie müssen den Befehl azsphere tenant select ausführen, um den Standardmandanten auszuwählen, der für den aktuellen Benutzer auf dem PC verwendet werden soll. Dadurch wird sichergestellt, dass der Standardmandant der richtige ist, der beim Ausführen eines einmaligen Vorgangs verwendet werden kann, den Sie nicht rückgängig machen können, wie das Gerät beansprucht wird.

    Bei Verwendung von Skripts können Sie den Standardmandanten mithilfe des --tenant <tenant ID or tenant name> Parameters auswählen.

    Legen Sie den Standardmandanten am Anfang des Skripts fest, indem Sie Folgendes verwenden:

    azsphere tenant select --tenant <tenant ID or tenant name>

    Sie können auch den Standardmandanten überschreiben oder den erforderlichen Mandanten angeben, wenn Sie den Befehl ausführen. Zum Beispiel:

    azsphere get-support-data --destination logs.zip --tenant <tenant ID or tenant name>

  • Der --device-group Parameter identifiziert die Gerätegruppe. Die Gerätegruppen-ID stellt eine GUID bereit, die die Gerätegruppe für alle Produkte eindeutig identifiziert. Alternativ können Sie das Paar Produktname und Gerätegruppenname im <Format product-name>/<device-group-name> verwenden. Dieses Namenspaar identifiziert eindeutig eine Gerätegruppe für ein bestimmtes Produkt.

  • Die folgenden Befehle waren Verbundbefehle in der klassischen CLI. Dies bedeutet, dass ein Befehl mehrere Aufgaben ausgeführt hat. In der neuen CLI müssen Sie die beiden Befehle ausführen.

    • In der klassischen CLI hat der Befehl azsphere device-group deployment create das Imagepaket hochgeladen und eine neue Bereitstellung erstellt.

      In der neuen CLI müssen Sie Folgendes ausführen:

      1. Laden Sie das Imagepaket mithilfe von azsphere image add in Ihren Azure Sphere-Mandanten hoch.
      2. Erstellen Sie mithilfe von azsphere device-group deployment create eine neue Bereitstellung für eine Gerätegruppe für die hochgeladenen Images.

    • In der klassischen CLI wurde der Befehl azsphere device capability download --select heruntergeladen und vorübergehend die Gerätefunktionskonfiguration für das angeschlossene Gerät ausgewählt.

      In der neuen CLI müssen Sie Folgendes ausführen:

      1. Laden Sie die Funktionsdatei mithilfe von azsphere device capability download herunter.
      2. Wählen Sie die Funktion mithilfe von azsphere device capability select aus.

    • In der klassischen CLI wurde der Befehl azsphere device capability download --apply heruntergeladen und die Gerätefunktionskonfiguration für das angeschlossene Gerät angewendet.

      In der neuen CLI müssen Sie Folgendes ausführen:

      1. Laden Sie die Funktionsdatei mithilfe von azsphere device capability download herunter.
      2. Wenden Sie die Funktion mithilfe von azsphere device capability update an.

  • In der klassischen CLI wird der -o Parameter oder --output verwendet, um einen Pfad und Dateinamen anzugeben, unter dem eine Datei gespeichert werden soll. In der neuen Azure Sphere-CLI werden kontextspezifische Parameter verwendet, z --destination . B. zum Angeben von Eingabe- und Ausgabepfaden.

  • In der klassischen CLI wird der -d Parameter oder --debug im Befehl azsphere device app start verwendet, um die Anwendung im Debugmodus zu starten. In der neuen Azure Sphere-CLI wird der --debug-mode Parameter verwendet, um die Anwendung im Debugmodus zu starten, und der --debug Parameter wird als globaler Parameter verwendet, um die Ausführlichkeit der Protokollierung zu erhöhen, um alle Debugprotokolle anzuzeigen.

  • In der klassischen CLI gibt es keine Kontrolle über das Ausgabeformat. In der Azure Sphere-CLI wird der -o - oder --output -Parameter verwendet, um das Ausgabeformat anzugeben, in dem die CLI-Ausgabe formatiert werden soll.

  • Ab Release 21.02 wurden explizite Versionsnummern aus den Azure Sphere CLI-Produktnamen entfernt. Diese Änderung beseitigt Verwirrung bei der Bezugnahme auf die verschiedenen Versionen des Produkts.

    • Azure Sphere CLI v2 und höher wird jetzt nur noch als "Azure Sphere CLI" bezeichnet.
    • Frühere Azure Sphere CLI-Versionen (CLI v1 und niedriger) werden jetzt als "klassische Azure Sphere-CLI" bezeichnet.

  • Wenn Sie Skripts verwenden, sind diese aufgrund der oben erläuterten Unterschiede möglicherweise nicht mit der neuen Azure Sphere CLI kompatibel. Nehmen Sie erforderliche Updates vor, damit die Skripts in der neuen CLI ordnungsgemäß ausgeführt werden.

Siehe auch