az iot hub module-identity

命令

名称	说明	类型	Status
az iot hub module-identity connection-string	管理 IoT 设备模块的连接字符串。	Extension	GA
az iot hub module-identity connection-string show	显示目标 IoT 设备模块连接字符串。	Extension	GA
az iot hub module-identity create	在 IoT 中心的目标 IoT 设备上创建模块。	Extension	GA
az iot hub module-identity delete	删除IoT 中心中的设备。	Extension	GA
az iot hub module-identity list	列出位于 IoT 中心 中的 IoT 设备上的模块。	Extension	GA
az iot hub module-identity renew-key	使用 sas 身份验证续订IoT 中心设备模块的目标密钥。	Extension	GA
az iot hub module-identity show	获取 IoT 中心 IoT 设备模块的详细信息。	Extension	GA
az iot hub module-identity update	更新IoT 中心设备模块。	Extension	GA

az iot hub module-identity create --device-id
                                  --module-id
                                  [--am --auth-method {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--hub-name]
                                  [--login]
                                  [--od --output-dir]
                                  [--pk --primary-key]
                                  [--primary-thumbprint --ptp]
                                  [--resource-group]
                                  [--secondary-key --sk]
                                  [--secondary-thumbprint --stp]
                                  [--valid-days --vd]

必需参数

可选参数

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

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性	值
默认值:	False

--output -o

输出格式。

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

--query

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

--subscription

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

--verbose

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

属性	值
默认值:	False

az iot hub module-identity delete --device-id
                                  --module-id
                                  [--auth-type {key, login}]
                                  [--etag]
                                  [--hub-name]
                                  [--login]
                                  [--resource-group]

必需参数

可选参数

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

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性	值
默认值:	False

--output -o

输出格式。

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

--query

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

--subscription

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

--verbose

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

属性	值
默认值:	False

az iot hub module-identity list --device-id
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--resource-group]
                                [--top]

必需参数

可选参数

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

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性	值
默认值:	False

--output -o

输出格式。

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

--query

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

--subscription

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

--verbose

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

属性	值
默认值:	False

az iot hub module-identity renew-key --device-id
                                     --hub-name
                                     --key-type --kt {both, primary, secondary, swap}
                                     --module-id
                                     [--auth-type {key, login}]
                                     [--etag]
                                     [--login]
                                     [--no-progress {false, true}]
                                     [--resource-group]

示例

续订主密钥。

az iot hub module-identity renew-key -m {module_name} -d {device_id} -n {iothub_name} --kt primary

交换主密钥和辅助密钥。

az iot hub module-identity renew-key -m {module_name} -d {device_id} -n {iothub_name} --kt swap

续订两个模块的辅助密钥。

az iot hub module-identity renew-key -m {module_name} {module_name} -d {device_id} -n {iothub_name} --kt secondary

为设备中的所有模块续订这两个密钥。

az iot hub module-identity renew-key -m * -d {device_id} -n {iothub_name} --kt both

必需参数

可选参数

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

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性	值
默认值:	False

--output -o

输出格式。

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

--query

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

--subscription

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

--verbose

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

属性	值
默认值:	False

az iot hub module-identity show --device-id
                                --module-id
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--resource-group]

必需参数

可选参数

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

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性	值
默认值:	False

--output -o

输出格式。

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

--query

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

--subscription

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

--verbose

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

属性	值
默认值:	False

az iot hub module-identity update --device-id
                                  --module-id
                                  [--add]
                                  [--auth-type {key, login}]
                                  [--etag]
                                  [--force-string]
                                  [--hub-name]
                                  [--login]
                                  [--remove]
                                  [--resource-group]
                                  [--set]

示例

重新生成模块对称身份验证密钥

az iot hub module-identity update -m {module_name} -d {device_id} -n {iothub_name} --set authentication.symmetricKey.primaryKey="" authentication.symmetricKey.secondaryKey=""

必需参数

可选参数

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

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性	值
默认值:	False

--output -o

输出格式。

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

--query

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

--subscription

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

--verbose

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

属性	值
默认值:	False