Share via


az sphere

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

Manage Azure Sphere resources.

Commands

Name Description Type Status
az sphere ca-certificate

Manage certificates in your resource group and catalog.

Extension GA
az sphere ca-certificate download

Download the certificate for your catalog.

Extension GA
az sphere ca-certificate download-chain

Download the certificate chain for your catalog as a PKCS#7 ".p7b" file.

Extension GA
az sphere ca-certificate download-proof

Download a proof-of-possession certificate for your catalog for use with a provided code.

Extension GA
az sphere ca-certificate list

List all certificates in your resource group and catalog.

Extension GA
az sphere catalog

Manage catalogs.

Extension GA
az sphere catalog create

Create a catalog.

Extension GA
az sphere catalog delete

Delete a catalog.

Extension GA
az sphere catalog download-error-report

List or download the available error reports for the selected catalog.

Extension GA
az sphere catalog list

List available catalogs either in a resource group or a subscription.

Extension GA
az sphere catalog show

Show details of a catalog.

Extension GA
az sphere deployment

Manage deployments in your resource group and catalog.

Extension GA
az sphere deployment create

Create a deployment.

Extension GA
az sphere deployment list

List all deployments.

Extension GA
az sphere deployment show

Show details of a deployment.

Extension GA
az sphere device

Manage Azure Sphere devices.

Extension GA
az sphere device-group

Manage device groups in your resource group and catalog.

Extension GA
az sphere device-group create

Create a device group.

Extension GA
az sphere device-group create-defaults

Create default device groups targeting a product.

Extension GA
az sphere device-group delete

Delete the specified device group.

Extension GA
az sphere device-group list

List all device groups in a catalog.

Extension GA
az sphere device-group show

Show a device group's details.

Extension GA
az sphere device-group update

Update a device group's details.

Extension GA
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 get-support-data

Gather diagnostic data about your local system, cloud and device configurations.

Extension GA
az sphere hardware-definition

Manage hardware definitions.

Extension GA
az sphere hardware-definition generate-header

Generate a C header file corresponding to a hardware definition and place it in the folder 'inc/hw' relative to the input JSON.

Extension GA
az sphere hardware-definition test-header

Test that the C header file in the 'inc/hw' folder is up-to-date with respect to the input JSON.

Extension GA
az sphere image

Manage images in your resource group and catalog.

Extension GA
az sphere image-package

Manage image packages.

Extension GA
az sphere image-package show

Show details of a given image package.

Extension GA
az sphere image add

Add an image to your catalog from your local machine.

Extension GA
az sphere image list

List all images in your resource group and catalog.

Extension GA
az sphere image show

Show details of an existing image from your catalog.

Extension GA
az sphere product

Manage products in your resource group and catalog.

Extension GA
az sphere product create

Create a new product in your resource group and catalog.

Extension GA
az sphere product delete

Delete the specified product.

Extension GA
az sphere product list

List all products in your resource group and catalog.

Extension GA
az sphere product show

Show details of a product in your resource group and catalog.

Extension GA
az sphere product update

Update a product's details in your resource group and catalog.

Extension GA
az sphere show-sdk-version

Show the version of the Azure Sphere SDK installed.

Extension GA

az sphere get-support-data

Gather diagnostic data about your local system, cloud and device configurations.

az sphere get-support-data --catalog
                           --resource-group
                           [--output-file]

Examples

Gather diagnostic data about your local system, cloud and device configurations for devices in a resource group and catalog.

az sphere get-support-data --resource-group MyResourceGroup --catalog MyCatalog --output-file archive.zip

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

--output-file -of

The path and filename of the .zip file to save the support data in. It must have the .zip extension. You can provide a relative or absolute path. If you do not specify a filename, the support data will be saved in a file called support_data.zip in the current working directory. (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 show-sdk-version

Show the version of the Azure Sphere SDK installed.

az sphere show-sdk-version

Examples

Show the version of the Azure Sphere SDK installed.

az sphere show-sdk-version
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.