Azure Sphere CLI 概述

重要

这是 Azure Sphere（旧版）文档。 Azure Sphere（旧版）将于 2027 年 9 月 27 日停用，用户此时必须迁移到 Azure Sphere（集成）。 使用位于 TOC 上方的版本选择器查看 Azure Sphere（集成）文档。

Azure Sphere CLI 是一组用于管理 Azure Sphere 资源的命令。

以下命令可用：

注意

注册用户命令现已弃用。

Azure Sphere CLI 和 Azure Sphere 经典 CLI

Azure Sphere CLI 与 Windows 和 Linux 上的现有 CLI 一起安装，因此你有权访问任一接口。 Azure Sphere 经典 CLI 可以像往常一样继续工作。

若要使用 Azure Sphere CLI，请使用：

在 Windows 上，使用 PowerShell 或标准 Windows 命令提示符。
在 Linux 上，使用任何命令 shell。如果在 SDK 安装过程中将 Azure Sphere CLI 设置为默认值，则 指定 azsphere 命令;如果将 Azure Sphere 经典 CLI 设置为默认值，则指定 azsphere_v2 命令。

重要

在 Windows 上，即将 停用的 Azure Sphere 经典开发人员命令提示符 快捷方式只能与 Azure Sphere 经典 CLI 一起使用。

azsphere 命令行具有以下格式：

azsphere [command] [subcommand] operation [parameters]

一般情况下，命令和子命令是名词，操作是动词，以便这种组合识别操作和操作对象。大多数命令和操作都具有一个全名和一个缩写形式。例如，设备命令缩写为 d。

大多数参数都具有长名称和缩写。在命令行中，会引入带有两个连字符的长名称和带有单个连字符的缩写。例如，以下两个命令是等效的：

azsphere device wifi add --ssid MyNetwork --psk mynetworkkey

azsphere device wifi add -s MyNetwork -p mynetworkkey

某些命令允许单个参数的多个值。在 Azure Sphere CLI 中，可以提供一个参数，后跟一个由空格分隔的值列表，在 Azure Sphere 经典 CLI 中，值列表用逗号分隔。例如：

azsphere image-package pack-application --package-directory myDirectory --destination myImagePackage --executables filepath-1 filepath-2

azsphere image-package pack-application --input myDirectory --output myImagePackage --executables filepath-1,filepath-2

使用 Azure Sphere CLI 命令时，请注意 shell 如何使用引号和转义字符。如果支持在不同 shell 中使用的脚本，则需要了解它们之间的区别。

例如：

以下 azsphere 命令需要云连接并登录到 Azure Sphere 安全服务：

此外，以下 azsphere device 命令也需要云连接：

azsphere device 命令	注释
capability	需要 Azure Sphere 安全服务以进行设备功能下载
claim
enable-cloud-test
enable-development
image
list
recover	需要 Internet 连接，但无需登录到 Azure Sphere 安全服务
show
show-count
show-deployment-status
show-os-version	需要 Internet 连接，但无需登录到 Azure Sphere 安全服务
update

以下 azsphere device 命令要求将设备功能用于制造状态 DeviceComplete 中的设备：

操作	说明
应用程序	管理连接设备上的应用程序。
capability	管理设备功能配置。功能更新所必需的。
证书 (certificate)	管理设备证书存储。
image	管理设备映像。
manufacturing-state	管理附加设备的生产状态。制造状态更新所必需的。
restart	重启附加设备。
show-deployment-status	显示附加设备上操作系统和应用程序的部署状态。
show-os-version	显示附加设备上的操作系统版本。
sideload	部署和管理附加设备上的应用程序。旁加载部署和旁加载删除是必需的。
wifi	管附加设备的 Wi-Fi 配置。

如果尝试在没有功能的情况下运行这些命令，将收到一条错误消息，告知你运行 azsphere device enable-development 或用于 azsphere device capability 下载并选择设备的功能文件。