az sphere device

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

Manage Azure Sphere devices.

Commands

Name	Description	Type	Status
az sphere device app	Manage applications on the attached device.	Extension	GA
az sphere device app show-memory-stats	Show the memory statistics for applications on the attached device.	Extension	GA
az sphere device app show-quota	Show the storage quota and usage for applications on the attached device.	Extension	GA
az sphere device app show-status	Show the status of applications on the attached device.	Extension	GA
az sphere device app start	Start applications on the attached device.	Extension	GA
az sphere device app stop	Stop applications on the attached device.	Extension	GA
az sphere device assign	Assign a device to a device group in your resource group and catalog.	Extension	GA
az sphere device capability	Manage device capability configurations.	Extension	GA
az sphere device capability apply	Temporarily apply a capability session on the attached device.	Extension	GA
az sphere device capability download	Download a device capability file from the Azure Sphere Security Service.	Extension	GA
az sphere device capability show-attached	Show the current device capability configuration of the attached device.	Extension	GA
az sphere device capability update	Update the device capability configuration for the attached device.	Extension	GA
az sphere device certificate	Manage certificates on the attached device.	Extension	GA
az sphere device certificate add	Add a certificate in the attached device's certificate store.	Extension	GA
az sphere device certificate delete	Delete a certificate in the attached device's certificate store.	Extension	GA
az sphere device certificate list	List certificates in the attached device's certificate store.	Extension	GA
az sphere device certificate show	Show details of a certificate in the attached device's certificate store.	Extension	GA
az sphere device certificate show-quota	Show the available free space in the attached device's certificate store.	Extension	GA
az sphere device claim	Claim a device in your resource group and catalog.	Extension	GA
az sphere device enable-cloud-test	Enable a device for testing cloud loading by disabling development and debugging on the attached device, and by assigning it to a device group that enables application updates from the cloud. By default, this will be the Field Test device group of the device's product, but other device groups can be specified. Not for use in manufacturing scenarios: see https://aka.ms/AzureSphereManufacturing for more information.	Extension	GA
az sphere device enable-development	Enable a device for development by enabling sideloading and debugging on the attached device, and by assigning it to a device group that disables application updates from the cloud. By default, this will be the Development device group of the device's product, but other device groups can be specified. Not for use in manufacturing scenarios: see https://aka.ms/AzureSphereManufacturing for more information.	Extension	GA
az sphere device image	Manage images in your catalog and the attached device.	Extension	GA
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 list	List all the devices in your catalog, product, or device group.	Extension	GA
az sphere device list-attached	List all the attached devices.	Extension	GA
az sphere device manufacturing-state	Manage the manufacturing state of attached devices.	Extension	GA
az sphere device manufacturing-state show	Show the manufacturing state of the attached device.	Extension	GA
az sphere device manufacturing-state update	Update the manufacturing state of the attached device. Caution: manufacturing state changes are permanent and irreversible.	Extension	GA
az sphere device network	Provides information about the status of network interfaces on the attached device.	Extension	GA
az sphere device network disable	Disable a network interface on the attached device.	Extension	GA
az sphere device network enable	Enable a network interface on the attached device.	Extension	GA
az sphere device network list-firewall-rules	List firewall rules for the attached device.	Extension	GA
az sphere device network list-interfaces	List the network interfaces for the attached device.	Extension	GA
az sphere device network proxy	Manage proxy address use for network connection.	Extension	GA
az sphere device network proxy apply	Configure the network proxy on the attached device.	Extension	GA
az sphere device network proxy delete	Delete proxy connection on the attached device.	Extension	GA
az sphere device network proxy disable	Disable network proxy on the attached device.	Extension	GA
az sphere device network proxy enable	Enable network proxy on the attached device.	Extension	GA
az sphere device network proxy show	Show proxy connection on the attached device.	Extension	GA
az sphere device network show-diagnostics	Show diagnostics for one or all Wi-Fi networks on the attached device.	Extension	GA
az sphere device network show-status	Show the network status for the attached device.	Extension	GA
az sphere device network update-interface	Update the network interface configuration for the attached device.	Extension	GA
az sphere device recover	Use recovery mode to load new firmware onto the attached device.	Extension	GA
az sphere device rescan-attached	Show the number of attached devices.	Extension	GA
az sphere device restart	Restart the attached device.	Extension	GA
az sphere device show	Show details of an existing device in your resource group and catalog.	Extension	GA
az sphere device show-attached	Show the details of the attached device.	Extension	GA
az sphere device show-count	Show the number of devices in your catalog, product, or device group.	Extension	GA
az sphere device show-deployment-status	Show the deployment status of the operating system on a device.	Extension	GA
az sphere device show-os-version	Show the operating system version on the attached device.	Extension	GA
az sphere device sideload	Deploy and manage applications on the attached device.	Extension	GA
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 unassign	Unassign a device from a device group in your resource group and catalog.	Extension	GA
az sphere device wifi	Manage Wi-Fi configurations for the attached device.	Extension	GA
az sphere device wifi add	Add a Wi-Fi network on the attached device.	Extension	GA
az sphere device wifi disable	Disable a Wi-Fi connection on the attached device.	Extension	GA
az sphere device wifi enable	Enable a Wi-Fi network on the attached device.	Extension	GA
az sphere device wifi forget	Forget a Wi-Fi network on the attached device.	Extension	GA
az sphere device wifi list	List the current Wi-Fi configurations for the attached device.	Extension	GA
az sphere device wifi reload-config	Reload the Wi-Fi network configuration on the attached device. Use this command after you add or remove a certificate (azsphere device certificate) to ensure that EAP-TLS networks use the most recent contents of the certificate store.	Extension	GA
az sphere device wifi scan	Scan for available Wi-Fi networks visible to the attached device.	Extension	GA
az sphere device wifi show	Show details of a Wi-Fi network on the attached device.	Extension	GA
az sphere device wifi show-status	Show the status of the wireless interface on the attached device.	Extension	GA

az sphere device assign

Assign a device to a device group in your resource group and catalog.

az sphere device assign --catalog
                        --resource-group
                        --target-device-group
                        --target-product
                        [--device]

Examples

Assign a device using resource group, catalog name, target product name, target device group name, and device ID.

az sphere device assign --resource-group MyResourceGroup --catalog MyCatalog --target-product MyProduct --target-device-group MyCurrentDeviceGroup --device <DeviceIdValue>

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.

--target-device-group

The name of the target device group.

value from: az sphere device-group list

--target-product

The name of the target product.

value from: az sphere product list

Optional Parameters

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

az sphere device claim

Claim a device in your resource group and catalog.

az sphere device claim --catalog
                       --resource-group
                       [--device]
                       [--device-group]
                       [--product]

Examples

Claim a device using resource group, catalog name, and device ID.

az sphere device claim --resource-group MyResourceGroup --catalog MyCatalog --device <DeviceIdValue>

Claim a device using resource group, catalog name, product name, device group name, and device ID.

az sphere device claim --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct --device-group MyDeviceGroup --device <DeviceIdValue>

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

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

--device-group -dg

The device group name where to claim the device.

default value: .default

value from: az sphere device-group list

--product -p

The product name where to claim the device.

default value: .default

value from: az sphere product 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.

az sphere device enable-cloud-test

Enable a device for testing cloud loading by disabling development and debugging on the attached device, and by assigning it to a device group that enables application updates from the cloud. By default, this will be the Field Test device group of the device's product, but other device groups can be specified. Not for use in manufacturing scenarios: see https://aka.ms/AzureSphereManufacturing for more information.

az sphere device enable-cloud-test --catalog
                                   --resource-group
                                   [--device]
                                   [--device-group]
                                   [--product]

Examples

Enable a device for testing cloud using resource group, catalog name, device ID, and default "Field Test" device group.

az sphere device enable-cloud-test --resource-group MyResourceGroup --catalog MyCatalog --device <DeviceIdValue>

Enable a device for testing cloud using resource group, catalog name, product name, device group name, and device ID.

az sphere device enable-cloud-test --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct --device-group MyDeviceGroup --device <DeviceIdValue>

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

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

--device-group -dg

The device group name to which the device will be assigned. By default, this is the "Field Test" device group of the product.

value from: az sphere device-group list

--product -p

The target product name. The device will be assigned to the default "Field Test" device group of the selected product unless the device-group is also specified.

value from: az sphere product 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.

az sphere device enable-development

Enable a device for development by enabling sideloading and debugging on the attached device, and by assigning it to a device group that disables application updates from the cloud. By default, this will be the Development device group of the device's product, but other device groups can be specified. Not for use in manufacturing scenarios: see https://aka.ms/AzureSphereManufacturing for more information.

az sphere device enable-development --catalog
                                    --resource-group
                                    [--device]
                                    [--device-group]
                                    [--enable-rt-core-debugging]
                                    [--product]

Examples

Enable a device for development by enabling sideloading and debugging using resource group, catalog name, device ID, and default "Development" device group.

az sphere device enable-development --resource-group MyResourceGroup --catalog MyCatalog --device <DeviceIdValue>

Enable a device for development by enabling sideloading and debugging using resource group, catalog name, product name, device group name, and device ID.

az sphere device enable-development --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct --device-group MyDeviceGroup --device <DeviceIdValue>

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

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

--device-group -dg

The device group name to which the device will be assigned. By default, this is the "Development" device group of the product.

value from: az sphere device-group list

--enable-rt-core-debugging -r

Install drivers required to debug applications running on a real-time core. Requires administrator permissions.

default value: False

--product -p

The target product name. The device will be assigned to the default "Development" device group of the selected product unless the device-group is also specified.

value from: az sphere product 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.

az sphere device list

List all the devices in your catalog, product, or device group.

az sphere device list --catalog
                      --resource-group
                      [--device-group]
                      [--product]

Examples

List all devices in a resource group and catalog.

az sphere device list --resource-group MyResourceGroup --catalog MyCatalog

List all devices in a resource group, catalog, and product.

az sphere device list --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct

List all devices in a resource group, catalog, product, and device group.

az sphere device list --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct --device-group MyDeviceGroup

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

--device-group -dg

The device group name.

value from: az sphere device-group list

--product -p

The product name.

value from: az sphere product 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.

az sphere device list-attached

List all the attached devices.

az sphere device list-attached

Examples

List all the attached devices.

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 recover

Use recovery mode to load new firmware onto the attached device.

az sphere device recover [--capability]
                         [--device]
                         [--images]

Examples

Recover an attached device.

az sphere device recover

Recover an attached device with specific capability and images.

az sphere device recover --capability myCapability.cap --images myImagesFolder

Optional Parameters

--capability

Filename of a device capability image to apply to the device during recovery. (Path).

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

--images

Folder containing the image packages to write to the device. If not specified then the latest OS images are downloaded and used. (Path).

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 rescan-attached

Show the number of attached devices.

az sphere device rescan-attached

Examples

Show the number of attached devices.

az sphere device rescan-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 restart

Restart the attached device.

az sphere device restart [--device]

Examples

Restart the attached device.

az sphere device restart

Restart a specified device.

az sphere device restart --device <DeviceIdValue>

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

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 show

Show details of an existing device in your resource group and catalog.

az sphere device show --catalog
                      --resource-group
                      [--device]

Examples

Show details of a device using resource group, catalog name, and device ID.

az sphere device show --resource-group MyResourceGroup --catalog MyCatalog --device <DeviceIdValue>

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

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

az sphere device show-attached

Show the details of the attached device.

az sphere device show-attached [--device]

Examples

Show details of the attached device.

az sphere device show-attached

Show details of the specified device.

az sphere device show-attached --device <DeviceIdValue>

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

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 show-count

Show the number of devices in your catalog, product, or device group.

az sphere device show-count --catalog
                            --resource-group
                            [--device-group]
                            [--product]

Examples

Show the number of devices in a resource group and catalog.

az sphere device show-count --resource-group MyResourceGroup --catalog MyCatalog

Show the number of devices in a resource group, catalog, and product.

az sphere device show-count --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct

Show the number of devices in a resource group, catalog, product, and device group.

az sphere device show-count --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct --device-group MyDeviceGroup

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

--device-group -dg

The device group name.

value from: az sphere device-group list

--product -p

The product name.

value from: az sphere product 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.

az sphere device show-deployment-status

Show the deployment status of the operating system on a device.

az sphere device show-deployment-status --catalog
                                        --resource-group
                                        [--device]

Examples

Show the deployment status of the operation system using resource group, catalog name, and device ID.

az sphere device show-deployment-status --resource-group MyResourceGroup --catalog MyCatalog --device <DeviceIdValue>

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

--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 show-os-version

Show the operating system version on the attached device.

az sphere device show-os-version [--device]

Examples

Show the operating system version on the attached device.

az sphere device show-os-version

Show the operation system version on a specified device.

az sphere device show-os-version --device <DeviceIdValue>

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

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 unassign

Unassign a device from a device group in your resource group and catalog.

az sphere device unassign --catalog
                          --resource-group
                          [--device]

Examples

Unassign a device using resource group, catalog name, and device ID.

az sphere device unassign --resource-group MyResourceGroup --catalog MyCatalog --device <DeviceIdValue>

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

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