Overview of the Azure Sphere extension for Azure CLI
The command-line tool for managing Azure Sphere attached devices and cloud deployments is distributed as an Azure CLI extension.
Install the Azure CLI and the Azure Sphere extension
To acquire the Azure Sphere extension for Azure CLI:
Install the Azure CLI if you have not yet done so.
To add the Azure Sphere extension, run the following command:
az extension add --name azure-sphere
You must Sign in with Azure CLI to log into the Azure subscription you wish to use to manage Azure Sphere devices.
Once an extension is installed, its location is found under the value of the $AZURE_EXTENSION_DIR shell variable. If this variable is unset, by default the value is $HOME/.azure/cliextensions on Linux and macOS, and %USERPROFILE%\.azure\cliextensions on Windows.
Tip
After logging in, you will see a list of subscriptions associated with your Azure account. Ensure that you select the subscription with the required permissions using the az account set command for the Azure Sphere extension to function correctly. For more information about subscription selection, see Use multiple Azure subscriptions.
Managing the Azure Sphere extension
To see the installed versions of Azure CLI extensions, use the command:
az version
To update the Azure Sphere extension to the latest version, use:
az extension update --name azure-sphere
To uninstall the Azure Sphere extension, use:
az extension remove --name azure-sphere
Common Azure Sphere CLI commands
You can use Azure Sphere commands by typing az sphere from either Windows command prompt or PowerShell.
On Linux, you can use any command-line interface (CLI). The CLI has full tab completion for commands under the bash shell.
This table lists some common Azure Sphere commands and links to their reference documentation.
| Command | Description |
|---|---|
az sphere catalog |
Manage your catalog. |
az sphere ca-certificate |
Manage certificates in your catalog. |
az sphere deployment |
Manage deployments in your catalog. |
az sphere device |
Manage Azure Sphere devices. |
az sphere device-group |
Manage device groups in your catalog. |
az sphere image |
Manage images in your catalog. |
az sphere product |
Manage products in your catalog. |
az sphere get-support-data |
Gather diagnostic data about your system, cloud and device configurations. |
Azure CLI allows you to set up configuration options which simplify use of Azure Sphere CLI commands by providing defaults for parameters like the --resource-group, --subscription, or --catalog.
Device dependent commands
The command works with a locally attached Azure Sphere device. If you attempt the command without a device attached you will receive an error. For more information on device commands see, az sphere device
az sphere device claimaz sphere device recoveraz sphere device restartaz sphere device show-attachedaz sphere device show-os-versionaz sphere device app show-memory-statusaz sphere device app show-quotaaz sphere device app show-statusaz sphere device app startaz sphere device app stopaz sphere device capability show-attachedaz sphere device capability updateaz sphere device certificate addaz sphere device certificate deleteaz sphere device certificate listaz sphere device certificate showaz sphere device certificate show-quotaaz sphere device image list-installedaz sphere image-package showaz sphere device manufacturing-state showaz sphere device manufacturing-state updateaz sphere device network proxy applyaz sphere device network proxy deleteaz sphere device network proxy showaz sphere device network disableaz sphere device network enableaz sphere device network list-firewall-rulesaz sphere device network list-interfacesaz sphere device network show-diagnosticsaz sphere device network show-statusaz sphere device network update-interfaceaz sphere device sideload deleteaz sphere device sideload deployaz sphere device wifi addaz sphere device wifi disableaz sphere device wifi enableaz sphere device wifi forgetaz sphere device wifi listaz sphere device wifi reload-configaz sphere device wifi scanaz sphere device wifi showaz sphere device wifi show-status
Globally available arguments
The following global parameters are available for the Azure Sphere extension:
| Parameter | Description |
|---|---|
--debug |
Increase logging verbosity to show all debug logs. |
--help -h |
Shows the help message. |
--only-show-errors |
Only shows errors, suppressing warnings. |
--output -o |
Output format. Allowed values: json, jsonc, none, table, tsv, yaml, yamlc. Default: 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. |