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.
Deploy and manage applications on the attached device.
| Operation | Description |
|---|---|
| az sphere device sideload set-deployment-timeout | Set deployment timeout in seconds for application or board configuration. |
| az sphere device sideload show-deployment-timeout | Show deployment timeout in seconds for application or board configuration. |
| az sphere device sideload deploy | Deploy an application or board configuration to the attached device. |
| az sphere device sideload delete | Delete applications or board configuration from the attached device. |
Commands
az sphere device sideload set-deployment-timeout
Set deployment timeout in seconds for application or board configuration.
Required Parameters
| Parameter | Description |
|---|---|
| --value -v | Timeout value in seconds. |
Examples
Set deployment timeout value.
az sphere device sideload set-deployment-timeout --value 30
az sphere device sideload show-deployment-timeout
Show deployment timeout in seconds for application or board configuration.
Examples
Show deployment timeout value.
az sphere device sideload show-deployment-timeout
az sphere device sideload deploy
Deploy an application or board configuration to the attached device.
Required Parameters
| Parameter | Description |
|---|---|
| --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
| Parameter | Description |
|---|---|
| --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. Values from: az sphere device list-attached. |
| --force | Force the deployment of an image using a Beta API that may no longer be supported. |
| --manual-start -m | Do not automatically start the application after sideload. |
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>
az sphere device sideload delete
Delete applications or board configuration from the attached device.
Optional Parameters
| Parameter | Description |
|---|---|
| --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. Values from: az sphere device list-attached. |
| --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. Values from: az sphere device image list-installed. |
| --except-component-ids -e | Space-separated IDs of components (applications and/or board configuration) to exclude from deletion. (GUID). Values from: az sphere device image list-installed. |
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