tenant
重要
这是 Azure Sphere（旧版）文档。 Azure Sphere（旧版）将于 2027 年 9 月 27 日停用，用户此时必须迁移到 Azure Sphere（集成）。 使用位于 TOC 上方的版本选择器查看 Azure Sphere（集成）文档。
管理 Azure Sphere 租户。
重要
命令azsphere tenant download-ca-certificateazsphere tenant download-ca-certificate-chain和azsphere tenant download-validation-certificate已过时。 请改为使用 azsphere ca-certificate download、azsphere ca-certificate download-chain、azsphere ca-certificate download-proof 和 azsphere ca-certificate list。
在 Azure Sphere CLI 中，创建租户时不会自动选择默认租户。 必须运行 azsphere tenant select 命令，以选择要用于电脑上当前用户的默认租户。 这是为了确保默认租户是执行一次性操作时使用的正确租户，例如 声明设备。
| 操作 | 说明 |
|---|---|
| create | 创建新租户。 |
| download-error-report | 返回当前租户中的设备的错误信息。 |
| list | 列出可用的 Azure Sphere 租户。 |
| select | 选择要在此计算机上使用的默认 Azure Sphere 租户。 |
| show-selected | 显示此计算机的默认 Azure Sphere 租户。 |
| update | 更新租户的详细信息，例如租户的名称。 |
create
创建新的 Azure Sphere 租户。 需要附加设备才能运行此命令。 有关详细信息，请参阅 “创建 Azure Sphere 租户”。
如果已有一个租户，并确定还需要另一个租户，请使用 --force-additional 参数。 目前无法删除 Azure Sphere 租户。
创建租户后，运行 azsphere tenant 选择 用于此电脑上当前用户的默认租户。 可以使用 azsphere role add 命令为当前 Azure Sphere 租户中的用户添加角色。
azsphere tenant create 命令适用于本地连接的 Azure Sphere 设备。 如果在未连接设备的情况下尝该试命令，则会收到错误。 设备 ID 是在创建租户时记录的，并且只能为每个设备创建一个租户。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -n、--name | 字符串 | 指定租户名称。 对租户进行命名时，请使用字母数字字符。 不允许使用特殊字符。 名称不得超过 50 个字符，区分大小写。 |
可选参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -d、--device | 字符串 | 指定要在附加多个设备时运行命令的设备。 附加多个设备时，此参数是必需的。 当前附加的设备默认使用。 可以指定附加设备的设备 ID、IP 地址或本地连接 ID。 Azure Sphere CLI 支持 Windows 上的多个 MT3620 设备，但一次只能在 Linux 上连接一台设备。 因此，Windows 不支持此参数，但不支持 Linux。 如果将此参数用于 Linux 上的命令，将返回错误。 |
| --force-additional | 布尔 | 强制创建新的 Azure Sphere 租户。 仅当确定要使用当前帐户使用附加设备创建新的 Azure Sphere 租户时，才使用此命令。 |
| --disable-confirm-prompt | 布尔 | 禁用用户确认提示。 |
全局参数
以下全局参数可用于 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 tenant create --name MyTenant
--force-additional如果确定要使用此帐户来使用附加设备创建新的 Azure Sphere 租户，请使用此参数--disable-confirm-prompt。 以前用于创建 Azure Sphere 租户的设备不能用于创建新租户。
azsphere tenant create --name MyTenant --force-additional
You have logged in with the following account:
bob@contoso.com
Do you want to use this account to create a new Azure Sphere tenant using the attached device?
You cannot change the tenant name 'MyTenant1' once it has been created.
Enter 'yes' to continue. Enter anything else to exit.
yes
> verbose: TraceId: c761ba73-761e-4df2-94f5-3f87384d71b7
Created a new Azure Sphere tenant:
--> Tenant Name: MyTenant1
--> Tenant ID: 768c2cd6-059a-49ad-9f53-89f5271cea15
Please use 'azsphere tenant select --tenant MyTenant' to select the created tenant.
提示
创建租户后，请确保运行 azsphere 租户以 选择要用于此电脑上当前用户的默认租户。
download-error-report
返回有关当前租户中的设备所报告的错误的信息。
此命令从 Azure Sphere 安全服务云中提取事件数据，无需与特定设备建立物理连接。 azsphere tenant download-error-report 命令在当前租户的上下文中运行，并返回该租户中所有设备的错误报告。
注意
最近报告的事件可能需要长达 24 小时才能下载。 有关详细信息，请参阅 “收集和解释错误数据”。
可选参数
| 参数 | 类型 | 描述 |
|---|---|---|
| --目的地 | 字符串 | 指定输出文件的路径和文件名。 |
| -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 tenant download-error-report --destination c:\error-report.csv --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
列表
列出 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 tenant list
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant Administrator
Contributor
------------------------------------ --------------------- -------------
SELECT…
选择要用于此电脑上当前用户的默认 Azure Sphere 租户。
若要显示当前的默认租户，请使用 azsphere tenant show-selected。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -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 tenant select --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant Administrator
Contributor
------------------------------------ --------------------- -------------
show-selected
显示此电脑上当前用户的默认 Azure Sphere 租户的详细信息。
这是使用 azsphere tenant select 命令选择的租户。
全局参数
以下全局参数可用于 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 tenant show-selected
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant Administrator
Contributor
------------------------------------ --------------------- -------------
update
更新租户的详细信息，例如租户的名称。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -n、--new-name | 字符串 | 指定租户的新名称。 对租户进行命名时，请使用字母数字字符。 不允许使用特殊字符。 名称不得超过 50 个字符，区分大小写。 |
可选参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -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 tenant update --tenant a323c263-2aa3-2559-aabb-a3fc32631900 --new-name Tenant2
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
a323c263-2aa3-2559-aabb-a3fc32631900 Tenant2 Administrator
Contributor
------------------------------------ --------------------- -------------
提示
如果未选择默认租户，则会显示可用租户的列表。 通过选择其中一个选项来设置默认租户。