Share via

az sphere device image

  • Reference

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 device image command. Learn more about extensions.

Manage images in your catalog and the attached device.

Commands

Name Description Type Status
az sphere device image list-installed

List the images installed on the attached device. By default, lists only applications.

 Extension GA
az sphere device image list-targeted

List images in your catalog. By default, lists only images that will be installed when the device is updated.

 Extension GA

az sphere device image list-installed

List the images installed on the attached device. By default, lists only applications.

az sphere device image list-installed [--all]
                                      [--device]

Examples

List only applications installed on the attached device.

az sphere device image list-installed

List all images installed on the attached device.

az sphere device image list-installed --all

Optional Parameters

--all

Lists all images on the device; rather than only applications.

default value: False
--device -d

The device to run the command on when multiple devices are attached. Specify the ID, IP address, or Local Connection ID of an attached device.

value from: az sphere device list-attached
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az sphere device image list-targeted

List images in your catalog. By default, lists only images that will be installed when the device is updated.

az sphere device image list-targeted --catalog
                                     --resource-group
                                     [--all]
                                     [--device]

Examples

List only applications uploaded to a resource group, catalog, and device.

az sphere image list-targeted --resource-group MyResourceGroup --catalog MyCatalog --device <DeviceIdValue>

List all images uploaded in a resource group, catalog, and device.

az sphere image list-targeted --resource-group MyResourceGroup --catalog MyCatalog --device <DeviceIdValue> --all

Required Parameters

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

Optional Parameters

--all

List all images in your resource group and catalog.

default value: False
--device -d

The device to target for this command. This is required when no device or multiple devices are attached, to disambiguate which device to target. If the device is attached, you may provide either device ID, IP address, or Local Connection ID. Otherwise you must provide the device ID only.

value from: az sphere device list
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.