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

az iot hub policy

管理 IoT 中心的共享访问策略。

命令

名称 说明 类型 Status
az iot hub policy create

在 IoT 中心创建新的共享访问策略。

核心 GA
az iot hub policy delete

从 IoT 中心删除共享访问策略。

核心 GA
az iot hub policy list

列出 IoT 中心的共享访问策略。

核心 GA
az iot hub policy renew-key

重新生成 IoT 中心的共享访问策略的密钥。

核心 GA
az iot hub policy show

获取 IoT 中心的共享访问策略的详细信息。

核心 GA

az iot hub policy create

在 IoT 中心创建新的共享访问策略。

az iot hub policy create --hub-name
                         --name
                         --permissions
                         [--resource-group]

示例

创建新的共享访问策略。

az iot hub policy create --hub-name MyIotHub --name new-policy --permissions RegistryWrite ServiceConnect DeviceConnect

必需参数

--hub-name

IoT 中心名称。

--name -n

共享访问策略名称。

--permissions

共享访问策略的权限。 对多个权限使用空格分隔的列表。 可能的值:RegistryRead、RegistryWrite、Service连接、Device连接。

可选参数

--resource-group -g

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

全局参数
--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

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

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

--subscription

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

--verbose

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

az iot hub policy delete

从 IoT 中心删除共享访问策略。

az iot hub policy delete [--hub-name]
                         [--ids]
                         [--name]
                         [--resource-group]
                         [--subscription]

示例

从 IoT 中心删除共享访问策略。 (自动生成)

az iot hub policy delete --hub-name MyHub --name MySharedAccessPolicy

可选参数

--hub-name

IoT 中心名称。

--ids

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

--name -n

共享访问策略名称。

--resource-group -g

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

--subscription

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

全局参数
--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

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

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

--subscription

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

--verbose

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

az iot hub policy list

列出 IoT 中心的共享访问策略。

az iot hub policy list [--hub-name]
                       [--ids]
                       [--resource-group]
                       [--subscription]

示例

列出 IoT 中心的共享访问策略。 (自动生成)

az iot hub policy list --hub-name MyHub --resource-group MyResourceGroup

可选参数

--hub-name

IoT 中心名称。

--ids

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

--resource-group -g

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

--subscription

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

全局参数
--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

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

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

--subscription

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

--verbose

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

az iot hub policy renew-key

重新生成 IoT 中心的共享访问策略的密钥。

az iot hub policy renew-key --renew-key {primary, secondary, swap}
                            [--hub-name]
                            [--ids]
                            [--name]
                            [--no-wait]
                            [--resource-group]
                            [--subscription]

示例

重新生成 IoT 中心的共享访问策略的主密钥。

az iot hub policy renew-key --hub-name MyHub --name MySharedAccessPolicy --rk Primary

必需参数

--renew-key --rk

重新生成密钥。

接受的值: primary, secondary, swap

可选参数

--hub-name

IoT 中心名称。

--ids

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

--name -n

共享访问策略名称。

--no-wait

不等待长时间运行的操作完成。

默认值: False
--resource-group -g

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

--subscription

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

全局参数
--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

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

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

--subscription

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

--verbose

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

az iot hub policy show

获取 IoT 中心的共享访问策略的详细信息。

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

示例

获取 IoT 中心的共享访问策略的详细信息。 (自动生成)

az iot hub policy show --hub-name MyHub --name MySharedAccessPolicy

可选参数

--hub-name

IoT 中心名称。

--ids

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

--name -n

共享访问策略名称。

--resource-group -g

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

--subscription

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

全局参数
--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

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

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

--subscription

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

--verbose

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