Share via

az sphere image-package

Note

This reference is part of the azure-sphere extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an az sphere image-package command. Learn more about extensions.

Manage image packages.

Commands

Name Description Type Status
az sphere image-package pack-application

Create an application image package.

 Extension GA
az sphere image-package show

Show details of a given image package.

 Extension GA

az sphere image-package pack-application

Create an application image package.

az sphere image-package pack-application --output-file
                                         --package-directory
                                         [--application-manifest]
                                         [--executables]
                                         [--hardware-definitions]

Examples

Create an application image package.

az sphere image-package pack-application --output-file NewImage.imagepackage --package-directory MyDirectory

Required Parameters

--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.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az sphere image-package show

Show details of a given image package.

az sphere image-package show --image-package

Examples

Show details of an image package.

az sphere image-package show --image-package MyImage.imagepackage

Required Parameters

--image-package

Path to the image package file to show details for. You can provide a relative or absolute path.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False