Freigeben über

image-package

  • Artikel

Verwaltet Azure Sphere-Images auf dem Datenträger.

Vorgang Beschreibung
pack-application Erstellt ein Imagepaket.
pack-board-config Erstellt ein Imagepaket für die Boardkonfiguration.
Zeigen Zeigt Details zu einem Bildpaket an.

pack-application

Erstellt eine ausführbare Anwendung aus einem kompilierten und verknüpften Image und einer app_manifest.json-Datei.

Echtzeitfähige Anwendungen (RTApps) werden als ELF- oder AXF-Dateien und nicht als unformatierte Binärdateien erstellt. Bearbeiten Sie vor dem Packen einer RTApp die Anwendungsmanifestdatei so, dass ApplicationType auf "RealTimeCapable" und EntryPoint auf den Namen der ELF- oder AXF-Datei festgelegt ist, die sich im Stammverzeichnis des Anwendungsverzeichnisses befinden muss.

Tipp

Dieser Befehl wird ausgeführt, wenn Sie eine allgemeine Anwendung oder eine Echtzeitanwendung mit Visual Studio Code oder Visual Studio erstellen.

  • Beim Buildprozess wird ein Approot-App-Name-Verzeichnis<> erstellt, bei dem es sich um das im --package-directory Parameter angegebene Eingabeverzeichnis handelt.
  • Die Anwendungsmanifestdatei wird im --application-manifest -Parameter bereitgestellt.
  • Für allgemeine Anwendungen wird eine Laufzeitversion der --target-api-set Anwendung im -Parameter bereitgestellt.

Erforderliche Parameter

Parameter Typ Beschreibung
--Ziel Pfad zum Imagepaket Gibt einen Pfad und Dateinamen für das Ausgabeimagepaket an.
--package-directory Pfad zu approot_folder Gibt das Eingabeverzeichnis an, das als Systemstamm für die Azure Sphere-Imagedatei verwendet wird. Die Datei app_manifest.json für die Anwendung muss sich in diesem Verzeichnis befinden.

Optionale Parameter

Parameter Typ Beschreibung
-a, --application-manifest Schnur Gibt den Pfad zur Anwendungsmanifestdatei an. Dies kann eine JSON-Datei oder ein Verzeichnis sein, das app_manifest.json enthält. Sie können einen relativen oder absoluten Pfad angeben.
--hardware-definitions Schnur Gibt eine optionale, durch Leerzeichen getrennte Liste von Pfaden zu den Verzeichnissen an, die JSON-Dateien (Hardwaredefinitionsdateien) enthalten. Die Werte aus den Dateien werden verwendet, um Peripherienamen in app_manifest.json zugrunde liegenden Werten zuzuordnen. Sie können einen relativen oder absoluten Pfad angeben. Weitere Informationen finden Sie unter Hardwaredefinition .
--target-api-set Schnur Gibt den Namen des ZIEL-API-Satzes an, der während der Kompilierung verwendet wird. Erforderlich für allgemeine Apps, wenn sie nicht im App-Manifest angegeben sind. Für RTApps nicht erforderlich.
--target-definition-filename Schnur Gibt den Namen der Hardwarezieldefinitionsdatei an, die zum Zuordnen von Peripherienamen in app_manifest.json verwendet wird. Sie muss bereitgestellt werden, wenn die Anwendung Hardwaredefinitionen verwendet.
-x, --executables executable1,executable2 ... Gibt die Pfade zu einer oder mehreren Dateien an, die im Imagepaket als ausführbare Datei markiert werden sollen. Der im app_manifest Dateien aufgeführte EntryPoint ist immer als ausführbare Datei gekennzeichnet, sodass das Flag -x nur erforderlich ist, wenn andere ausführbare Dateien vorhanden sind.
Standardmäßig sind Dateien nicht ausführbar, wenn sie in ein Image gepackt werden. Die Unterpfade sind relativ zum Pfad der ausführbaren Dateien. Die Pfade können entweder die Windows-Dateinamensyntax (umgekehrte Schrägstriche) oder die Linux-Dateinamensyntax (Schrägstriche) verwenden. Leerzeichen, Kommas und Semikolons sind nicht zulässig. Sie können entweder -x für jede ausführbare Datei angeben oder sie nur einmal verwenden und mehrere Pfade angeben, die durch Kommas getrennt sind, ohne Zwischenzeichen zu verwenden.
Globale Parameter

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

Parameter Beschreibung
--Debuggen Erhöht die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen. Wenn Sie einen Fehler finden, geben Sie beim Übermitteln eines Fehlerberichts die mit dem --debug Flag generierte Ausgabe an.
-h, --help Gibt CLI-Referenzinformationen zu Befehlen und deren Argumenten aus und listet verfügbare Untergruppen und Befehle auf.
--only-show-errors Zeigt nur Fehler an, wobei Warnungen unterdrückt werden.
-o, --output Ändert das Ausgabeformat. Die verfügbaren Ausgabeformate sind json, jsonc (colorized JSON), tsv (Tab-Separated Values), table (für Menschen lesbare ASCII-Tabellen) und yaml. Standardmäßig gibt die CLI aus table. Weitere Informationen zu den verfügbaren Ausgabeformaten finden Sie unter Ausgabeformat für Azure Sphere-CLI-Befehle.
--Abfrage Verwendet die JMESPath-Abfragesprache, um die von Azure Sphere Security Services zurückgegebene Ausgabe zu filtern. Weitere Informationen und Beispiele finden Sie unter JMESPath-Tutorial und Abfragen der Azure CLI-Befehlsausgabe .
--Ausführliche Gibt Informationen zu Ressourcen aus, die während eines Vorgangs in Azure Sphere erstellt wurden, sowie andere nützliche Informationen. Verwenden Sie --debug für vollständige Debugprotokolle.

Hinweis

Wenn Sie die klassische Azure Sphere-CLI verwenden, finden Sie unter Globale Parameter weitere Informationen zu den verfügbaren Optionen.

Beispiel

azsphere image-package pack-application --package-directory C:\AppSamples\LocalSamples\HelloWorld\HelloWorld_HighLevelApp\out\ARM-Debug\approotHelloWorld_HighLevelApp --destination myimage.imagepackage

pack-board-config

Erstellt ein Imagepaket für die Boardkonfiguration. Sie können entweder ein voreingestelltes Boardkonfigurationsimage verwenden oder ein benutzerdefiniertes Konfigurationsimage bereitstellen.

Erforderliche Parameter

Parameter Typ Beschreibung
--Ziel Schnur Gibt einen Pfad zum Ausgabedateinamen für das resultierende Imagepaket an.

Optionale Parameter

Parameter Typ Beschreibung
--board-config-file Pfad Gibt den Pfad zum Boardkonfigurationsimage an. Wenn dies enthalten ist, --preset darf nicht verwendet werden. Die beiden Parameter schließen sich gegenseitig aus.
-n, --name Schnur Legt den Imagepaketnamen in den Metadaten der erstellten Datei fest. Falls nicht angegeben, wird ein neuer Name basierend auf der bereitgestellten Boardkonfiguration generiert, der einen Teil der Komponenten-ID aus Gründen der Eindeutigkeit einbezieht.
-p, --preset Schnur Stellt die ID des voreingestellten Boardkonfigurationsimages bereit, das angewendet werden soll. Geben Sie entweder die ID eines voreingestellten Pakets ein, oder geben Sie einen Pfad für die Boardkonfigurationsdatei an, indem Sie den --board-config-file Parameter für ein benutzerdefiniertes Boardkonfigurationsimage verwenden. Die ID ist ein Enumerationswert und wird derzeit auf den einzelnen Wert lan-enc28j60-isu0-int5festgelegt.
Globale Parameter

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

Parameter Beschreibung
--Debuggen Erhöht die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen. Wenn Sie einen Fehler finden, geben Sie beim Übermitteln eines Fehlerberichts die mit dem --debug Flag generierte Ausgabe an.
-h, --help Gibt CLI-Referenzinformationen zu Befehlen und deren Argumenten aus und listet verfügbare Untergruppen und Befehle auf.
--only-show-errors Zeigt nur Fehler an, wobei Warnungen unterdrückt werden.
-o, --output Ändert das Ausgabeformat. Die verfügbaren Ausgabeformate sind json, jsonc (colorized JSON), tsv (Tab-Separated Values), table (für Menschen lesbare ASCII-Tabellen) und yaml. Standardmäßig gibt die CLI aus table. Weitere Informationen zu den verfügbaren Ausgabeformaten finden Sie unter Ausgabeformat für Azure Sphere-CLI-Befehle.
--Abfrage Verwendet die JMESPath-Abfragesprache, um die von Azure Sphere Security Services zurückgegebene Ausgabe zu filtern. Weitere Informationen und Beispiele finden Sie unter JMESPath-Tutorial und Abfragen der Azure CLI-Befehlsausgabe .
--Ausführliche Gibt Informationen zu Ressourcen aus, die während eines Vorgangs in Azure Sphere erstellt wurden, sowie andere nützliche Informationen. Verwenden Sie --debug für vollständige Debugprotokolle.

Hinweis

Wenn Sie die klassische Azure Sphere-CLI verwenden, finden Sie unter Globale Parameter weitere Informationen zu den verfügbaren Optionen.

Beispiel

azsphere image-package pack-board-config --preset lan-enc28j60-isu0-int5 --destination board2.imagepackage

Zeigen

Zeigt Informationen zu einem Bildpaket an.

Erforderliche Parameter

Parameter Typ Beschreibung
-f, --image-package Schnur Gibt den Pfad zum Imagepaket an. Sie können einen relativen oder absoluten Pfad angeben.
Globale Parameter

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

Parameter Beschreibung
--Debuggen Erhöht die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen. Wenn Sie einen Fehler finden, geben Sie beim Übermitteln eines Fehlerberichts die mit dem --debug Flag generierte Ausgabe an.
-h, --help Gibt CLI-Referenzinformationen zu Befehlen und deren Argumenten aus und listet verfügbare Untergruppen und Befehle auf.
--only-show-errors Zeigt nur Fehler an, wobei Warnungen unterdrückt werden.
-o, --output Ändert das Ausgabeformat. Die verfügbaren Ausgabeformate sind json, jsonc (colorized JSON), tsv (Tab-Separated Values), table (für Menschen lesbare ASCII-Tabellen) und yaml. Standardmäßig gibt die CLI aus table. Weitere Informationen zu den verfügbaren Ausgabeformaten finden Sie unter Ausgabeformat für Azure Sphere-CLI-Befehle.
--Abfrage Verwendet die JMESPath-Abfragesprache, um die von Azure Sphere Security Services zurückgegebene Ausgabe zu filtern. Weitere Informationen und Beispiele finden Sie unter JMESPath-Tutorial und Abfragen der Azure CLI-Befehlsausgabe .
--Ausführliche Gibt Informationen zu Ressourcen aus, die während eines Vorgangs in Azure Sphere erstellt wurden, sowie andere nützliche Informationen. Verwenden Sie --debug für vollständige Debugprotokolle.

Hinweis

Wenn Sie die klassische Azure Sphere-CLI verwenden, finden Sie unter Globale Parameter weitere Informationen zu den verfügbaren Optionen.

Beispiel

azsphere image-package show --image-package C:\sample\quickstart_steps\QuickStart-AzureSphereBlink1\QuickStart-AzureSphereBlink1\out\ARM-Debug\QuickStart-AzureSphereBlink1.imagepackage
Image package metadata:
  Section: Identity
    Image Type:           Application
    Component ID:         99d419ef-296d-43b0-ade1-809efe3a7aba
    Image ID:             d788fdd1-28eb-4477-9818-a4734289f2f1
  Section: Signature
    Signing Type:         ECDsa256
    Cert:                 a8d5cc6958f48710140d7a26160fc1cfc31f5df0
  Section: Debug
    Image Name:           QuickStart-AzureSphereBlink1
    Built On (UTC):       09/07/2020 13:18:52
    Built On (Local):     09/07/2020 14:18:52
  Section: Temporary Image
    Remove image at boot: False
    Under development:    True
  Section: ABI Depends
    Depends on:           ApplicationRuntime, version 5