image-package
ディスク上の Azure Sphere イメージを管理します。
| 操作 | 説明 |
|---|---|
| pack-application | イメージ パッケージを作成します。 |
| pack-board-config | ボード構成イメージ パッケージを作成します。 |
| 表示 | イメージ パッケージの詳細を表示します。 |
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 | 文字列 | アプリケーション マニフェスト ファイルへのパスを指定します。 これは、JSON ファイルまたは app_manifest.json を含むディレクトリです。 相対パスまたは絶対パスを指定できます。 |
| --hardware-definitions | 文字列 | ハードウェア定義 (JSON) ファイルを含むディレクトリへのパスの省略可能なスペース区切りの一覧を指定します。 ファイルの値は、app_manifest.json 内の周辺機器名を基になる値にマップするために使用されます。 相対パスまたは絶対パスを指定できます。 詳細については、「 ハードウェア定義 」を参照してください。 |
| --target-api-set | 文字列 | コンパイル時に使用されるターゲット API セットの名前を指定します。 アプリ マニフェストで指定されていない場合は、上位レベルのアプリに必要です。 RTApps には必要ありません。 |
| --target-definition-filename | 文字列 | app_manifest.json で周辺機器名をマップするために使用されるハードウェア ターゲット定義ファイルの名前を指定します。 アプリケーションでハードウェア定義を使用する場合は、指定する必要があります。 |
| -x、--executables | executable1,executable2 ... | イメージ パッケージで実行可能ファイルとしてマークする 1 つ以上のファイルへのパスを指定します。 app_manifest ファイルに一覧表示されている EntryPoint は常に実行可能ファイルとしてマークされるため、-x フラグは他の実行可能ファイルが存在する場合にのみ必要です。 既定では、イメージにパッケージ化された場合、ファイルは実行可能ではありません。 サブパスは、実行可能ファイルのパスを基準としています。 パスでは、Windows ファイル名構文 (円記号) または Linux ファイル名構文 (スラッシュ) を使用できます。スペース、コンマ、セミコロンは使用できません。 実行可能ファイルごとに -x を指定するか、1 回だけ使用し、スペースを挿入せずに複数のパスをコンマで区切って指定できます。 |
グローバル パラメーター
Azure Sphere CLI では、次のグローバル パラメーターを使用できます。
| パラメーター | 説明 |
|---|---|
| --デバッグ | ログ記録の詳細度を増やして、すべてのデバッグ ログを表示します。 バグが見つかる場合は、バグ レポートを送信するときに、 フラグを --debug 使用して生成された出力を指定します。 |
| -h、--help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
| --only-show-errors | エラーのみを表示し、警告を抑制します。 |
| -o、--output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色付けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は を出力します table。 使用可能な出力形式の詳細については、「 Azure Sphere CLI コマンドの出力形式」を参照してください。 |
| --クエリ | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、「 JMESPath チュートリアル 」および 「Azure CLI コマンド出力のクエリ 」を参照してください。 |
| --詳細 | 操作中に 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
ボード構成イメージ パッケージを作成します。 事前設定されたボード構成イメージを使用することも、カスタム構成イメージを指定することもできます。
必須パラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| --先 | 文字列 | 結果のイメージ パッケージの出力ファイル名へのパスを指定します。 |
省略可能なパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| --board-config-file | パス | ボード構成イメージへのパスを識別します。 これが含まれている場合は、 --preset 使用しないでください。2 つのパラメーターは相互に排他的です。 |
| -n、--name | 文字列 | 作成したファイルのメタデータ内のイメージ パッケージ名を設定します。 指定しない場合は、提供されたボード構成に基づいて新しい名前が生成され、一意性のためにコンポーネント ID の一部が組み込まれます。 |
| -p、--preset | 文字列 | 適用するプリセット ボード構成イメージの ID を提供します。 プリセット パッケージの ID を入力するか、カスタム ボード構成イメージのパラメーターを使用して --board-config-file ボード構成ファイルのパスを指定します。 ID は列挙値であり、現在は 1 つの値 lan-enc28j60-isu0-int5に固定されています。 |
グローバル パラメーター
Azure Sphere CLI では、次のグローバル パラメーターを使用できます。
| パラメーター | 説明 |
|---|---|
| --デバッグ | ログ記録の詳細度を増やして、すべてのデバッグ ログを表示します。 バグが見つかる場合は、バグ レポートを送信するときに、 フラグを --debug 使用して生成された出力を指定します。 |
| -h、--help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
| --only-show-errors | エラーのみを表示し、警告を抑制します。 |
| -o、--output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色付けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は を出力します table。 使用可能な出力形式の詳細については、「 Azure Sphere CLI コマンドの出力形式」を参照してください。 |
| --クエリ | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、「 JMESPath チュートリアル 」および 「Azure CLI コマンド出力のクエリ 」を参照してください。 |
| --詳細 | 操作中に Azure Sphere で作成されたリソースに関する情報とその他の有用な情報を出力します。 完全なデバッグ ログに使用 --debug します。 |
メモ
Azure Sphere クラシック CLI を使用している場合は、使用可能なオプションの詳細については、「 グローバル パラメーター 」を参照してください。
例
azsphere image-package pack-board-config --preset lan-enc28j60-isu0-int5 --destination board2.imagepackage
表示
イメージ パッケージに関する情報を表示します。
必須パラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -f、--image-package | 文字列 | イメージ パッケージへのパスを指定します。 相対パスまたは絶対パスを指定できます。 |
グローバル パラメーター
Azure Sphere CLI では、次のグローバル パラメーターを使用できます。
| パラメーター | 説明 |
|---|---|
| --デバッグ | ログ記録の詳細度を増やして、すべてのデバッグ ログを表示します。 バグが見つかる場合は、バグ レポートを送信するときに、 フラグを --debug 使用して生成された出力を指定します。 |
| -h、--help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
| --only-show-errors | エラーのみを表示し、警告を抑制します。 |
| -o、--output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色付けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は を出力します table。 使用可能な出力形式の詳細については、「 Azure Sphere CLI コマンドの出力形式」を参照してください。 |
| --クエリ | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、「 JMESPath チュートリアル 」および 「Azure CLI コマンド出力のクエリ 」を参照してください。 |
| --詳細 | 操作中に 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