Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Manage image packages.
| Operation | Description |
|---|---|
| az sphere image-package show | Show details of a given image package. |
| az sphere image-package pack-application | Create an application image package. |
Commands
az sphere image-package show
Show details of a given image package.
Required Parameters
| Parameter | Description |
|---|---|
| --image-package | Path to the image package file to show details for. You can provide a relative or absolute path. |
Examples
Show details of an image package.
az sphere image-package show --image-package MyImage.imagepackage
az sphere image-package pack-application
Create an application image package.
Required Parameters
| Parameter | Description |
|---|---|
| --output-file -of | Path to the output filename for the resulting image package. You can provide a relative or absolute path. |
| --package-directory | The input directory to package. Must contain a file named 'app_manifest.json' which is writeable. |
| --application-manifest -a | Path to the application manifest. This can be a JSON file or a directory which contains app_manifest.json. You can provide a relative or absolute path. |
| --executables -x | An optional space-separated list of paths underneath the image file system root that will be marked as executable. The EntryPoint from 'app_manifest.json' will always be marked executable. |
| --hardware-definitions | An optional space-separated list of paths to the directories containing hardware definition (JSON) files. The values from the files are used to map peripheral names in app_manifest.json to underlying values. You can provide a relative or absolute path. |
| --target-api-set | Name of the target API set used during compilation. |
| --target-definition-filename | File name of the hardware target definition file used to map peripheral names in app_manifest.json. It must be provided if the application uses hardware definitions. |
| --catalog -c | The Azure Sphere Catalog in which to perform this operation. Specify Azure Sphere Catalog name. You can configure the default Azure Sphere Catalog using az config set defaults.sphere.catalog=<name>. Values from: az sphere catalog list. |
| --resource-group -g | Name of the Azure resource group. You can configure the default group using az config set defaults.group=<name>. Values from: az group list. |
Examples
Create an application image package.
az sphere image-package pack-application --output-file NewImage.imagepackage --package-directory MyDirectory