image-package
Viktigt!
Det här är dokumentationen om Azure Sphere (Legacy). Azure Sphere (Legacy) upphör den 27 september 2027 och användarna måste migrera till Azure Sphere (integrerad) vid den här tiden. Använd versionsväljaren ovanför TOC för att visa dokumentationen om Azure Sphere (integrerad).
Hanterar Azure Sphere-avbildningar på disk.
| Operation | beskrivning |
|---|---|
| pack-application | Skapar ett avbildningspaket. |
| pack-board-config | Skapar ett avbildningspaket för brädkonfiguration. |
| visa | Visar information om ett bildpaket. |
pack-application
Skapar ett körbart program från en kompilerad och länkad avbildning och en app_manifest.json fil.
Realtidskompatibla program (RTApps) skapas som ELF- eller AXF-filer och inte som råa binärfiler. Innan du paketerar en RTApp redigerar du programmanifestfilen så att ApplicationType är inställt på "RealTimeCapable" och EntryPoint är inställt på namnet på ELF- eller AXF-filen, som måste finnas i roten i programkatalogen.
Dricks
Det här kommandot körs när du skapar ett högnivåprogram eller ett realtidskompatibelt program med hjälp av Visual Studio Code eller Visual Studio.
- Byggprocessen skapar en approot<app-name-katalog> , som är den indatakatalog som anges i parametern
--package-directory. - Programmanifestfilen finns i parametern
--application-manifest. - För program på hög nivå tillhandahålls en programkörningsversion i parametern
--target-api-set.
Obligatoriska parametrar
| Parameter | Typ | Beskrivning |
|---|---|---|
| --destination | Sökväg till avbildningspaket | Anger en sökväg och filnamn för utdatabildpaketet. |
| --package-directory | Sökväg till approot_folder | Identifierar indatakatalogen, som används som systemrot för Azure Sphere-avbildningsfilen. Den app_manifest.json filen för programmet måste finnas i den här katalogen. |
Valfria parametrar
| Parameter | Typ | Beskrivning |
|---|---|---|
| -a, --application-manifest | String | Anger sökvägen till programmanifestfilen. Det kan vara en JSON-fil eller en katalog som innehåller app_manifest.json. Du kan ange en relativ eller absolut sökväg. |
| --hardware-definitions | String | Anger en valfri blankstegsavgränsad lista över sökvägar till de kataloger som innehåller JSON-filer (maskinvarudefinition). Värdena från filerna används för att mappa kringutrustningsnamn i app_manifest.json till underliggande värden. Du kan ange en relativ eller absolut sökväg. Mer information finns i maskinvarudefinitionen . |
| --target-api-set | String | Anger namnet på mål-API-uppsättningen som användes under kompilering. Krävs för högnivåappar om de inte anges i appmanifestet. Krävs inte för RTApps. |
| --target-definition-filename | String | Anger namnet på den maskinvarumåldefinitionsfil som används för att mappa kringutrustningsnamn i app_manifest.json. Det måste anges om programmet använder maskinvarudefinitioner. |
| -x, --executables | körbar1,körbar2 ... | Anger sökvägarna till en eller flera filer som ska markeras som körbara i avbildningspaketet. EntryPoint som anges i app_manifest-filerna är alltid markerad som körbar, så flaggan -x krävs endast om det finns andra körbara filer. Som standard kan filer inte köras när de paketeras till en avbildning. Undersökvägarna är relativa till sökvägen till de körbara objekten. Sökvägarna kan använda antingen Windows-filnamnssyntax (omvänt snedstreck) eller Linux-filnamnssyntax (snedstreck). blanksteg, kommatecken och semikolon tillåts inte. Du kan antingen ange -x för varje körbar fil eller bara använda den en gång och ange flera sökvägar avgränsade med kommatecken utan mellanliggande blanksteg. |
Globala parametrar
Följande globala parametrar är tillgängliga för Azure Sphere CLI:
| Parameter | Description |
|---|---|
| --felsöka | Ökar loggningsverositeten för att visa alla felsökningsloggar. Om du hittar en bugg kan du tillhandahålla utdata som genererats med flaggan --debug när du skickar en felrapport. |
| -h, --help | Skriver ut CLI-referensinformation om kommandon och deras argument och listar tillgängliga undergrupper och kommandon. |
| --only-show-errors | Visar endast fel och undertrycker varningar. |
| -o, --output | Ändrar utdataformatet. De tillgängliga utdataformaten är json, jsonc (colorized JSON), tsv (Tab-Separated Values), table (human-readable ASCII tables) och yaml. Som standard matar CLI ut table. Mer information om tillgängliga utdataformat finns i Utdataformat för Azure Sphere CLI-kommandon. |
| --fråga | Använder JMESPath-frågespråket för att filtrera utdata som returneras från Azure Sphere Security Services. Mer information och exempel finns i JMESPath-självstudien och Fråga azure CLI-kommandoutdata . |
| --mångordig | Skriver ut information om resurser som skapats i Azure Sphere under en åtgärd och annan användbar information. Visa fullständiga felsökningsloggar genom att köra --debug. |
Kommentar
Om du använder klassiska Azure Sphere CLI kan du läsa Globala parametrar för mer information om tillgängliga alternativ.
Exempel
azsphere image-package pack-application --package-directory C:\AppSamples\LocalSamples\HelloWorld\HelloWorld_HighLevelApp\out\ARM-Debug\approotHelloWorld_HighLevelApp --destination myimage.imagepackage
pack-board-config
Skapar ett avbildningspaket för brädkonfiguration. Du kan antingen använda en förinställd brädkonfigurationsbild eller ange en anpassad konfigurationsbild.
Obligatoriska parametrar
| Parameter | Typ | Beskrivning |
|---|---|---|
| --destination | String | Anger en sökväg till utdatafilnamnet för det resulterande avbildningspaketet. |
Valfria parametrar
| Parameter | Typ | Beskrivning |
|---|---|---|
| --board-config-file | Sökväg | Identifierar sökvägen till brädkonfigurationsbilden. Om detta ingår --preset får inte användas. De två parametrarna är ömsesidigt uteslutande. |
| -n, --name | String | Anger avbildningspaketnamnet i den skapade filens metadata. Om det inte anges genereras ett nytt namn baserat på den angivna brädkonfigurationen, som innehåller en del av komponent-ID:t för unikhet. |
| -p, --preset | String | Tillhandahåller ID:t för den förinställda brädkonfigurationsbilden som ska tillämpas. Ange antingen ID:t för ett förinställt paket eller ange en sökväg för brädkonfigurationsfilen med parametern --board-config-file för en anpassad brädkonfigurationsbild. ID:t är ett uppräkningsvärde och är för närvarande fast i det enskilda värdet lan-enc28j60-isu0-int5. |
Globala parametrar
Följande globala parametrar är tillgängliga för Azure Sphere CLI:
| Parameter | Description |
|---|---|
| --felsöka | Ökar loggningsverositeten för att visa alla felsökningsloggar. Om du hittar en bugg kan du tillhandahålla utdata som genererats med flaggan --debug när du skickar en felrapport. |
| -h, --help | Skriver ut CLI-referensinformation om kommandon och deras argument och listar tillgängliga undergrupper och kommandon. |
| --only-show-errors | Visar endast fel och undertrycker varningar. |
| -o, --output | Ändrar utdataformatet. De tillgängliga utdataformaten är json, jsonc (colorized JSON), tsv (Tab-Separated Values), table (human-readable ASCII tables) och yaml. Som standard matar CLI ut table. Mer information om tillgängliga utdataformat finns i Utdataformat för Azure Sphere CLI-kommandon. |
| --fråga | Använder JMESPath-frågespråket för att filtrera utdata som returneras från Azure Sphere Security Services. Mer information och exempel finns i JMESPath-självstudien och Fråga azure CLI-kommandoutdata . |
| --mångordig | Skriver ut information om resurser som skapats i Azure Sphere under en åtgärd och annan användbar information. Visa fullständiga felsökningsloggar genom att köra --debug. |
Kommentar
Om du använder klassiska Azure Sphere CLI kan du läsa Globala parametrar för mer information om tillgängliga alternativ.
Exempel
azsphere image-package pack-board-config --preset lan-enc28j60-isu0-int5 --destination board2.imagepackage
visa
Visar information om ett bildpaket.
Obligatoriska parametrar
| Parameter | Typ | Beskrivning |
|---|---|---|
| -f, --image-package | String | Anger sökvägen till avbildningspaketet. Du kan ange en relativ eller absolut sökväg. |
Globala parametrar
Följande globala parametrar är tillgängliga för Azure Sphere CLI:
| Parameter | Description |
|---|---|
| --felsöka | Ökar loggningsverositeten för att visa alla felsökningsloggar. Om du hittar en bugg kan du tillhandahålla utdata som genererats med flaggan --debug när du skickar en felrapport. |
| -h, --help | Skriver ut CLI-referensinformation om kommandon och deras argument och listar tillgängliga undergrupper och kommandon. |
| --only-show-errors | Visar endast fel och undertrycker varningar. |
| -o, --output | Ändrar utdataformatet. De tillgängliga utdataformaten är json, jsonc (colorized JSON), tsv (Tab-Separated Values), table (human-readable ASCII tables) och yaml. Som standard matar CLI ut table. Mer information om tillgängliga utdataformat finns i Utdataformat för Azure Sphere CLI-kommandon. |
| --fråga | Använder JMESPath-frågespråket för att filtrera utdata som returneras från Azure Sphere Security Services. Mer information och exempel finns i JMESPath-självstudien och Fråga azure CLI-kommandoutdata . |
| --mångordig | Skriver ut information om resurser som skapats i Azure Sphere under en åtgärd och annan användbar information. Visa fullständiga felsökningsloggar genom att köra --debug. |
Kommentar
Om du använder klassiska Azure Sphere CLI kan du läsa Globala parametrar för mer information om tillgängliga alternativ.
Exempel
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