你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

az iot hub identity

注释

此命令组具有在Azure CLI和至少一个扩展中定义的命令。 安装每个扩展,使其受益于其扩展功能。 了解更多关于扩展的信息。

管理Azure IoT中心的标识。

命令

名称 说明 类型 Status
az iot hub identity assign

将托管标识分配给IoT 中心。

Core GA
az iot hub identity assign (azure-iot 扩展)

将托管标识分配给IoT 中心。

Extension GA
az iot hub identity remove

从IoT 中心中删除托管标识。

Core GA
az iot hub identity remove (azure-iot 扩展)

从IoT 中心中删除托管标识。

Extension GA
az iot hub identity show

显示IoT 中心的标识属性。

Core GA
az iot hub identity show (azure-iot 扩展)

显示IoT 中心的标识属性。

Extension GA

az iot hub identity assign

将托管标识分配给IoT 中心。

az iot hub identity assign [--acquire-policy-token]
                           [--change-reference]
                           [--ids]
                           [--name]
                           [--resource-group]
                           [--role]
                           [--scopes]
                           [--subscription]
                           [--system --system-assigned {false, true}]
                           [--user --user-assigned]

示例

将用户分配的托管标识分配给IoT 中心

az iot hub identity assign --name MyIoTHub --resource-group MyResourceGroup --user-assigned {resourceId1} {resourceId2}

将系统分配的托管标识分配给IoT 中心,并将角色分配给该标识。

az iot hub identity assign --name MyIoTHub --resource-group MyResourceGroup --system-assigned --role "Storage Blob Data Contributor" --scopes {resourceId}

可选参数

以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。

--acquire-policy-token

为此资源操作自动获取Azure Policy令牌。

属性
参数组: Global Policy Arguments
--change-reference

此资源操作的相关更改引用 ID。

属性
参数组: Global Policy Arguments
--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性
参数组: Resource Id Arguments
--name -n

IoT 中心名称。

属性
参数组: Resource Id Arguments
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性
参数组: Resource Id Arguments
--role

要分配给中心系统分配的托管标识的角色。

--scopes

为系统分配的托管标识分配角色(--role)的范围分隔列表。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性
参数组: Resource Id Arguments
--system --system-assigned

将系统分配的托管标识分配给此中心。

属性
接受的值: false, true
--user --user-assigned

将用户分配的托管标识分配给此中心。 接受标识资源 ID 的空间分隔列表。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误,禁止显示警告。

属性
默认值: False
--output -o

输出格式。

属性
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性
默认值: False

az iot hub identity assign (azure-iot 扩展)

将托管标识分配给IoT 中心。

az iot hub identity assign [--acquire-policy-token]
                           [--change-reference]
                           [--ids]
                           [--name]
                           [--resource-group]
                           [--role]
                           [--scopes]
                           [--subscription]
                           [--system --system-assigned {false, true}]
                           [--user --user-assigned]

示例

将用户分配的托管标识分配给IoT 中心

az iot hub identity assign --name MyIoTHub --resource-group MyResourceGroup --user-assigned {resourceId1} {resourceId2}

将系统分配的托管标识分配给IoT 中心,并将角色分配给该标识。

az iot hub identity assign --name MyIoTHub --resource-group MyResourceGroup --system-assigned --role "Storage Blob Data Contributor" --scopes {resourceId}

可选参数

以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。

--acquire-policy-token

为此资源操作自动获取Azure Policy令牌。

属性
参数组: Global Policy Arguments
--change-reference

此资源操作的相关更改引用 ID。

属性
参数组: Global Policy Arguments
--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性
参数组: Resource Id Arguments
--name -n

IoT 中心名称。

属性
参数组: Resource Id Arguments
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性
参数组: Resource Id Arguments
--role

要分配给中心系统分配的托管标识的角色。

--scopes

为系统分配的托管标识分配角色(--role)的范围分隔列表。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性
参数组: Resource Id Arguments
--system --system-assigned

将系统分配的托管标识分配给此中心。

属性
接受的值: false, true
--user --user-assigned

将用户分配的托管标识分配给此中心。 接受标识资源 ID 的空间分隔列表。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误,禁止显示警告。

属性
默认值: False
--output -o

输出格式。

属性
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性
默认值: False

az iot hub identity remove

从IoT 中心中删除托管标识。

az iot hub identity remove [--acquire-policy-token]
                           [--change-reference]
                           [--ids]
                           [--name]
                           [--resource-group]
                           [--subscription]
                           [--system --system-assigned {false, true}]
                           [--user --user-assigned]

示例

从IoT 中心中删除用户分配的托管标识

az iot hub identity remove --name MyIoTHub --resource-group MyResourceGroup --user-assigned {resourceId}

从IoT 中心中删除系统分配的托管标识。

az iot hub identity remove --name MyIoTHub --resource-group MyResourceGroup --system-assigned

从IoT 中心中删除所有标识。

az iot hub identity remove --name MyIoTHub --resource-group MyResourceGroup --system-assigned --user-assigned

可选参数

以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。

--acquire-policy-token

为此资源操作自动获取Azure Policy令牌。

属性
参数组: Global Policy Arguments
--change-reference

此资源操作的相关更改引用 ID。

属性
参数组: Global Policy Arguments
--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性
参数组: Resource Id Arguments
--name -n

IoT 中心名称。

属性
参数组: Resource Id Arguments
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性
参数组: Resource Id Arguments
--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性
参数组: Resource Id Arguments
--system --system-assigned

从此中心删除系统分配的托管标识。

属性
接受的值: false, true
--user --user-assigned

从此中心删除用户分配的托管标识。 接受标识资源 ID 的空间分隔列表。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误,禁止显示警告。

属性
默认值: False
--output -o

输出格式。

属性
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性
默认值: False

az iot hub identity remove (azure-iot 扩展)

从IoT 中心中删除托管标识。

az iot hub identity remove [--acquire-policy-token]
                           [--change-reference]
                           [--ids]
                           [--name]
                           [--resource-group]
                           [--subscription]
                           [--system --system-assigned {false, true}]
                           [--user --user-assigned]

示例

从IoT 中心中删除用户分配的托管标识

az iot hub identity remove --name MyIoTHub --resource-group MyResourceGroup --user-assigned {resourceId}

从IoT 中心中删除系统分配的托管标识。

az iot hub identity remove --name MyIoTHub --resource-group MyResourceGroup --system-assigned

从IoT 中心中删除所有标识。

az iot hub identity remove --name MyIoTHub --resource-group MyResourceGroup --system-assigned --user-assigned

可选参数

以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。

--acquire-policy-token

为此资源操作自动获取Azure Policy令牌。

属性
参数组: Global Policy Arguments
--change-reference

此资源操作的相关更改引用 ID。

属性
参数组: Global Policy Arguments
--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性
参数组: Resource Id Arguments
--name -n

IoT 中心名称。

属性
参数组: Resource Id Arguments
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性
参数组: Resource Id Arguments
--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性
参数组: Resource Id Arguments
--system --system-assigned

从此中心删除系统分配的托管标识。

属性
接受的值: false, true
--user --user-assigned

从此中心删除用户分配的托管标识。 接受标识资源 ID 的空间分隔列表。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误,禁止显示警告。

属性
默认值: False
--output -o

输出格式。

属性
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性
默认值: False

az iot hub identity show

显示IoT 中心的标识属性。

az iot hub identity show [--ids]
                         [--name]
                         [--resource-group]
                         [--subscription]

示例

显示IoT 中心的标识属性

az iot hub identity show --name MyIoTHub --resource-group MyResourceGroup

可选参数

以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。

--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性
参数组: Resource Id Arguments
--name -n

IoT 中心名称。

属性
参数组: Resource Id Arguments
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性
参数组: Resource Id Arguments
--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性
参数组: Resource Id Arguments
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误,禁止显示警告。

属性
默认值: False
--output -o

输出格式。

属性
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性
默认值: False

az iot hub identity show (azure-iot 扩展)

显示IoT 中心的标识属性。

az iot hub identity show [--ids]
                         [--name]
                         [--resource-group]
                         [--subscription]

示例

显示IoT 中心的标识属性

az iot hub identity show --name MyIoTHub --resource-group MyResourceGroup

可选参数

以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。

--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性
参数组: Resource Id Arguments
--name -n

IoT 中心名称。

属性
参数组: Resource Id Arguments
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性
参数组: Resource Id Arguments
--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性
参数组: Resource Id Arguments
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误,禁止显示警告。

属性
默认值: False
--output -o

输出格式。

属性
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性
默认值: False