Share via

az sphere device sideload

  • 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 sideload command. Learn more about extensions.

Deploy and manage applications on the attached device.

Commands

Name Description Type Status
az sphere device sideload delete

Delete applications from the attached device.

 Extension GA
az sphere device sideload deploy

Deploy an application to the attached device.

 Extension GA
az sphere device sideload set-deployment-timeout

Set deployment timeout in seconds.

 Extension GA
az sphere device sideload show-deployment-timeout

Show deployment timeout in seconds.

 Extension GA

az sphere device sideload delete

Delete applications from the attached device.

az sphere device sideload delete [--component-id]
                                 [--device]
                                 [--except-component-ids]

Examples

Delete applications from the device.

az sphere device sideload delete

Delete applications from a specific device.

az sphere device sideload delete --device <DeviceIdValue>

Delete a specific application from the device.

az sphere device sideload delete --component-id d2d461c4-b870-4619-b207-e86b8ab1481c

Delete applications except two specific applications from the device.

az sphere device sideload delete --except-component-ids d2d461c4-b870-4619-b207-e86b8ab1481c 683520b6-df43-4f4f-a4de-4c7a6f2ad05d

Optional Parameters

--component-id -i

The component ID to delete; by default, all applications are deleted. (GUID).

Value from: az sphere device image list-installed
--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
--except-component-ids -e

Space-separated IDs of components to exclude from the set of applications to be deleted. (GUID).

Value from: az sphere device image list-installed
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 sideload deploy

Deploy an application to the attached device.

az sphere device sideload deploy --image-package
                                 [--device]
                                 [--force {false, true}]
                                 [--manual-start {false, true}]

Examples

Deploy an image package to the device.

az sphere device sideload deploy --image-package MyImage.imagepackage

Deploy an image package to the device with manual start.

az sphere device sideload deploy --image-package MyImage.imagepackage --manual-start

Deploy an image package to a specific device.

az sphere device sideload deploy --image-package MyImage.imagepackage --device <DeviceIdValue>

Required Parameters

--image-package -p

The path and filename of the image package file to deploy. You can provide a relative or absolute path. (Path).

Optional Parameters

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

Force the deployment of an image using a Beta API that may no longer be supported.

Accepted values: false, true
Default value: False
--manual-start -m

Do not automatically start the application after sideload.

Accepted values: false, true
Default value: False
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 sideload set-deployment-timeout

Set deployment timeout in seconds.

az sphere device sideload set-deployment-timeout --value

Examples

Set deployment timeout value.

az sphere device sideload set-deployment-timeout --value 30

Required Parameters

--value -v

Timeout value in seconds.

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 sideload show-deployment-timeout

Show deployment timeout in seconds.

az sphere device sideload show-deployment-timeout

Examples

Show deployment timeout value.

az sphere device sideload show-deployment-timeout
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.