image-package
重要
這是 Azure Sphere （舊版） 檔。 Azure Sphere（舊版）將於 2027 年 9 月 27 日淘汰，且使用者此時必須移轉至 Azure Sphere（整合式）。 使用位於 TOC 上方的版本選取器來檢視 Azure Sphere （整合式） 檔。
管理磁碟上的 Azure Sphere 映像。
| 作業 | 描述 |
|---|---|
| pack-application | 建立映像套件。 |
| pack-board-config | 建立面板組態映像套件。 |
| show | 顯示映像套件的詳細數據。 |
pack-application
從已編譯和連結的映像和app_manifest.json檔案建立可執行的應用程式。
即時可用的應用程式 （RTApps） 會建置為 ELF 或 AXF 檔案，而不是原始二進位檔。 封裝 RTApp 之前，請編輯應用程式指令清單檔， 讓 ApplicationType 設定為 “RealTimeCapable”，而 EntryPoint 會設定為 ELF 或 AXF 檔案的名稱，該檔案必須位於應用程式目錄的根目錄中。
提示
當您使用 Visual Studio Code 或 Visual Studio 建置 高階應用程式 或 即時可用的應用程式 時，會執行此命令。
- 建置程式會建立approot<應用程式名稱> 目錄，這是參數中指定的
--package-directory輸入目錄。 - 應用程式指令清單檔會在 參數中
--application-manifest提供。 - 針對高階應用程式，會在參數中
--target-api-set提供應用程式運行時間版本。
必要參數
| 參數 | 類型 | 描述 |
|---|---|---|
| --目的地 | 映像套件的路徑 | 指定輸出映像套件的路徑和檔名。 |
| --package-directory | approot_folder路徑 | 識別輸入目錄，此目錄會作為 Azure Sphere 映像檔的系統根目錄。 應用程式的app_manifest.json檔案必須位於此目錄中。 |
選擇性參數
| 參數 | 類型 | 描述 |
|---|---|---|
| -a， --application-manifest | String | 指定應用程式指令清單檔的路徑。 這可以是 JSON 檔案或包含app_manifest.json的目錄。 您可以提供相對或絕對路徑。 |
| --hardware-definitions | String | 指定包含硬體定義 （JSON） 檔案之目錄路徑的選擇性空格分隔清單。 檔案中的值可用來將app_manifest.json中的周邊名稱對應至基礎值。 您可以提供相對或絕對路徑。 如需詳細資訊，請參閱 硬體定義 。 |
| --target-api-set | String | 指定編譯期間使用的目標 API 集合名稱。 如果應用程式指令清單中未指定，則為高階應用程式的必要專案。 RTApps 不需要。 |
| --target-definition-filename | String | 指定用來對應app_manifest.json中周邊名稱的硬體目標定義檔名稱。 如果應用程式使用硬體定義，則必須提供它。 |
| -x、 --executables | executable1，executable2 ... | 指定要在映像套件中標示為可執行檔之一或多個檔案的路徑。 app_manifest檔案中列出的 EntryPoint 一律標示為可執行檔，因此只有在其他可執行檔存在時，才需要 -x 旗標。 根據預設，封裝到映射時，檔案不會執行。 子路徑相對於可執行文件的路徑。 路徑可以使用 Windows 檔名語法（反斜杠）或 Linux 檔名語法（正斜線）：不允許空格、逗號和分號。 您可以為每個可執行檔指定 -x，或只使用它一次，並提供以逗號分隔的多個路徑，而不需要介入空格。 |
全域參數
Azure Sphere CLI 提供下列全域參數：
| 參數 | 描述 |
|---|---|
| --debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤，可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
| -h, --help | 列印 CLI 參考命令及其自變數的相關信息，並列出可用的子群組和命令。 |
| --only-show-errors | 只顯示錯誤，隱藏警告。 |
| -o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc（色彩化 JSON）、tsv （Tab-Separated Values）、數據表（人類可讀取的 ASCII 數據表），以及 yaml。 根據預設，CLI 會輸出 table。 若要深入瞭解可用的輸出格式，請參閱 Azure Sphere CLI 命令的輸出格式。 |
| --查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例，請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
| --verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI，請參閱 全域參數 ，以取得可用選項的詳細資訊。
範例
azsphere image-package pack-application --package-directory C:\AppSamples\LocalSamples\HelloWorld\HelloWorld_HighLevelApp\out\ARM-Debug\approotHelloWorld_HighLevelApp --destination myimage.imagepackage
pack-board-config
建立面板組態映像套件。 您可以使用預設面板組態映像，或提供自定義組態映像。
必要參數
| 參數 | 類型 | 描述 |
|---|---|---|
| --目的地 | String | 指定所產生映像套件輸出檔名的路徑。 |
選擇性參數
| 參數 | 類型 | 描述 |
|---|---|---|
| --board-config-file | 路徑 | 識別面板組態映像的路徑。 如果包含在內， --preset 則不得使用;這兩個參數互斥。 |
| -n, --name | String | 設定所建立檔案元數據中的映像套件名稱。 如果未提供，則會根據提供的面板組態產生新名稱，併入元件標識碼的一部分，以取得唯一性。 |
| -p、 --preset | String | 提供要套用之預設面板組態映像的標識碼。 輸入預設套件的識別碼，或使用自定義面板元件映像的參數來提供面板元件檔 --board-config-file 的路徑。 識別碼是列舉值，目前固定為單一值 lan-enc28j60-isu0-int5。 |
全域參數
Azure Sphere CLI 提供下列全域參數：
| 參數 | 描述 |
|---|---|
| --debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤，可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
| -h, --help | 列印 CLI 參考命令及其自變數的相關信息，並列出可用的子群組和命令。 |
| --only-show-errors | 只顯示錯誤，隱藏警告。 |
| -o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc（色彩化 JSON）、tsv （Tab-Separated Values）、數據表（人類可讀取的 ASCII 數據表），以及 yaml。 根據預設，CLI 會輸出 table。 若要深入瞭解可用的輸出格式，請參閱 Azure Sphere CLI 命令的輸出格式。 |
| --查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例，請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
| --verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI，請參閱 全域參數 ，以取得可用選項的詳細資訊。
範例
azsphere image-package pack-board-config --preset lan-enc28j60-isu0-int5 --destination board2.imagepackage
show
顯示映像套件的相關信息。
必要參數
| 參數 | 類型 | 描述 |
|---|---|---|
| -f， --image-package | String | 指定映像套件的路徑。 您可以提供相對或絕對路徑。 |
全域參數
Azure Sphere CLI 提供下列全域參數：
| 參數 | 描述 |
|---|---|
| --debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤，可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
| -h, --help | 列印 CLI 參考命令及其自變數的相關信息，並列出可用的子群組和命令。 |
| --only-show-errors | 只顯示錯誤，隱藏警告。 |
| -o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc（色彩化 JSON）、tsv （Tab-Separated Values）、數據表（人類可讀取的 ASCII 數據表），以及 yaml。 根據預設，CLI 會輸出 table。 若要深入瞭解可用的輸出格式，請參閱 Azure Sphere CLI 命令的輸出格式。 |
| --查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例，請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
| --verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI，請參閱 全域參數 ，以取得可用選項的詳細資訊。
範例
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