az sphere device sideload

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 or board configuration from the attached device.	Extension	GA
az sphere device sideload deploy	Deploy an application or board configuration to the attached device.	Extension	GA
az sphere device sideload set-deployment-timeout	Set deployment timeout in seconds for application or board configuration.	Extension	GA
az sphere device sideload show-deployment-timeout	Show deployment timeout in seconds for application or board configuration.	Extension	GA

az sphere device sideload delete

Delete applications or board configuration 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 or board configuration 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

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

--component-id -i

The component ID to delete; by default, all applications are deleted. (GUID). Specify the component ID of the application or board configuration to delete.

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

Property	Value
Value from:	az sphere device list-attached

--except-component-ids -e

Space-separated IDs of components (applications and/or board configuration) to exclude from deletion. (GUID).

Property	Value
Value from:	az sphere device image list-installed

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 device sideload deploy

Deploy an application or board configuration 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. This can be an application or a board configuration. You can provide a relative or absolute path. (Path).

Optional Parameters

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

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

Property	Value
Value from:	az sphere device list-attached

--force

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

Property	Value
Default value:	False
Accepted values:	false, true

--manual-start -m

Do not automatically start the application after sideload.

Property	Value
Default value:	False
Accepted values:	false, true

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 device sideload set-deployment-timeout

Set deployment timeout in seconds for application or board configuration.

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.

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

Show deployment timeout in seconds for application or board configuration.

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.

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