image-package
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.
Verwaltet Azure Sphere-Images auf dem Datenträger.
| Vorgang | Beschreibung |
|---|---|
| pack-application | Erstellt ein Bildpaket. |
| pack-board-config | Erstellt ein Imagepaket mit der Board-Konfiguration. |
| show | Zeigt Details zu einem Bildpaket an. |
pack-application
Erstellt eine ausführbare Anwendung aus einem kompilierten und verknüpften Image und eine Datei „app_manifest.json“.
Echtzeitfähige Anwendungen (RTApps) werden als ELF- oder AXF-Dateien und nicht als unformatierte Binärdateien erstellt. Bearbeiten Sie die Anwendungsmanifestdatei vor dem Packen einer RTApp so, dass ApplicationType auf „RealTimeCapable“ und EntryPoint auf den Namen der ELF- oder AXF-Datei festgelegt ist, die im Stammverzeichnis des Anwendungsverzeichnisses enthalten sein muss.
Tipp
Dieser Befehl wird ausgeführt, wenn Sie eine high-level-Anwendung oder eine Echtzeit-fähige Anwendung mit Visual Studio Code oder Visual Studio erstellen.
- Der Buildprozess erstellt ein Approot-App-Name-Verzeichnis<>, bei dem es sich um das im
--package-directoryParameter angegebene Eingabeverzeichnis handelt. - Die Anwendungsmanifestdatei wird im
--application-manifestParameter bereitgestellt. - Für anwendungen auf hoher Ebene wird eine Anwendungslaufzeitversion im
--target-api-setParameter bereitgestellt.
Erforderliche Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| --Bestimmungsort | Pfad zum Bildpaket | Gibt einen Pfad und Dateinamen für das Imageausgabepaket an. |
| --package-directory | Pfad zu approot_folder | Identifiziert das Eingangsverzeichnis, das als Systemstammverzeichnis 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 | String | 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. |
| --Hardwaredefinitionen | String | Gibt eine optionale, durch Leerzeichen getrennte Liste von Pfaden zu den Verzeichnissen an, die JSON-Dateien (Hardwaredefinition) 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 | String | 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 | String | 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, --ausführbare Dateien | ausführbare Datei1,ausführbare2 ... | Gibt die Pfade zu einer oder mehreren Dateien an, die im Bildpaket als ausführbare Datei markiert werden sollen. Der in den „app_manifest“-Dateien aufgeführte EntryPoint wird immer als ausführbar gekennzeichnet. Daher wird das Flag „-x“ nur benötigt, wenn andere ausführbare Dateien vorhanden sind. Standardmäßig sind Dateien keine ausführbaren Dateien, wenn sie in einem Image verpackt sind. Die Unterpfade sind relativ zum Pfad der ausführbaren Dateien. Für die Pfade kann entweder die Syntax für Dateinamen unter Windows (umgekehrte Schrägstriche) oder die Syntax für Dateinamen unter Linux (Schrägstriche) verwendet werden. Leerzeichen, Kommas und Semikolons sind nicht zulässig. Sie können „-x“ entweder für jede ausführbare Datei angeben oder nur einmal verwenden und mehrere durch Kommas ohne dazwischenliegende Leerzeichen getrennte Pfade angeben. |
Globale Parameter
Die folgenden globalen Parameter sind für die Azure Sphere CLI verfügbar:
| Parameter | Beschreibung |
|---|---|
| --debug | Erhöht die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen. Wenn ein Fehler auftritt, stellen Sie beim Übermitteln eines Fehlerberichts die mit dem Flag --debug generierte Ausgabe bereit. |
| -h, --help | Druckt CLI-Referenzinformationen zu Befehlen und deren Argumenten und Listen verfügbarer Untergruppen und Befehle. |
| --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 (human-lesbare ASCII-Tabellen) und Yaml. Die CLI gibt standardmäßig table aus. Weitere Informationen zu den verfügbaren Ausgabeformaten finden Sie unter Ausgabeformat für Azure Sphere CLI-Befehle. |
| --query | Verwendet die JMESPath-Abfragesprache, um die von Azure Sphere Security Services zurückgegebene Ausgabe zu filtern. Weitere Informationen und Beispiele finden Sie im JMESPath-Lernprogramm und in der Abfrage der Azure CLI-Befehlsausgabe . |
| --verbose | Druckt Informationen zu Ressourcen, die während eines Vorgangs in Azure Sphere erstellt wurden, und andere nützliche Informationen. Verwenden Sie --debug, um vollständige Debugprotokolle zu erhalten. |
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 mit der Board-Konfiguration. Sie können entweder ein voreingestelltes Board-Konfigurationsimage verwenden oder ein benutzerdefiniertes Konfigurationsimage angeben.
Erforderliche Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| --Bestimmungsort | String | Gibt einen Pfad zum Ausgabedateinamen für das resultierende Bildpaket an. |
Optionale Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| --board-config-file | Pfad | Gibt den Pfad zum Board-Konfigurationsimage an. Wenn dies enthalten ist, --preset darf nicht verwendet werden; die beiden Parameter schließen sich gegenseitig aus. |
| -n, --name | String | Legt den Namen des Imagepakets in den Metadaten der erstellten Datei fest. Wenn nicht angegeben, wird ein neuer Name basierend auf der bereitgestellten Boardkonfiguration generiert, der einen Teil der Komponenten-ID zur Eindeutigkeit enthält. |
| -p, --preset | String | Gibt die ID des voreingestellten Board-Konfigurationsimages an, das angewendet werden soll. Geben Sie entweder die ID eines voreingestellten Pakets ein, oder geben Sie einen Pfad für die Boardkonfigurationsdatei mithilfe des --board-config-file Parameters für ein benutzerdefiniertes Boardkonfigurationsimage an. 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 |
|---|---|
| --debug | Erhöht die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen. Wenn ein Fehler auftritt, stellen Sie beim Übermitteln eines Fehlerberichts die mit dem Flag --debug generierte Ausgabe bereit. |
| -h, --help | Druckt CLI-Referenzinformationen zu Befehlen und deren Argumenten und Listen verfügbarer Untergruppen und Befehle. |
| --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 (human-lesbare ASCII-Tabellen) und Yaml. Die CLI gibt standardmäßig table aus. Weitere Informationen zu den verfügbaren Ausgabeformaten finden Sie unter Ausgabeformat für Azure Sphere CLI-Befehle. |
| --query | Verwendet die JMESPath-Abfragesprache, um die von Azure Sphere Security Services zurückgegebene Ausgabe zu filtern. Weitere Informationen und Beispiele finden Sie im JMESPath-Lernprogramm und in der Abfrage der Azure CLI-Befehlsausgabe . |
| --verbose | Druckt Informationen zu Ressourcen, die während eines Vorgangs in Azure Sphere erstellt wurden, und andere nützliche Informationen. Verwenden Sie --debug, um vollständige Debugprotokolle zu erhalten. |
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
show
Zeigt Informationen zu einem Imagepaket an.
Erforderliche Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| -f, --image-package | String | 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 |
|---|---|
| --debug | Erhöht die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen. Wenn ein Fehler auftritt, stellen Sie beim Übermitteln eines Fehlerberichts die mit dem Flag --debug generierte Ausgabe bereit. |
| -h, --help | Druckt CLI-Referenzinformationen zu Befehlen und deren Argumenten und Listen verfügbarer Untergruppen und Befehle. |
| --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 (human-lesbare ASCII-Tabellen) und Yaml. Die CLI gibt standardmäßig table aus. Weitere Informationen zu den verfügbaren Ausgabeformaten finden Sie unter Ausgabeformat für Azure Sphere CLI-Befehle. |
| --query | Verwendet die JMESPath-Abfragesprache, um die von Azure Sphere Security Services zurückgegebene Ausgabe zu filtern. Weitere Informationen und Beispiele finden Sie im JMESPath-Lernprogramm und in der Abfrage der Azure CLI-Befehlsausgabe . |
| --verbose | Druckt Informationen zu Ressourcen, die während eines Vorgangs in Azure Sphere erstellt wurden, und andere nützliche Informationen. Verwenden Sie --debug, um vollständige Debugprotokolle zu erhalten. |
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