role
重要
这是 Azure Sphere（旧版）文档。 Azure Sphere（旧版）将于 2027 年 9 月 27 日停用，用户此时必须迁移到 Azure Sphere（集成）。 使用位于 TOC 上方的版本选择器查看 Azure Sphere（集成）文档。
在基于角色的访问控制 (RBAC) 的租户中管理用户角色。
| 操作 | description |
|---|---|
| add | 为用户添加角色。 |
| delete | 删除用户角色。 |
| list | 显示用户及其角色的列表。 |
| show | 返回分配给特定用户帐户的角色。 |
| show-types | 显示此租户支持的角色列表。 |
add
将角色添加到用户。
- 管理员对租户中的所有设备和操作具有完全访问权限，包括添加或删除其他用户的权限。 默认情况下，管理员角色分配给创建租户的用户。
- 参与者可以添加设备并创建和更改部署。 如果软件和硬件开发人员创建应用程序、管理连接设备和更新部署，但不负责管理租户访问权限，则应具有参与者角色。
- 读者可以访问有关租户的信息，包括所声明的设备、部署以及报告设备数据的任何错误（如果可用）。 此角色适用于维护和操作人员，他们负责跟踪最终用户安装中连接的设备性能。
注意
此命令将自动将用户的Microsoft帐户注册到 Azure Sphere（如果尚未注册）。 以前， 注册用户 命令用于向 Azure Sphere 注册新用户;将用户添加到现有租户中的新角色时，现在会自动完成此操作，注册用户命令现已弃用。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -u、--user | 字符串 | 指定用户的名称（电子邮件地址）。 |
| -r、--role | 字符串 | 指定要分配给所选用户的角色。 可能的角色包括：管理员、参与者和读者。 |
可选参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -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 role add --user john@contoso.com --role Administrator
delete
从当前或所选 Azure Sphere 租户中的用户中删除角色。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -u、--user | 字符串 | 指定用户的 ID 或电子邮件，以标识要从中删除角色的用户。 |
| -r、--role | Enum | 指定要删除的角色。 可能的角色包括：管理员、参与者和读者。 |
可选参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -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 role delete --user bob@contoso.com --role contributor --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
列表
显示当前或所选租户中的用户角色列表。
该列表将在前 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 role list --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
--------------------- -------------
Name Roles
===================================
bob@contoso.com Administrator
Contributor
--------------------- -------------
显示
显示选定用户的角色信息。
必需的参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -u、--user | 字符串 | 要显示的用户名（电子邮件地址）。 |
可选参数
| 参数 | 类型 | 描述 |
|---|---|---|
| -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 role show --user john@contoso.com --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
-------------
Roles
=============
Administrator
Contributor
-------------
show-types
显示可在此租户中分配的角色。
全局参数
以下全局参数可用于 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 role show-types
-------------
Result
=============
Administrator
-------------
Contributor
-------------
Reader
-------------