device

项目
09/27/2024

重要

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

管理 Azure Sphere 设备。

操作	说明
app	更改设备上应用程序的状态。
capability	管理设备功能。
证书	管理设备证书存储。
claim	向 Azure Sphere 租户声明以前未认领的设备。
enable-cloud-test	设置设备以禁用调试和接收更新。
enable-development	设置用于本地调试的设备。
image	管理设备的映像。
list	显示租户中的所有设备。
list-attached	列出附加的设备。
manufacturing-state	管理附加设备的生产状态。
network	提供有关设备上的网络接口状态的信息。
recover	使用特殊的恢复模式将新固件加载到设备上。
rescan-attached	将附加的设备重新扫描为故障排除帮助（仅限 Windows）。
restart	重启附加设备。
show	显示有关设备的更新配置的详细信息。
show-attached	显示有关设备本身的附加设备的详细信息。
show-count	显示租户中的设备总数。
show-deployment-status	显示最新部署更新的状态。
show-os-version	显示本地设备操作系统版本。
sideload	将映像加载到附加设备上。
update	通过将设备置于特定设备组中来更新设备。
wifi	管理设备的 Wi-Fi 配置。

应用程序

管理设备上的应用程序。

许多应用选项都需要 appDevelopment 功能，可以使用 azsphere device enable-development 获取该功能。若要启动、停止或调试 SDK 签名的应用程序或生产签名的应用程序，设备必须具有 appDevelopment 功能。

可以使用 azsphere device app stop 和 azsphere device app start 重启正在运行的支持实时的应用程序，以确定它正在运行的实时核心。

操作	说明
show-memory-stats	显示附加设备上的应用程序的内存统计信息。
show-quota	显示由设备上的当前应用程序使用的存储量。
show-status	返回设备上当前应用程序的状态。
start	启动设备上加载的应用程序。
stop	停止在设备上运行的应用程序。

app show-memory-stats

显示附加设备上的应用程序的内存统计信息。仅当配置 appDevelopment 设备功能时，此命令才可用。如果配置堆内存分配跟踪，则会显示其他信息。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device app show-memory-stats
 -------------- -------------
 Name           Usage (bytes)
 ============================
 Total          434176
 User Mode      147456
 Peak User Mode 147456
 -------------- -------------

app show-quota

显示在附加的设备上分配并已使用的可变存储量。

在应用程序清单中设置可变存储配额，Azure Sphere OS 在为文件分配扇区时强制实施配额。因此，如果降低 MutableStorage 值，则使用的存储量不会变化，但报告的已分配值会不同。例如，如果应用程序已使用 16 KB，并且将值更改为 MutableStorage 8 KB，则命令会报告应用程序使用 16 KB 的 8 KB 分配。数据保留在设备上。

可选参数

参数	类型	描述
-i、 --component-id	GUID	指定要为其获取配额信息的组件的 ID。如果省略，则显示所有组件的配额信息。
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device app show-quota
ae4714aa-03aa-492b-9663-962f966a9cc3: 0KB out of 8KB of mutable storage used.

app show-status

显示设备上应用程序的当前状态。

可选参数

参数	类型	描述
-i、 --component-id	GUID	指定要显示其状态的组件的 ID。如果省略，将显示所有组件的状态。
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device app show-status
9ce57001-90eb-45e1-bd0a-4fc07b0c85c9
App state: running

app start

在设备上启动应用程序。

可选参数

参数	类型	描述
--debug-mode	布尔	启动应用程序以进行调试。 `--component-id`必须提供。
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。
-i、 --component-id	GUID	指定要启动的组件的 ID。如果省略，将启动所有应用程序。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device app start
836cbcf1-0b4d-45ab-963a-eadcd5017b6a
App state: running
Core     : High-level

app stop

停止设备上的应用程序。

可选参数

参数	类型	描述
-i、 --component-id	GUID	指定要停止的组件的 ID。如果省略，将停止所有应用程序。
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device app stop
836cbcf1-0b4d-45ab-963a-eadcd5017b6a
App state: stopped

capability

管理设备功能。设备功能确定可以对单个 Azure Sphere 设备执行的操作。

设备功能使用 azsphere device capability download 命令作为文件从 Azure Sphere 安全服务下载。可以使用 azsphere device capability update 命令将设备功能配置应用到附加的 Azure Sphere 设备，并且可以使用 azsphere device capability select 命令创建服务会话。 有关设备功能的详细信息，请参阅设备功能和通信。

操作	说明
下载	从 Azure Sphere 安全服务下载设备功能配置。
select	选择要用于服务会话的下载功能文件。
show-attached	显示附加设备的功能配置。
update	将设备功能配置应用于附加设备。

功能下载

从 Azure Sphere 安全服务下载设备功能。

可以使用 appDevelopment 功能旁加载 SDK 签名的应用程序并启动、停止、调试或删除设备上的任何应用程序。如果没有 appDevelopment 功能，则只能加载云加载型应用程序，不能对其执行启动、停止、调试和删除操作。 appDevelopment 功能作为 azsphere device enable-development 命令的一部分进行应用。

下载 fieldServicing 功能将生成一个包含单一 Azure Sphere 设备功能的文件。 fieldServicing 功能文件可下载到本地计算机，并可与 azsphere device capability select 命令一起使用。

必需的参数

参数	类型	描述
--type	Capability-type	指定要下载的设备功能的类型。值为 appDevelopment、fieldServicing 或 none。使用 none 删除 appDevelopment 功能或 fieldServicing 功能。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在其中运行命令的设备。当附加多个设备或未附加设备时，此参数是必需的。当前附加的设备默认使用。可以为未附加的设备提供设备 ID，也可以指定附加设备的 IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。
--目的地	字符串	指定保存功能配置的路径和文件名。包括绝对路径或相对路径。如果未提供路径，该命令将使用设备 ID.cap 的命名约定<功能类型>前< 8 个字符将文件存储在本地目录中。>
-t、--tenant	GUID 或名称	指定要在其中执行此操作的租户。替代默认选定的租户。可以指定租户 ID 或租户名称。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device capability download --type appDevelopment
The appdevelopment capability was saved as:
 --------------------------------------------
 Result
 ============================================
 C:\capability-file\appdevelopment-<first eight characters of device ID>.cap
 --------------------------------------------

功能选择

选择要与附加的 Azure Sphere 设备一起使用的功能文件。

azsphere device capability select 命令可与任何功能一起使用，但通常与 fieldServicing 功能一起使用以启用服务会话。任何用户角色都有权访问 azsphere device capability select 命令。

使用 fieldServicing 功能时，可在 Azure Sphere 设备与包含该功能文件的本地计算机之间进行通信。 fieldServicing 功能文件用于本地计算机与 Azure Sphere 设备之间的会话，并且该会话的每个命令前都带有一条消息，指示正在使用的功能文件。

若要结束服务会话，请使用 azsphere device capability select --none。

可选参数

参数	类型	描述
--capability-file	字符串	指定要选择的设备功能配置文件的路径和文件名。你可以提供相对或绝对路径。
-n, --none	-	清除任何以前选择的设备功能配置。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device capability select --capability-file appdevcap
The capability session uses C:\capability-file\appdevcap.

capability show-attached

显示存储在附加设备上的功能配置。

注意

该命令显示使用功能文件配置的功能，以及默认情况下在开发板上存在的一些功能（但并非所有功能）。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device capability show-attached
 --------------------
 DeviceCapabilities
 ====================
 EnableFieldServicing
 --------------------

azsphere device capability show-attached
 --------------------
 DeviceCapabilities
 ====================
 EnableAppDevelopment
 --------------------

capability update

将设备功能配置应用于附加设备。

必需的参数

参数	类型	描述
--capability-file	字符串	指定要应用的设备功能文件的路径和文件名。你可以提供相对或绝对路径。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在其中运行命令的设备。当附加多个设备或未附加设备时，此参数是必需的。当前附加的设备默认使用。可以为未附加的设备提供设备 ID，也可以指定附加设备的 IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device capability update --capability-file appdevcap.bin
Using selected capability file: C:\capability-file\appdevcap.bin
The capability file C:\capability-file\appdevcap.bin was added on the device. The device will restart.

证书 (certificate)

管理连接的设备上的证书。

操作	说明
add	将证书添加到附加设备上的证书存储中。
delete	从附加设备的证书存储中删除证书。
list	列出附加设备的证书存储中可用的证书 ID。
show	在附加设备的证书存储中显示证书的详细信息。
show-quota	显示附加设备的证书存储中的可用可用空间。

证书添加

将证书添加到连接的设备上的证书存储。

根 CA 和客户端证书必须采用 .pem 格式才能加载到 Azure Sphere 设备上。需要从相应的服务器获取根 CA 证书，以及设备的客户端证书和私钥（以及（可选）密码）。每个证书都必须由你的 EAP-TLS 网络中的相应服务器生成和签名。网络管理员或安全团队可提供获取证书所需的详细信息。有关获取根 CA 证书的详细信息，请参阅获取和部署 EAP-TLS 网络的证书。

注意

因为客户端证书和根 CA 证书的证书 ID 都是在系统范围内应用，所以，用于添加新证书的 azsphere 命令或函数调用可能会覆盖由先前的命令或函数调用添加的证书，因而可能会导致网络连接失败。强烈建议你制定清晰的证书更新过程，并仔细选择证书 ID。

有关更多信息，请参阅证书 ID。

必需的参数

参数	类型	描述
-i、--cert-id	字符串	指定要添加的证书的标识符。字符串标识符（最多 16 个字符）。有效字符包括大写字母（A-Z）、小写字母（a-z）、数字（0-9）、下划线（_）、句点（.）和连字符（-）。此标识符还用于 EAP-TLS 网络的 Wi-Fi 配置。
--cert-type	字符串	指定要添加的证书类型，即客户端或 rootca。
-p、--public-key-file	字符串	指定公钥证书 .pem 文件的路径。你可以提供相对或绝对路径。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。
--private-key-file	字符串	指定客户端私钥证书 .pem 文件的路径。添加客户端类型的证书时是必需的。你可以提供相对或绝对路径。
-w、 --private-key-password	字符串	指定客户端私钥的可选密码。添加加密的客户端证书私钥时需要此密码。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device certificate add --cert-id certroot --cert-type rootca --public-key-file publiccert.pem
Certificate 'certroot' successfully added.

azsphere device certificate add --cert-id certclient --cert-type client --private-key-file privatekey.pem --private-key-password 1234 --public-key-file publiccert.pem
Certificate 'certclient' successfully added.

证书删除

从附加设备的证书存储中删除证书。

必需的参数

参数	类型	描述
-c、--certificate 或 --cert-id [停用]	字符串	指定要删除的证书的标识符。该 `--cert-id` 参数将停用，将在将来的版本中删除。有关详细信息，请参阅 Azure Sphere CLI 中的重要更改（停用功能）。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device certificate delete --certificate certclient

证书列表

列出设备证书存储中可用的证书。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device certificate list
 -----------
 Identifiers
 ===========
 rootCert
 -----------

证书显示

显示设备的证书存储中单个证书的详细信息。

必需的参数

参数	类型	描述
-c、--certificate 或 --cert-id [停用]	字符串	指定要为其显示详细信息的证书的标识符。该 `--cert-id` 参数将停用，将在将来的版本中删除。有关详细信息，请参阅 Azure Sphere CLI 中的重要更改（停用功能）。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device certificate show --certificate certclient
---------- ------------------- ------------------- ----------------------------------- -----------------------------------
 Id         StartDate           EndDate             SubjectName                         IssuerName
 ==========================================================================================================================
 certclient 06/08/2019 19:15:48 06/08/2069 19:25:44 /DC=local/DC=azsphere/CN=azsphereca /DC=local/DC=azsphere/CN=azsphereca
 ---------- ------------------- ------------------- ----------------------------------- -----------------------------------

证书显示 - 配额

显示附加设备的证书存储中的可用可用空间。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device certificate show-quota
--------------
Available space (bytes)
==============
24514
--------------

claim

声明之前未认领的设备属于当前 Azure Sphere 租户。

重要

在声明设备之前，请确保已登录到正确的 Azure Sphere 租户。设备只能声明一次。声明后，设备无法移动到其他租户。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在其中运行命令的设备。当附加多个设备或未附加设备时，此参数是必需的。当前附加的设备默认使用。可以为未附加的设备提供设备 ID，也可以指定附加设备的 IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。
-t、--tenant	GUID 或名称	指定要在其中执行此操作的租户。替代默认选定的租户。可以指定租户 ID 或租户名称。
--force	布尔	强制在当前用户的所选 Azure Sphere 租户中声明设备。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device claim
warn: You are claiming a device to the following tenant:
warn: a323c263-2aa3-2559-aabb-a3fc32631900 (Tenant1)
warn: Do you want to claim the device ID 352fe1f59e40ef8a9266415e81af32b5b07d8f2bbd6b5650cef4a70b86c7fcbc70b129a41fbc6d02f8bb4aaabc52cd5740c85427d205e46a166b7e41135eb968 to this tenant?
warn: You cannot change the Azure Sphere tenant this device is claimed to once this action has completed.
Enter 'yes' to continue. Enter anything else to exit.
> yes
Claiming device.
Successfully claimed device ID '352fe1f59e40ef8a9266415e81af32b5b07d8f2bbd6b5650cef4a70b86c7fcbc70b129a41fbc6d02f8bb4aaabc52cd5740c85427d205e46a166b7e41135eb968' into tenant 'Tenant1' with ID 'a323c263-2aa3-2559-aabb-a3fc32631900'.

enable-cloud-test

通过禁用应用程序开发，删除任何现有应用程序以及启用 cloud-loaded 应用程序更新来准备附加设备以测试云加载。

它需要将设备连接到电脑并且仅在附加设备上运行。

特别是，enable-cloud-test：

删除附加设备的 appDevelopment 功能。
将设备分配到启用云加载的应用程序更新的设备组。
重新启动设备。

enable-cloud-test 执行的特定任务取决于是否已为此设备分配了产品和设备组。

如果 azsphere device enable-cloud-test 在没有参数的情况下运行，则设备将放置在设备的当前产品的 Field Test 设备组中。这是为每个产品自动创建的默认设备组之一，支持应用程序更新。如果设备没有产品，或者字段测试设备组不存在，则会返回错误。

如果指定了产品，则设备将放置在该产品的“现场测试”设备组中。如果此设备组不存在，则返回错误。

如果指定了设备组，则会将设备置于其中。如果目标设备组未启用应用程序更新，则返回错误。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。
-p、--product	GUID 或名称	指定目标产品。指定此项后，设备将移动到此产品的默认字段测试设备组，除非 `--device-group` 另有指定。可以指定 Azure Sphere 产品的 ID 或名称。
-t、--tenant	GUID 或名称	指定要在其中执行此操作的租户。替代默认选定的租户。可以指定租户 ID 或租户名称。
-g、--device-group	GUID 或名称	指定要将设备移动到的设备组。可以指定设备组 ID 或设备组名称。若要使用设备组名称，必须以格式提供产品名称和设备组名称 `<product-name/device-group-name>` 。默认情况下，这是产品的字段测试设备组。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

示例 1。按 ID 将设备分配给现有设备组

本示例将附加设备分配给现有产品和设备组。

azsphere device enable-cloud-test --device-group '3548b179-m16f-4f64-6dme-d3c643662e76'
Your internal capabilities will be retained, including the Enable App development capability. Sideloaded images may be removed by over-the-air application updates.
Getting device group by ID '3548b179-m16f-4f64-6dme-d3c643662e76'.
Leaving any existing applications on the device.
Setting device group to 'Field Test' with ID '3548b179-m16f-4f64-6dme-d3c643662e76')
Successfully updated device's device group.
Successfully set up device for application updates.
(Device ID: 'ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABCD')

示例 2。将设备分配到不同的设备组

本示例与前面的示例类似，但保留设备的现有产品。此处，enable-cloud-test 操作会更改设备所属的设备组，并删除 appDevelopment 功能。此命令对于将设备从不启用应用程序更新的开发环境移动到启用此功能的生产环境非常有用。

azsphere device enable-cloud-test --device-group "Marketing/Field Test"

示例 3。按产品名称分配设备

此示例启用云加载，并按名称将设备分配给产品。

azsphere device enable-cloud-test --product DW100

enable-development

通过在设备上启用旁加载和调试，并将其分配给禁用云中的应用程序更新的设备组，启用设备进行开发。默认情况下，这是设备的产品的开发设备组，但可以指定其他设备组。请勿在制造方案中使用。有关详细信息，请参阅制造连接的设备。

特别是，enable-development：

下载并应用 附加设备的 appDevelopment 功能。
将设备分配到未启用云加载的应用程序更新的设备组。
重新启动设备。

如果运行不带参数的 azsphere device enable-development 命令：

如果设备尚没有产品或设备组，则该命令会下载并应用附加设备的 appDevelopment 功能，然后重启设备。任何现有应用都保留在设备上，并且 OS 已更新。用于声明设备的安装过程和生成高级应用程序的快速入门不受影响。
如果设备已有产品，则该命令会将设备移到产品的开发设备组。默认情况下，此组禁用应用程序更新，确保不会覆盖旁加载的应用。

如果使用参数运行 azsphere device enable-development 命令 --product ：

将设备置于产品的“开发设备”组中。如果此设备组不存在，则返回错误。

如果使用参数运行 azsphere device enable-development 命令 --device-group ：

指定设备在指定的设备组中的位置。目标设备组不得启用应用程序更新或返回错误。

在某些情况下，azsphere device enable-development 会报告错误并建议你声明设备。如果已声明设备，请使用 azsphere tenant show-selected 确保登录到已声明设备的租户。否则，请使用 azsphere login 登录到正确的租户。确定已登录到相应的租户时，请使用 azsphere device 声明 声明来声明设备。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。
-g、--device-group	GUID 或名称	指定要将设备移动到的设备组。如果省略，则将设备分配给默认组。可以指定设备组 ID 或设备组名称。若要使用设备组名称，必须以格式提供产品名称和设备组名称 `<product-name/device-group-name>` 。
-r、 --enable-rt-core-debugging	布尔	安装对实时内核上运行的应用程序进行调试所需的驱动程序。此选项需要管理员权限。
-p、--product	GUID 或名称	指定目标产品。指定此值时，设备将移动到此产品的默认开发设备组，除非 `--device-group` 另有指定。可以指定 Azure Sphere 产品的 ID 或名称。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device enable-development
Capability configuration has been successfully cleared.
PS C:\Users\v-shypr> azsphere device enable-development
Getting device group 'Development' for product 'DW100'.
The device already has the 'Enable App development' capability. No changes will be applied to its existing capabilities.
Setting device group to 'Development' with ID '7f860cc1-4949-4000-a541-9a988ba4c3cd'.
Successfully disabled application updates.
Installing debugging server to device.
Deploying 'C:\Program Files (x86)\Microsoft Azure Sphere SDK\DebugTools\gdbserver.imagepackage' to the attached device.
Image package 'C:\Program Files (x86)\Microsoft Azure Sphere SDK\DebugTools\gdbserver.imagepackage' has been deployed to the attached device.
Previous device capabilities retained. Ensure that you have the correct development capabilities installed before continuing.
Successfully set up device for application development, and disabled application updates.
(Device ID: '352fe1f59e40ef8a9266415e81af32b5b07d8f2bbd6b5650cef4a70b86c7fcbc70b129a41fbc6d02f8bb4aaabc52cd5740c85427d205e46a166b7e41135eb968')

image

返回有关安装在或面向附加设备上的映像的信息。

操作	说明
list-installed	提供有关当前安装在附加设备上的映像的详细信息。
list-targeted	提供有关面向附加设备的映像的详细信息。

image list-installed

列出附加设备上安装的映像。信息列表包括组件和映像 ID。

注意

长图像名称截断为 31 个字符。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。
-f, --full	布尔	列出设备上安装的所有软件映像。默认情况下，仅列出应用程序映像、调试程序以及板配置映像。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device image list-installed
Installed images:
 --> gdbserver
   --> Image type:   Application
   --> Component ID: 8548b129-b16f-4f84-8dbe-d2c847862e78
   --> Image ID:     dc6205bd-4478-4c9b-81ad-5e41ac23ed68
 --> CrashApplicatio
   --> Image type:   Application
   --> Component ID: 9ce57001-90eb-45e1-bd0a-4fc07b0c85c9
   --> Image ID:     cc77124e-6447-4c0f-9f99-fc0ad5ef46ef

image list-targeted

列出已上传到 Azure Sphere 安全服务的映像，并在更新设备时安装。有关确保 Azure Sphere 设备准备好接受基于云的应用程序更新的详细信息，请参阅为设备启用基于云的部署。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在其中运行命令的设备。当附加多个设备或未附加设备时，此参数是必需的。当前附加的设备默认使用。可以为未附加的设备提供设备 ID，也可以指定附加设备的 IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。
-t、--tenant	GUID 或名称	指定要在其中执行此操作的租户。替代默认选定的租户。可以指定租户 ID 或租户名称。
-f, --full	布尔	列出 Azure Sphere 租户中的所有映像。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device image list-targeted
 ----------------------- ------------------------------------ ------------------------------------ ---------------- --------------------
 Name                    ComponentId                          ImageId                              ImageType       RegionalDataBoundary 
 =======================================================================================================================================
 HelloWorld_HighLevelApp 1689d8b2-c835-2e27-27ad-e894d6d15fa9 50419cb6-a33b-4cbe-8bd0-425048664b6f Applications    None   
 ----------------------- ------------------------------------ ------------------------------------ -------------------------------------

列表

列出租户中的所有设备。列表在前 500 台设备之后截断。

可选参数

参数	类型	描述
-t、--tenant	GUID 或名称	指定要在其中执行此操作的租户。替代默认选定的租户。可以指定租户 ID 或租户名称。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device list
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ -------- ------------------------------------ ------------------------------------
 DeviceId                                                                                                                         TenantId                             ChipSku  ProductId                            DeviceGroupId
 ========================================================================================================================================================================================================================================================
 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968 a323c263-2aa3-2559-aabb-a3fc32631900 MT3620AN 4f48d618-09f7-45dc-a5a4-1433cabbee91 6f52bead-700d-4289-bdc2-2f11f774270e
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ -------- ------------------------------------ ------------------------------------
 ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABCD a323c263-2aa3-2559-aabb-a3fc32631900 MT3620AN 4f48d618-09f7-45dc-a5a4-1433cabbee91 6f52bead-700d-4289-bdc2-2f11f774270e
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ -------- ------------------------------------ ------------------------------------

可以使用 --query 参数来自定义为此命令显示的输出。有关详细信息，请参阅查询 CLI 命令输出。

以下示例演示如何仅选择设备 ID 和产品 ID：

azsphere device list --query '[].{DeviceId:deviceId, ProductId:productId}'
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------
 DeviceId                                                                                                                         ProductId
 =====================================================================================================================================================================
 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968 4f48d618-09f7-45dc-a5a4-1433cabbee91
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------
 ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABCD 4f48d618-09f7-45dc-a5a4-1433cabbee91
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------

提示

运行 azsphere product show --product-ID>< 以查看产品名称或 azsphere device-group show --device-group <devicegroup-ID> 以查看设备组名称。

list-attached

列出附加到本地电脑的设备。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device list-attached
1 device attached:
--> Device ID: 352fe1f59e40ef8a9266415e81af32b5b07d8f2bbd6b5650cef4a70b86c7fcbc70b129a41fbc6d02f8bb4aaabc52cd5740c85427d205e46a166b7e41135eb968
  --> Is responsive: yes
  --> IP address: 192.128.48.1
  --> Connection path: 21143

manufacturing-state

管理附加设备的生产状态。

操作	说明
show	显示附加设备的生产状态。
update	更新附加设备的制造状态。

注意

生产状态更改是永久性的并且不可逆。

显示生产状态

显示附加设备的生产状态。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device manufacturing-state show
------------------
ManufacturingState
==================
Module1Complete
------------------

manufacturing-state update

更新附加设备的制造状态。有关详细信息，请参阅设置设备制造状态。

注意

生产状态更改是永久性的并且不可逆。

必需的参数

参数	类型	描述
-s、--state	制造状态	指定要为设备设置的生产状态。可能的状态包括 `DeviceComplete` 和 `Module1Complete`。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device manufacturing-state update --state Module1Complete
Updating manufacturing state to Module1Complete.
Restarting device for changes to take effect.
The device was successfully restarted.

network

提供有关附加设备上的网络接口状态的信息。

操作	说明
enable	在附加设备上启用网络接口。
disable	禁用附加设备上的网络接口。
list-firewall-rules	列出附加设备的防火墙规则。
list-interfaces	列出附加设备的网络接口。
proxy	管理网络代理设置。
show-diagnostics	显示附加设备上的一个或多个无线网络的网络诊断。
show-status	显示附加设备的网络状态。
update-interface	更新设备的网络接口配置。

网络启用

在附加设备上启用网络接口。

注意

配置以太网 eth0 和 wlan0 连接支持此命令。如果配置 lo 或 azspheresvc配置错误，则返回错误。

必需的参数

参数	类型	描述
--接口	string	指定要启用的接口。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device network enable --interface wlan0
Network interface configuration is successfully applied to the device.
Run the command 'azsphere device network list-interfaces' to view details of the network interfaces for the attached device.

网络禁用

禁用附加设备上的网络接口。

注意

配置以太网 eth0 和 wlan0 连接支持此命令。如果配置 lo 或 azspheresvc配置错误，则返回错误。

必需的参数

参数	类型	描述
--接口	string	指定要启用的接口。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device network disable --interface wlan0
Network interface configuration is successfully applied to the device.
Run the command 'azsphere device network list-interfaces' to view details of the network interfaces for the attached device.

network list-firewall-rules

列出附加设备的防火墙规则。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

将显示以下规则：

防火墙规则集名称：显示防火墙规则集块的名称。
- 这些值为预路由、POSTROUTING、INPUT、FORWARD 和 OUTPUT。
规则集有效：显示规则集的状态。值为 True 或 False。
防火墙规则集规则：显示以下规则的值：
- 源 IP：显示发送计算机的 IP 地址。
- 源掩码：显示发送计算机的网络掩码。
- 目标 IP：显示目标计算机的 IP 地址。
- 目标掩码：显示析构计算机的网络掩码。
- UID：显示应用于规则的用户标识。 4294967295（0xFFFFFFFF）意味着没有应用 UID，因此它适用于所有人。
- 操作：显示要执行的操作。这些值可以接受或删除。
- 接口 IN 名称：显示输入接口名称。例如 ，wlan0。
- 接口输出名称：显示输出接口名称。例如 ，wlan0。
- 状态：显示连接状态。这些值是无、 已建立或 相关的。
- TCP 掩码：显示 TCP 掩码数组。这些值为 fin、syn、rst、psh、ack 和 urg。
- TCP Cmp：显示 TCP 标志数组。这些值是 urg、ack、psh、rst、syb 和 fin。
- TCP Inv：布尔值指示应反转 TCP 标志的感觉。值为 True 或 False。
- 协议：显示防火墙规则的协议。值为 icmp、igmp、tcp、udp。
- 源端口范围：显示来自发送流量的源的端口范围。该值可以介于 0 和 65535 之间。
- 目标端口范围：在接收流量的目标上显示端口范围。该值可以介于 0 和 65535 之间。
- 数据包：显示数据包数。
- 字节数：显示字节数。

下面列出了标志的简要摘要：

URG：紧急指针字段显著
ACK：确认字段显著
PSH：推送函数
RST：重置连接
SYN：同步序列号
FIN：发件人不再提供任何数据

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device network list-firewall-rules
 ----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
 Ruleset     IsValid SourceIp     SourceMask      DestinationIp   DestinationMask UID        Action InterfaceInName TcpInv Protocol SourcePortRange DestinationPortRange Packets Bytes  TcpMask TcpCmp
 =====================================================================================================================================================================================================
 PREROUTING  False   None         None            None            None            None       None   None            None   None     None            None                 None    None   None    None
 ----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
 INPUT       True    <value>      <value>         <value>         <value>         <value>     accept                 False  any      0-65535         0-65535              0       0      None    None
 ----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
 INPUT       True    <value>      <value>         <value>         <value>         <value>     accept                 True   tcp      0-65535         0-65535              823     394754 syn,ack syn
 ----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
 INPUT       True    192.168.35.1 <value>         <value>         <value>         <value>     accept azspheresvc     False  any      0-65535         0-65535              15      780    None    None
 ----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
 INPUT       True    <value>      <value>         <value>         <value>         <value>     accept                 False  udp      53-53           0-65535              0       0      None    None
 ----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
 INPUT       True    <value>      <value>         <value>         <value>         <value>     accept                 False  udp      53-53           0-65535              0       0      None    None
 ----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
 INPUT       True    <value>      <value>         <value>         <value>         <value>     accept                 False  udp      53-53           0-65535              0       0      None    None
 ----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------

network list-interfaces

列出附加设备的网络接口。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device network list-interfaces
 ------------- ----------- ------------------ ---------- ------------- ------------------- ------------ -----------------
 InterfaceName InterfaceUp ConnectedToNetwork IpAcquired IpAddresses   ConnectedToInternet IpAssignment HardwareAddress
 ========================================================================================================================
 azspheresvc   True        False              False      <value>       False               None         None
 ------------- ----------- ------------------ ---------- ------------- ------------------- ------------ -----------------
 eth0          True        True               True       <value>       True                dynamic      <value>
 ------------- ----------- ------------------ ---------- ------------- ------------------- ------------ -----------------
 lo            True        False              False      <value>       False               None         None
 ------------- ----------- ------------------ ---------- ------------- ------------------- ------------ -----------------
 wlan0         True        True               True       <value>       True                dynamic      <value>
 ------------- ----------- ------------------ ---------- ------------- ------------------- ------------ -----------------

网络代理

管理用于网络连接的代理地址。有关配置 Azure Sphere 设备以通过代理服务器连接到 Internet 的详细信息，请参阅通过代理服务器进行连接。

注意

目前仅支持 HTTP 代理。

操作	说明
代理应用	在附加设备上配置网络代理。
代理删除	删除附加设备上的代理连接。
代理显示	显示附加设备上的代理连接。

代理应用

在附加设备上配置网络代理。

必需的参数

参数	类型	描述
-a、--address	字符串	指定要使用的代理的网络地址。
-t、--authentication	字符串	指定要使用的身份验证类型。允许的值：`anonymous` 或 `basic`。如果代理需要用户名和密码，请将其设置为 `basic`，否则使用 `anonymous`。
-r、--port	Integer	指定要使用的网络地址上的端口。该值必须等于或小于 65535。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。
--使	字符串	指定是否应启用代理。必须设置或`--enable--disable`设置。
--禁用	字符串	指定是否应禁用代理。必须设置或`--enable--disable`设置。
-n、 --no-proxy-addresses	字符串	指定设备应避免用于代理连接的空间分隔网络地址数组。
-p、--password	字符串	指定仅用于基本身份验证的代理身份验证的密码。最大长度：64 个字符。
-u、--username	字符串	指定代理身份验证的用户名。仅用于基本身份验证。最大长度：64 个字符。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device network proxy apply --address contoso.com --authentication anonymous --port 8080 --enable
 ----------- ------- ----- ------------------ ----------------
 Address     Enabled Port  AuthenticationType NoProxyAddresses
 =============================================================
 contoso.com True   8080  anonymous
 ----------- ------- ----- ------------------ ----------------

代理删除

删除附加设备上的代理连接。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device network proxy delete

代理显示

显示附加设备上的代理连接。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device network proxy show
 ----------- ------- ----- ------------------ ----------------
 Address     Enabled Port  AuthenticationType NoProxyAddresses
 =============================================================
 contoso.com True   8080  anonymous
 ----------- ------- ----- ------------------ ----------------

网络显示诊断

显示附加设备上的一个或多个 Wi-Fi 网络的诊断。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。
-n、--network	Integer	指定要为其显示诊断的 Wi-Fi 网络的 ID。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device network show-diagnostics
 ------------------------- --------- ----- ------------- --------------- --------
 Timestamp                 NetworkId Ssid  ConfigState   ConnectionState Error
 ================================================================================
 2021-06-16T20:51:29+00:00 0         <value> temp-disabled disconnected    WrongKey
 ------------------------- --------- ----- ------------- --------------- --------

network show-status

显示附加设备的网络状态。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device network show-status
 --------------------------- --------------- -----
 DeviceAuthenticationIsReady NetworkTimeSync Proxy
 =================================================
 True                        complete        ready
 --------------------------- --------------- -----

network update-interface

更新设备的以太网网络接口。有关为设备设置 MAC 地址的详细信息，请参阅为以太网配置设备。

注意

配置以太网 eth0 连接支持此命令。如果配置 lo或配置错误， azspheresvc wlan0则返回错误。

必需的参数

参数	类型	描述
--hardware-address	字符串	指定要使用以下格式之一为设备设置的硬件地址： `AA:BB:33:DD:EE:FF` 或 `aa:bb:33:dd:ee:ff`。
--接口或 --interface-name [停用]	字符串	指定要配置的接口的名称。运行 azsphere device network list-interfaces 以查看附加设备的网络接口的详细信息。该 `--interface-name` 参数将停用，将在将来的版本中删除。有关详细信息，请参阅 Azure Sphere CLI 中的重要更改（停用功能）。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device network update-interface --interface eth0 --hardware-address ba:98:76:54:32:10

recover

替换设备上的系统软件。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。当前附加的设备默认使用。指定设备的 ID、IP 地址或本地连接 ID。
-c、--capability	字符串	指定要在恢复期间应用于设备的设备功能映像。
-i、--images	字符串	指定包含要写入设备的映像包的文件夹路径。默认情况下，恢复使用 SDK 中的映像，除非使用此标志提供了备用路径。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

示例 1：

azsphere device recover
Downloading recovery images...
Download complete.
Starting device recovery. Please note that this may take up to 10 minutes.
Board found. Sending recovery bootloader.
Erasing flash.
Sending 17 images. (5443272 bytes to send)
Sent 1 of 17 images. (5440896 of 5443272 bytes remaining)
Sent 2 of 17 images. (5414844 of 5443272 bytes remaining)
Sent 3 of 17 images. (5311892 of 5443272 bytes remaining)
Sent 4 of 17 images. (5311500 of 5443272 bytes remaining)
Sent 5 of 17 images. (5041520 of 5443272 bytes remaining)
Sent 6 of 17 images. (5024908 of 5443272 bytes remaining)
Sent 7 of 17 images. (4994856 of 5443272 bytes remaining)
Sent 8 of 17 images. (2397456 of 5443272 bytes remaining)
Sent 9 of 17 images. (885796 of 5443272 bytes remaining)
Sent 10 of 17 images. (861220 of 5443272 bytes remaining)
Sent 11 of 17 images. (758608 of 5443272 bytes remaining)
Sent 12 of 17 images. (135796 of 5443272 bytes remaining)
Sent 13 of 17 images. (70048 of 5443272 bytes remaining)
Sent 14 of 17 images. (41164 of 5443272 bytes remaining)
Sent 15 of 17 images. (32768 of 5443272 bytes remaining)
Sent 16 of 17 images. (16384 of 5443272 bytes remaining)
Sent 17 of 17 images. (0 of 5443272 bytes remaining)
Finished writing images; rebooting board.
Device ID: 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968
Device recovered successfully.

示例 2：

azsphere device recover --capability "C:\Users\capability file\capability_352FE1F_5.bin"
Downloading recovery images...
Download complete.
Starting device recovery. Please note that this may take up to 10 minutes.
Board found. Sending recovery bootloader.
Erasing flash.
Sending 16 images. (5474668 bytes to send)
Sent 1 of 16 images. (5447384 of 5474668 bytes remaining)
Sent 2 of 16 images. (5343788 of 5474668 bytes remaining)
Sent 3 of 16 images. (5343396 of 5474668 bytes remaining)
Sent 4 of 16 images. (5073416 of 5474668 bytes remaining)
Sent 5 of 16 images. (5056612 of 5474668 bytes remaining)
Sent 6 of 16 images. (5026240 of 5474668 bytes remaining)
Sent 7 of 16 images. (2479376 of 5474668 bytes remaining)
Sent 8 of 16 images. (889892 of 5474668 bytes remaining)
Sent 9 of 16 images. (865316 of 5474668 bytes remaining)
Sent 10 of 16 images. (754512 of 5474668 bytes remaining)
Sent 11 of 16 images. (135796 of 5474668 bytes remaining)
Sent 12 of 16 images. (70048 of 5474668 bytes remaining)
Sent 13 of 16 images. (41164 of 5474668 bytes remaining)
Sent 14 of 16 images. (32768 of 5474668 bytes remaining)
Sent 15 of 16 images. (16384 of 5474668 bytes remaining)
Sent 16 of 16 images. (0 of 5474668 bytes remaining)
Finished writing images; rebooting board.
Device ID: 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968
Device recovered successfully.

rescan-attached

通过对附加设备的所有 FTDI 端口进行电源循环重新扫描，并显示附加设备的总计数。在 Windows 上排查设备连接问题时使用此命令。此命令仅在 Windows 上运行。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

 azsphere device rescan-attached
 -----------
 Count
 ===========
 2
 -----------

restart

重启附加设备。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device restart
Restarting device.
Device restarted successfully.

显示

显示 Azure Sphere 租户中附加设备的详细信息。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在其中运行命令的设备。当附加多个设备或未附加设备时，此参数是必需的。当前附加的设备默认使用。可以为未附加的设备提供设备 ID，也可以指定附加设备的 IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。
-t、--tenant	GUID 或名称	指定要在其中执行此操作的租户。替代默认选定的租户。可以指定租户 ID 或租户名称。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device show
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ -------- ------------------------------------ ------------------------------------
 DeviceId                                                                                                                         TenantId                             ChipSku  ProductId                            DeviceGroupId
 ========================================================================================================================================================================================================================================================
 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968 a323c263-2aa3-2559-aabb-a3fc32631900 MT3620AN 6f52bead-700d-4289-bdc2-2f11f774270e 7f860cc1-4949-4000-a541-9a988ba4c3cd
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ -------- ------------------------------------ ------------------------------------

可以使用 --query 参数来自定义为此命令显示的输出。有关详细信息，请参阅查询 CLI 命令输出。

以下示例演示如何仅选择设备 ID 和产品 ID：

azsphere device show --device 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968  --query '{DeviceId:deviceId, ProductId:productId}'
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------
 DeviceId                                                                                                                         ProductId
 =====================================================================================================================================================================
 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968 6f52bead-700d-4289-bdc2-2f11f774270e
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------

show-attached

显示有关设备本身的附加设备的信息。这些详细信息与 Azure Sphere 安全服务为设备存储的详细信息不同。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device show-attached
Device ID: 352fe1f59e40ef8a9266415e81af32b5b07d8f2bbd6b5650cef4a70b86c7fcbc70b129a41fbc6d02f8bb4aaabc52cd5740c85427d205e46a166b7e41135eb968
IP address: 192.128.48.1
Connection path: 21143

show-deployment-status

显示设备的应用程序和操作系统更新的部署状态。

使用此命令可以找出设备运行的 Azure Sphere OS 版本或当前部署更新是否已完成。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。
-t、--tenant	GUID 或名称	指定要在其中执行此操作的租户。替代默认选定的租户。可以指定租户 ID 或租户名称。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device show-deployment-status
Your device is running Azure Sphere OS version <version-number>.
The Azure Sphere Security Service is targeting this device with Azure Sphere OS version <version-number>.
Your device has the expected version of the Azure Sphere OS: <version-number>.

在此示例中， <版本号> 表示当前操作系统版本。

show-count

显示当前租户中的设备数。

可选参数

参数	类型	描述
-t、--tenant	GUID 或名称	指定要在其中执行此操作的租户。替代默认选定的租户。可以指定租户 ID 或租户名称。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

 azsphere device show-count
 ------
 Result
 ======
 2
 ------

show-os-version

显示附加设备上的当前操作系统版本。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device show-os-version
Your device is running Azure Sphere OS version <version-number>

在此示例中， <版本号> 表示当前操作系统版本。

sideload

管理设备上的应用程序。

一旦设备处于制造状态 DeviceComplete，某些旁加载选项需要其他功能。 fieldServicing 功能允许你部署和删除临时生产签名的映像，并部署永久的生产签名映像。 appDevelopment 功能允许部署和删除生产签名映像和 SDK 签名映像。

操作	说明
delete	从设备中删除当前应用程序。
部署：	将应用程序加载到设备上。
set-deployment-timeout	设置部署超时时间段（以秒为单位）。
show-deployment-timeout	显示部署超时时间段（以秒为单位）。

请注意，参数到 startstopshow-quota show-statusazsphere device app 命令和已移动到 azsphere device app 命令。

sideload delete

从设备中删除应用程序。

仅当配置 appDevelopment 设备功能时，此命令才可用。

可选参数

参数	类型	描述
-i、 --component-id	GUID	指定要从设备中删除的应用程序的 ID。如果省略，将删除所有应用程序。
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device sideload delete
Component '54acba7c-7719-461a-89db-49c807e0fa4d' deleted.

sideload deploy

将应用程序加载到附加设备上并启动应用程序。

如果应用程序清单请求设备上已有的应用程序正在使用的资源，则此命令将失败。在这种情况下，可使用“azsphere device sideload delete”删除现有应用程序，然后再次尝试旁加载。 azsphere device sideload delete 命令同时删除高级应用程序和实时应用程序。若要删除一个应用程序并保留另一个应用程序，请指定要删除的应用程序的组件 ID。

同一命令可用于部署高级应用程序和支持实时的应用程序。

注意

安装使用外围设备的新应用程序并满足以下条件时，将触发设备重启：

设备的制造状态设置为 DeviceComplete。
设备上不存在 appDevelopment 功能。有关详细信息，请参阅外围配置锁定。

如果启动设备重启，请等待重启完成，设备响应迅速。

必需的参数

参数	类型	描述
-p、--image-package	字符串	指定要在设备上加载的映像包的路径和文件名。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。
-m、--manual-start	布尔	指定在加载应用程序后不自动启动应用程序。
--force	布尔	强制部署映像，该映像使用可能不再受支持的 Beta API。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device sideload deploy --image-package C:\Users\LocalSamples\HelloWorld\HelloWorld_HighLevelApp\out\ARM-Debug\HelloWorld_HighLevelApp.imagepackage
Deploying 'C:\Users\LocalSamples\HelloWorld\HelloWorld_HighLevelApp\out\ARM-Debug\HelloWorld_HighLevelApp.imagepackage' to the attached device.
Image package 'C:\Users\LocalSamples\HelloWorld\HelloWorld_HighLevelApp\out\ARM-Debug\HelloWorld_HighLevelApp.imagepackage' has been deployed to the attached device.

sideload set-deployment-timeout

设置在设备上旁加载映像的部署超时值（以秒为单位）。

必需的参数

参数	类型	描述
-v、--value	Integer	指定旁加载命令超时之前的持续时间（以秒为单位）。该值必须是正整数。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device sideload set-deployment-timeout --value 60
 ------------------
 Deployment timeout
 ==================
 60
 ------------------

sideload show-deployment-timeout

显示设备上旁加载映像的当前部署超时值（以秒为单位）。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device sideload show-deployment-timeout
 ------------------
 Deployment timeout
 ==================
 60
 ------------------

update

将设备移动到 Azure Sphere 租户中的其他设备组。

除了在产品中创建设备组外，还会在创建产品时添加五个默认设备组：

开发：仅接受系统软件更新。不接受应用程序更新。
字段测试：接受来自 Azure Sphere 安全服务的所有更新。
生产：接受来自 Azure Sphere 安全服务的所有更新。
生产 OS 评估：接受来自 Azure Sphere 安全服务的所有更新。
字段测试 OS 评估：接受来自 Azure Sphere 安全服务的所有更新。

有关部署中涉及的基本元素的详细信息，请参阅部署基础知识。

可选参数

参数	类型	描述
-g、--device-group	GUID 或名称	指定要在其中移动设备的设备组。可以指定设备组 ID 或设备组名称。若要使用设备组名称，必须以格式提供产品名称和设备组名称 `<product-name/device-group-name>` 。
-d、--device	字符串	指定要在其中运行命令的设备。当附加多个设备或未附加设备时，此参数是必需的。当前附加的设备默认使用。可以为未附加的设备提供设备 ID，也可以指定附加设备的 IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。
-t、--tenant	GUID 或名称	指定要在其中执行此操作的租户。替代默认选定的租户。可以指定租户 ID 或租户名称。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device update --device-group AW100/Marketing
 ------------------------------------------------------------------------------------------------------ ------------------------------------ -------- ------------------------------------ ------------------------------------
 DeviceId                                                                                               TenantId                             ChipSku  ProductId                            DeviceGroupId
 ==============================================================================================================================================================================================================================
 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85 a323c263-2aa3-2559-aabb-a3fc32631900 MT3620AN 6f52bead-700d-4289-bdc2-2f11f774270e 7f860cc1-4949-4000-a541-9a988ba4c3cd
 427D205E46A166B7E41135EB968
 ------------------------------------------------------------------------------------------------------ ------------------------------------ -------- ------------------------------------ ------------------------------------

可以使用 --query 参数来自定义为此命令显示的输出。有关详细信息，请参阅查询 CLI 命令输出。

以下示例演示如何仅选择设备 ID 和产品 ID：

azsphere device update --device-group AW100/Marketing  --query '{DeviceId:deviceId, ProductId:productId}'
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------
 DeviceId                                                                                                                         ProductId
 =====================================================================================================================================================================
 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968 6f52bead-700d-4289-bdc2-2f11f774270e
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------

wifi

管理附加设备的 Wi-Fi 配置。

若要在 Wi-Fi 网络上使用设备，必须添加有关网络的信息并在设备上启用网络。虽然可以在 SSID 中输入非 ASCII 字符，但 azsphere 无法正确显示它们。

如果应用程序使用 Wi-Fi 配置 API，则还必须在应用程序的 app_manifest.json 文件中包括 WifiConfig 功能。

操作	说明
add	将无线网络的详细信息添加到设备。
disable	禁用设备上的无线网络。
enable	启用设备上的无线网络。
forget	从设备中删除无线网络的详细信息。
list	列出设备的当前 Wi-Fi 配置。
reload-config	重新加载设备的 Wi-Fi 配置。
scan	扫描可用的网络。
show	显示 Wi-Fi 配置的详细信息。
show-status	显示无线接口的状态。

wifi add

将 Wi-Fi 网络的详细信息添加到附加设备。

设备可具有多个 Wi-Fi 连接。虽然可以在 SSID 中输入非 ASCII 字符，但 azsphere 无法正确显示它们。可以包含 --targeted-scan 用于连接到隐藏 SSID 的参数。有关详细信息，请参阅将 Azure Sphere 连接到 Wi-Fi。

必需的参数

参数	类型	描述
-s、--ssid	字符串	指定网络的 SSID。网络 SSID 区分大小写。

可选参数

参数	类型	描述
--client-cert-id	字符串	[EAP-TLS]指定标识客户端证书（包含公钥和私钥）的标识符（最多 16 个字符）。需要设置 EAP-TLS 网络。
--client-id <user@domain>	字符串	[EAP-TLS]指定网络 RADIUS 服务器为身份验证识别的 ID。对于某些 EAP-TLS 网络是必需的。
--config-name	字符串	指定一个字符串（最多 16 个字符），指定网络配置的名称。
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。
--root-ca-cert-id	字符串	[EAP-tLS]指定标识符（最多 16 个字符），用于标识设备对服务器进行身份验证的 EAP-TLS 网络的服务器的根 CA 证书。
--targeted-scan	布尔	即使不广播或由于网络拥塞而被隐藏，也会尝试连接到网络。
-p、--psk	字符串	指定新网络的 WPA/WPA2 密钥。省略可将 SSID 添加为开放网络。如果密钥包含和号 (&)，请将密钥括在引号中。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device wifi add --ssid MyNetwork --psk MyPassword
Successfully added network:
 ----- -------- ------------------ --------------- ------------- ------------
 ID    SSID     ConfigurationState ConnectionState SecurityState TargetedScan
 ============================================================================
 1     MyNetwork enabled            unknown         psk           False
 ----- -------- ------------------ --------------- ------------- ------------

如果网络 SSID 或密钥具有嵌入空格或安和号，请将 SSID 或密钥括在单引号中。如果 SSID 或密钥包含引号，请使用反斜杠对引号进行转义。如果反斜杠是值的一部分，则不必进行转义。有关详细信息，请参阅引号和转义字符。例如：

azsphere device wifi add --ssid "New SSID" --psk "key \'value\' with quotes"

wifi disable

禁用附加设备上的 Wi-Fi 网络。

必需的参数

参数	类型	描述
-i、--id	Integer	指定要禁用的网络的 ID。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device wifi disable --id 0
Successfully disabled network:
----- -------- ------------------ --------------- ------------- ------------
ID    SSID     ConfigurationState ConnectionState SecurityState TargetedScan
============================================================================
0     MyNetwork disabled           disconnected    psk           False
----- -------- ------------------ --------------- ------------- ------------

wifi enable

在附加设备上启用 Wi-Fi 网络。

如果两个网络都在范围内，要从一个网络更改为另一个网络，请在启用新网络之前禁用当前连接的网络。

必需的参数

参数	类型	描述
-i、--id	Integer	指定要启用的网络的 ID。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device wifi enable --id 0
Successfully enabled network:
 ----- -------- ------------------ --------------- ------------- ------------
 ID    SSID     ConfigurationState ConnectionState SecurityState TargetedScan
 ============================================================================
 0     MyNetwork enabled            disconnected    psk           False
 ----- -------- ------------------ --------------- ------------- ------------

wifi forget

从附加设备中删除 Wi-Fi 网络的详细信息。

必需的参数

参数	类型	描述
-i、--id	Integer	指定要删除的网络的 ID。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device wifi forget --id 0
Successfully forgotten network.

wifi list

列出附加设备的当前 Wi-Fi 配置。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device wifi list
 ----- --------- ------------------ --------------- ------------- ------------
 ID    SSID      ConfigurationState ConnectionState SecurityState TargetedScan
 =============================================================================
 0     MyNetwork1 enabled            connected       psk           False
 ----- ---------  ------------------ --------------- ------------- ------------
 1     MyNetwork2 enabled            disconnected    psk           False
 ----- ---------  ------------------ --------------- ------------- ------------
 2     MyNetwork3 enabled            disconnected    eaptls        False
 ----- ---------  ------------------ --------------- ------------- ------------

wifi reload-config

重新加载附加设备上的 Wi-Fi 网络配置。在添加或删除证书（azsphere device certificate）后使用此命令，以确保 EAP-TLS 网络使用证书存储的最新内容。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device wifi reload-config
Wi-Fi configuration was successfully reloaded.

wifi scan

扫描对附加设备可见的可用 Wi-Fi 网络。该命令最多返回 64 个 Wi-Fi 网络，但显示的 Wi-Fi 网络数可能受环境因素的限制，例如范围内的接入点密度。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device wifi scan
----------------- ------------- ----------------- ----------- ---------
SSID              SecurityState BSSID             SignalLevel Frequency
=======================================================================
MyNetwork0        psk           <value>           -66         2442
----------------- ------------- ----------------- ----------- ---------
MyNetwork1        psk           <value>           -75         2442
----------------- ------------- ----------------- ----------- ---------
MyNetwork2        psk           <value>           -86         2412
----------------- ------------- ----------------- ----------- ---------

wifi show

显示附加设备上的 Wi-Fi 网络的详细信息。

必需的参数

参数	类型	描述
-i、--id	Integer	指定要显示的网络配置的 ID。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

azsphere device wifi show --id 0
 ----- --------- ------------------ --------------- ------------- ------------
 ID    SSID      ConfigurationState ConnectionState SecurityState TargetedScan
 =============================================================================
 0     MyNetwork enabled            disconnected    psk           False
 ----- --------- ------------------ --------------- ------------- ------------

wifi show-status

显示附加设备上的 Wi-Fi 接口的状态。

可选参数

参数	类型	描述
-d、--device	字符串	指定要在附加多个设备时运行命令的设备。附加多个设备时，此参数是必需的。当前附加的设备默认使用。可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。因此，Windows 不支持此参数，但不支持 Linux。如果将此参数用于 Linux 上的命令，将返回错误。

全局参数

以下全局参数可用于 Azure Sphere CLI：

参数	说明
--debug	增加日志记录详细程度以显示所有调试日志。如果发现了 bug，在提交 bug 报告时，请提供启用 `--debug` 标志生成的输出。
-h、--help	打印有关命令及其参数的 CLI 参考信息，并列出可用的子组和命令。
--only-show-errors	仅显示错误，禁止显示警告。
-o、--output	更改输出格式。可用的输出格式为 json、jsonc（彩色 JSON）、tsv（制表分隔值）、表（人可读 ASCII 表）和 yaml。默认情况下，CLI 输出 `table`。若要详细了解可用的输出格式，请参阅 Azure Sphere CLI 命令的输出格式。
--query	使用 JMESPath 查询语言筛选从 Azure Sphere 安全服务返回的输出。有关详细信息和示例，请参阅 JMESPath 教程和查询 Azure CLI 命令输出。
--verbose	打印有关在操作期间在 Azure Sphere 中创建的资源的信息和其他有用信息。使用 `--debug` 获取完整的调试日志。

注意

如果使用 Azure Sphere 经典 CLI，请参阅全局参数，了解有关可用选项的详细信息。

示例

 azsphere device wifi show-status
 ----- ------------------ --------------- ------------- --------- ------- ------------- --------- ------------- -----------------
 SSID  ConfigurationState ConnectionState SecurityState Frequency Mode    KeyManagement WpaState  IpAddress     MacAddress
 ================================================================================================================================
<value> enabled            connected       psk           2412      station WPA2-PSK      COMPLETED <value>      <value>
 ----- ------------------ --------------- ------------- --------- ------- ------------- --------- ------------- -----------------