image-package
重要
これは Azure Sphere (レガシ) のドキュメントです。 Azure Sphere (レガシ) は 2027 年 9 月 27 日に 再提供されておりユーザーは現時点で Azure Sphere (統合) に移行する必要があります。 TOC の上にある Version セレクターを使用して、Azure Sphere (統合) のドキュメントを表示します。
ディスク上の Azure Sphere イメージを管理します。
| 操作 | 説明 |
|---|---|
| pack-application | イメージ パッケージを作成します。 |
| pack-board-config | ボード構成イメージ パッケージを作成します。 |
| show | イメージ パッケージに関する詳細を表示します。 |
pack-application
コンパイルおよびリンクが済んだイメージと app_manifest.json ファイルから、実行可能なアプリケーションを作成します。
リアルタイム対応アプリケーション (RTApp) は生バイナリとしてではなく、ELF または AXF としてビルドされます。 RTApp をパッケージ化する前にアプリケーション マニフェスト ファイルを編集し、ApplicationType を "RealTimeCapable" に設定し、EntryPoint を ELF または AXF ファイルの名前に設定してください。ELF または AXF ファイルはアプリケーション ディレクトリのルートにあるはずです。
ヒント
このコマンドは、Visual Studio Code または Visual Studio を使用して高度なアプリケーションまたはリアルタイム対応アプリケーションをビルドするときに実行されます。
- ビルド プロセスでは、
--package-directoryパラメーターで指定された入力ディレクトリである approot<app-name> ディレクトリが作成されます。 - アプリケーション マニフェスト ファイルは、
--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内の周辺機器の名前を基になる値にマップするために使用されます。 相対または絶対パスを指定できます。 詳細は、「hardware definition」(ハードウェア定義) を参照してください。 |
| --target-api-set | String | コンパイル時に使用されるターゲット API セットの名前を指定します。 アプリ マニフェストで指定されていない場合は、高度なアプリに必要です。 RTApps には必要ありません。 |
| --target-definition-filename | String | app_manifest.jsonの周辺機器名のマップに使用するハードウェア ターゲット定義ファイルの名前を指定します。 アプリケーションでハードウェア定義を使用する場合は、指定する必要があります。 |
| -x、--executables | executable1,executable2 ... | イメージ パッケージで実行可能ファイルとしてマークする 1 つ以上のファイルへのパスを指定します。 app_manifest ファイルで指定されている EntryPoint は常に実行可能ファイルとしてマークされるため、-x フラグは他の実行可能ファイルが存在する場合にのみ必要です。 既定では、ファイルはイメージにパッケージ化されるときは実行可能ファイルではありません。 サブパスは、実行可能ファイルのパスに対する相対パスです。 paths では、Windows のファイル名構文 (円記号) または Linux のファイル名構文 (スラッシュ) のいずれかを使用できます。スペース、コンマ、セミコロンは使用できません。 -x は、実行可能ファイルごとに指定することも、1 回だけ使用し、複数のパスをスペースを挿入せずにコンマで区切って指定することもできます。 |
グローバル パラメーター
Azure Sphere CLI では、次のグローバル パラメーターを使用できます。
| パラメーター | 説明 |
|---|---|
| --debug | ログの詳細度を上げて、すべてのデバッグ ログを表示します。 バグを見つけた場合は、バグ レポートを送信するときに、--debug フラグをオンにして生成した出力を提供してください。 |
| -h, --help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
| --only-show-errors | エラーのみを表示し、警告を抑制します。 |
| -o, --output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色分けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は table を出力します。 使用可能な出力形式の詳細については、「Azure Sphere CLI コマンドの出力形式を参照してください。 |
| --query | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、 JMESPath チュートリアル および azure CLI コマンド出力の Query を参照してください 。 |
| --verbose | 操作中に Azure Sphere で作成されたリソースに関する情報とその他の有用な情報を出力します。 完全なデバッグ ログを表示するには --debug を使用します。 |
Note
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 | Path | ボード構成イメージへのパスを識別します。 これが含まれている場合、 --preset は使用できません。2 つのパラメーターは相互に排他的です。 |
| -n, --name | String | 作成されたファイルのメタデータにイメージ パッケージ名を設定します。 指定しない場合は、提供されているボード構成に基づいて新しい名前が生成されます。また、一意の名前にするためにコンポーネント ID の一部が含まれます。 |
| -p, --preset | String | 適用するプリセットのボード構成イメージの ID を提供します。 プリセット パッケージの ID を入力するか、カスタム ボード構成イメージの --board-config-file パラメーターを使用してボード構成ファイルのパスを指定します。 ID は列挙値であり、現在、 lan-enc28j60-isu0-int5 1 つの値に固定されています。 |
グローバル パラメーター
Azure Sphere CLI では、次のグローバル パラメーターを使用できます。
| パラメーター | 説明 |
|---|---|
| --debug | ログの詳細度を上げて、すべてのデバッグ ログを表示します。 バグを見つけた場合は、バグ レポートを送信するときに、--debug フラグをオンにして生成した出力を提供してください。 |
| -h, --help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
| --only-show-errors | エラーのみを表示し、警告を抑制します。 |
| -o, --output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色分けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は table を出力します。 使用可能な出力形式の詳細については、「Azure Sphere CLI コマンドの出力形式を参照してください。 |
| --query | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、 JMESPath チュートリアル および azure CLI コマンド出力の Query を参照してください 。 |
| --verbose | 操作中に Azure Sphere で作成されたリソースに関する情報とその他の有用な情報を出力します。 完全なデバッグ ログを表示するには --debug を使用します。 |
Note
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 (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は table を出力します。 使用可能な出力形式の詳細については、「Azure Sphere CLI コマンドの出力形式を参照してください。 |
| --query | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、 JMESPath チュートリアル および azure CLI コマンド出力の Query を参照してください 。 |
| --verbose | 操作中に Azure Sphere で作成されたリソースに関する情報とその他の有用な情報を出力します。 完全なデバッグ ログを表示するには --debug を使用します。 |
Note
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