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

az iot hub device-identity

Note

此参考是 Azure CLI（版本 2.59.0 或更高版本）的 azure-iot 扩展的一部分。该扩展会在首次运行 az iot hub device-identity 命令时自动安装。了解更多关于扩展的信息。

管理 IoT 设备。

命令

名称	说明	类型	Status
az iot hub device-identity children	管理 IoT 边缘设备的子设备关系。	Extension	GA
az iot hub device-identity children add	将设备作为子级添加到目标边缘设备。	Extension	GA
az iot hub device-identity children list	输出分配的子设备的集合。	Extension	GA
az iot hub device-identity children remove	从目标边缘设备中删除子设备。	Extension	GA
az iot hub device-identity connection-string	管理 IoT 设备的连接字符串。	Extension	GA
az iot hub device-identity connection-string show	显示给定IoT 中心设备连接字符串。	Extension	GA
az iot hub device-identity create	在 IoT 中心创建设备。	Extension	GA
az iot hub device-identity delete	删除 IoT 中心设备。	Extension	GA
az iot hub device-identity export	将所有设备标识从IoT 中心导出到Azure 存储 blob 容器。	Extension	GA
az iot hub device-identity import	将设备标识从存储容器 blob 导入到IoT 中心。	Extension	GA
az iot hub device-identity list	列出IoT 中心中的设备。	Extension	GA
az iot hub device-identity parent	管理 IoT 设备的父设备关系。	Extension	GA
az iot hub device-identity parent set	设置目标设备的父设备。	Extension	GA
az iot hub device-identity parent show	获取目标设备的父设备。	Extension	GA
az iot hub device-identity renew-key	使用 sas 身份验证续订IoT 中心设备的目标密钥。	Extension	GA
az iot hub device-identity show	获取 IoT 中心设备的详细信息。	Extension	GA
az iot hub device-identity update	更新 IoT 中心设备。	Extension	GA

az iot hub device-identity create

在 IoT 中心创建设备。

使用 shared_private_key（也称为对称密钥）的身份验证方法时，如果未提供任何自定义密钥，则服务将为设备生成它们。

如果为边缘设备提供了设备范围，该值将自动转换为父范围。

az iot hub device-identity create --device-id
                                  [--am --auth-method {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--device-scope]
                                  [--edge-enabled --ee {false, true}]
                                  [--hub-name]
                                  [--login]
                                  [--od --output-dir]
                                  [--pk --primary-key]
                                  [--primary-thumbprint --ptp]
                                  [--resource-group]
                                  [--secondary-key --sk]
                                  [--secondary-thumbprint --stp]
                                  [--sta --status {disabled, enabled}]
                                  [--star --status-reason]
                                  [--valid-days --vd]

示例

使用默认授权创建启用了边缘的 IoT 设备（共享私钥）。

az iot hub device-identity create -n {iothub_name} -d {device_id} --ee

创建具有自签名证书授权的 IoT 设备，生成有效期为 10 天的证书，然后使用其指纹。

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --valid-days 10

创建具有自签名证书授权的 IoT 设备，生成默认过期（365 天）的证书，并将输出输出到目标目录。

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --output-dir /path/to/output

创建具有自签名证书授权的 IoT 设备，并显式提供主指纹和辅助指纹。

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --ptp {thumbprint_1} --stp {thumbprint_2}

创建具有禁用状态和原因的根 CA 授权的 IoT 设备。

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_ca --status disabled --status-reason 'for reasons'

创建具有设备范围的 IoT 设备。

az iot hub device-identity create -n {iothub_name} -d {device_id} --device-scope 'ms-azure-iot-edge://edge0-123456789123456789'

必需参数

--device-id -d

目标设备 ID。

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--am --auth-method

要创建实体的授权方法。

属性	值
默认值:	shared_private_key
接受的值:	shared_private_key, x509_ca, x509_thumbprint

--auth-type

指示操作是应自动派生策略密钥还是使用当前的 Azure AD 会话。如果身份验证类型为登录，并且提供资源主机名，则除非需要，否则将跳过资源查找。可以使用 < a0/a0> 配置默认值 az configure --defaults iothub-data-auth-type={auth-type-value}。

属性	值
Parameter group:	Access Control Arguments
默认值:	key
接受的值:	key, login

--device-scope

设备的范围。对于边缘设备，这是自动生成的且不可变。对于叶设备，请将此设置设置为创建子/父关系。

属性	值
Parameter group:	Device Scope Arguments

--edge-enabled --ee

指示边缘启用的标志。

属性	值
默认值:	False
接受的值:	false, true

--hub-name -n

IoT 中心名称或主机名。如果未提供 --login，则为必需。

属性	值
Parameter group:	IoT Hub Identifier Arguments

--login -l

此命令支持具有执行操作权限的实体连接字符串。用于避免通过“az login”进行会话登录。如果同时提供实体连接字符串和名称，则连接字符串优先。如果未提供 --hub-name，则为必需。

属性	值
Parameter group:	IoT Hub Identifier Arguments

--od --output-dir

生成自签名证书并使用其指纹。输出到指定的目标目录。

属性	值
Parameter group:	X.509 Arguments

--pk --primary-key

以 base64 格式存储的主对称共享访问密钥。

属性	值
Parameter group:	Symmetric Key Arguments

--primary-thumbprint --ptp

用于主指纹的自签名证书指纹。

属性	值
Parameter group:	X.509 Arguments

--resource-group -g

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

--secondary-key --sk

以 base64 格式存储的辅助对称共享访问密钥。

属性	值
Parameter group:	Symmetric Key Arguments

--secondary-thumbprint --stp

用于辅助指纹的自签名证书指纹。

属性	值
Parameter group:	X.509 Arguments

--sta --status

创建时设置设备状态。

属性	值
默认值:	enabled
接受的值:	disabled, enabled

--star --status-reason

设备状态的说明。

--valid-days --vd

生成自签名证书并使用其指纹。有效期为指定的天数。默认值：365。

属性	值
Parameter group:	X.509 Arguments

全局参数

--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 device-identity delete

删除 IoT 中心设备。

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

必需参数

--device-id -d

目标设备 ID。

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--auth-type

属性	值
Parameter group:	Access Control Arguments
默认值:	key
接受的值:	key, login

--etag -e

对应于资源最后状态的 Etag 或实体标记。如果未提供 etag，则使用值“*”。

--hub-name -n

IoT 中心名称或主机名。如果未提供 --login，则为必需。

属性	值
Parameter group:	IoT Hub Identifier Arguments

--login -l

属性	值
Parameter group:	IoT Hub Identifier Arguments

--resource-group -g

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

全局参数

--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 device-identity export

将所有设备标识从IoT 中心导出到Azure 存储 blob 容器。

包含设备标识的输出 blob 是名为“devices.txt”的文本文件。

所需的权限 - IoT 中心支持“注册表读取和注册表写入”的共享访问策略，或者IoT 中心上具有“IoT 中心数据参与者”角色的主体。

仅当存储帐户与输入IoT 中心位于同一订阅中时，才能使用存储帐户名称和 blob 容器名称参数。有关内联 Blob 容器 SAS URI 输入，请查看环境的输入规则。

有关详细信息，请参阅 https://aka.ms/iothub-device-exportimport。

az iot hub device-identity export [--auth-type {key, login}]
                                  [--bc --blob-container]
                                  [--bcu --blob-container-uri]
                                  [--hub-name]
                                  [--identity]
                                  [--ik --include-keys {false, true}]
                                  [--login]
                                  [--resource-group]
                                  [--sa --storage-account]

示例

将所有设备标识导出到配置的 Blob 容器，并包括设备密钥。 Blob 容器名称和存储帐户名称作为命令的参数提供。

az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name}

将所有设备标识导出到配置的 Blob 容器，并包括设备密钥。使用内联 SAS URI 示例。

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices?sv=2019-02-02&st=2020-08-23T22%3A35%3A00Z&se=2020-08-24T22%3A35%3A00Z&sr=c&sp=rwd&sig=VrmJ5sQtW3kLzYg10VqmALGCp4vtYKSLNjZDDJBSh9s%3D'

使用包含 SAS URI 的文件路径将所有设备标识导出到配置的 Blob 容器。

az iot hub device-identity export -n {iothub_name} --bcu {sas_uri_filepath}

将所有设备标识导出到配置的 Blob 容器，并包括设备密钥。使用具有存储帐户的存储 Blob 数据参与者角色的系统分配标识。 Blob 容器名称和存储帐户名称作为命令的参数提供。

az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name} --identity [system]

将所有设备标识导出到配置的 Blob 容器，并包括设备密钥。使用具有存储帐户的存储 Blob 数据参与者角色的系统分配标识。 Blob 容器 URI 不需要 Blob SAS 令牌。

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices' --identity [system]

将所有设备标识导出到配置的 Blob 容器，并包括设备密钥。使用具有存储帐户存储 Blob 数据参与者角色的用户分配的托管标识。 Blob 容器名称和存储帐户名称作为命令的参数提供。

az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name} --identity {managed_identity_resource_id}

将所有设备标识导出到配置的 Blob 容器，并包括设备密钥。使用具有存储帐户存储 Blob 数据参与者角色的用户分配的托管标识。 Blob 容器 URI 不需要 Blob SAS 令牌。

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices' --identity {managed_identity_resource_id}

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--auth-type

属性	值
Parameter group:	Access Control Arguments
默认值:	key
接受的值:	key, login

--bc --blob-container

此 Blob 容器用于输出设备标识导入作业的状态和结果。提供blob_container_uri时，将忽略参数。此 Blob 容器需要写入、读取和删除访问权限。

--bcu --blob-container-uri

具有对 Blob 容器的写入、读取和删除访问权限的 Blob 共享访问签名 URI。这用于输出作业的状态和结果。注意：使用基于标识的身份验证时，仍需要 https:// URI ，但不需要 SAS 令牌。此参数的输入可以是内联输入，也可以来自文件路径。

--hub-name -n

IoT 中心名称或主机名。如果未提供 --login，则为必需。

属性	值
Parameter group:	IoT Hub Identifier Arguments

--identity

托管标识类型，用于确定是否使用系统分配的托管标识或用户分配的托管标识。对于系统分配的托管标识，请使用 [system]。对于用户分配的托管标识，请提供用户分配的托管标识资源 ID。此标识需要存储帐户的存储 Blob 数据参与者角色。

--ik --include-keys

如果已设置，则正常导出密钥。否则，导出输出中的键设置为 null。

属性	值
默认值:	False
接受的值:	false, true

--login -l

属性	值
Parameter group:	IoT Hub Identifier Arguments

--resource-group -g

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

--sa --storage-account

包含输出 Blob 容器的 Azure 存储帐户的名称。提供blob_container_uri时，将忽略参数。需要写入、读取和删除访问权限。

全局参数

--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 device-identity import

将设备标识从存储容器 blob 导入到IoT 中心。

包含设备标识的预期输入文件应命名为“devices.txt”。导入成功时输出日志文件“importErrors.log”为空，在导入失败时包含错误日志。

所需的权限 - IoT 中心支持“注册表读取和注册表写入”的共享访问策略，或者IoT 中心上具有“IoT 中心数据参与者”角色的主体。

仅当存储帐户与输入IoT 中心位于同一订阅中时，才能使用存储帐户名称和 blob 容器名称参数。有关内联 Blob 容器 SAS URI 输入，请查看环境的输入规则。

有关详细信息，请参阅 https://aka.ms/iothub-device-exportimport。

az iot hub device-identity import [--auth-type {key, login}]
                                  [--hub-name]
                                  [--ibc --input-blob-container]
                                  [--ibcu --input-blob-container-uri]
                                  [--identity]
                                  [--input-storage-account --isa]
                                  [--login]
                                  [--obc --output-blob-container]
                                  [--obcu --output-blob-container-uri]
                                  [--osa --output-storage-account]
                                  [--resource-group]

示例

通过为输入 Blob 容器和存储帐户以及输出 Blob 容器和存储帐户提供命令参数，从 Blob 导入所有设备标识。

az iot hub device-identity import -n {iothub_name} --ibc {input_blob_container_name} --isa {input_storage_account_name} --obc {output_blob_container_name} --osa {output_storage_account_name}

使用内联 SAS URI 从 Blob 导入所有设备标识。

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri}

使用包含 SAS URI 的文件路径从 Blob 导入所有设备标识。

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri_filepath} --obcu {output_sas_uri_filepath}

使用系统分配的标识从 Blob 导入所有设备标识，该标识具有这两个存储帐户的存储 Blob 数据参与者角色。输入 Blob 容器和存储帐户以及输出 Blob 容器和存储帐户作为命令的参数提供

az iot hub device-identity import -n {iothub_name} --ibc {input_blob_container_name} --isa {input_storage_account_name} --obc {output_blob_container_name} --osa {output_storage_account_name} --identity [system]

使用系统分配的标识从 Blob 导入所有设备标识，该标识具有这两个存储帐户的存储 Blob 数据参与者角色。 Blob 容器 URI 不需要 Blob SAS 令牌。

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri} --identity [system]

使用为这两个存储帐户具有存储 Blob 数据参与者角色的用户分配的托管标识从 Blob 导入所有设备标识。输入 Blob 容器和存储帐户以及输出 Blob 容器和存储帐户作为命令的参数提供

az iot hub device-identity import -n {iothub_name} --ibc {input_blob_container_name} --isa {input_storage_account_name} --obc {output_blob_container_name} --osa {output_storage_account_name} --identity {managed_identity_resource_id}

使用为这两个存储帐户具有存储 Blob 数据参与者角色的用户分配的托管标识从 Blob 导入所有设备标识。 Blob 容器 URI 不需要 Blob SAS 令牌。

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri} --identity {managed_identity_resource_id}

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--auth-type

属性	值
Parameter group:	Access Control Arguments
默认值:	key
接受的值:	key, login

--hub-name -n

IoT 中心名称或主机名。如果未提供 --login，则为必需。

属性	值
Parameter group:	IoT Hub Identifier Arguments

--ibc --input-blob-container

此 Blob 容器存储用于定义要在标识注册表上执行的作的文件。提供input_blob_container_uri时，将忽略参数。此 Blob 容器需要读取访问权限。

--ibcu --input-blob-container-uri

对 Blob 容器具有读取访问权限的 Blob 共享访问签名 URI。此 Blob 包含要对标识注册表执行的作。注意：使用基于标识的身份验证时，仍需要 https:// URI ，但不需要 SAS 令牌。此参数的输入可以是内联输入，也可以来自文件路径。

--identity

托管标识类型，用于确定是否使用系统分配的托管标识或用户分配的托管标识。对于系统分配的托管标识，请使用 [system]。对于用户分配的托管标识，请提供用户分配的托管标识资源 ID。此标识需要 IoT 中心的目标存储帐户和参与者角色的存储 Blob 数据参与者角色。

--input-storage-account --isa

包含输入 Blob 容器的 Azure 存储帐户的名称。仅当未提供input_blob_container_uri时才是必需的。需要读取访问权限。

--login -l

属性	值
Parameter group:	IoT Hub Identifier Arguments

--obc --output-blob-container

此 Blob 容器用于输出设备标识导入作业的状态和结果。仅当未提供input_blob_container_uri时才是必需的。此 Blob 容器需要写入访问权限。

--obcu --output-blob-container-uri

具有 Blob 容器写入访问权限的 Blob 共享访问签名 URI。这用于输出作业的状态和结果。注意：使用基于标识的身份验证时，仍需要没有 SAS 令牌的 https:// URI。此参数的输入可以是内联输入，也可以来自文件路径。

--osa --output-storage-account

包含输出 Blob 容器的 Azure 存储帐户的名称。提供output_blob_container_uri时，将忽略参数。需要写入访问权限。

--resource-group -g

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

全局参数

--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 device-identity list

列出IoT 中心中的设备。

此命令是一个别名 az iot hub device-twin list，强烈建议使用此命令。将来，可能会更改或弃用此命令 az iot hub device-identity list 。

az iot hub device-identity list [--auth-type {key, login}]
                                [--edge-enabled --ee {false, true}]
                                [--hub-name]
                                [--login]
                                [--resource-group]
                                [--top]

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--auth-type

属性	值
Parameter group:	Access Control Arguments
默认值:	key
接受的值:	key, login

--edge-enabled --ee

指示边缘启用的标志。

属性	值
默认值:	False
接受的值:	false, true

--hub-name -n

IoT 中心名称或主机名。如果未提供 --login，则为必需。

属性	值
Parameter group:	IoT Hub Identifier Arguments

--login -l

属性	值
Parameter group:	IoT Hub Identifier Arguments

--resource-group -g

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

--top

要返回的最大元素数。将 -1 用于无限制。

属性	值
默认值:	1000

全局参数

--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 device-identity renew-key

使用 sas 身份验证续订IoT 中心设备的目标密钥。

目前，大容量密钥重新生成不支持 etag 和密钥类型 swap 。大容量密钥重新生成将生成与单个设备密钥重新生成不同的输出格式。

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

示例

续订主密钥。

az iot hub device-identity renew-key -d {device_id} -n {iothub_name} --kt primary

交换主密钥和辅助密钥。

az iot hub device-identity renew-key -d {device_id} -n {iothub_name} --kt swap

续订两台设备及其模块的辅助密钥。

az iot hub device-identity renew-key -d {device_id} {device_id} -n {iothub_name} --kt secondary --include-modules

为中心内的所有设备续订这两个密钥。

az iot hub device-identity renew-key -d * -n {iothub_name} --kt both

必需参数

--device-id -d

目标设备 ID 的空间分隔列表。对所有设备使用 *。

--hub-name -n

IoT 中心名称或主机名。如果未提供 --login，则为必需。

属性	值
Parameter group:	IoT Hub Identifier Arguments

--key-type --kt

要重新生成的目标密钥类型。

属性	值
接受的值:	both, primary, secondary, swap

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--auth-type

属性	值
Parameter group:	Access Control Arguments
默认值:	key
接受的值:	key, login

--etag -e

对应于资源最后状态的 Etag 或实体标记。如果未提供 etag，则使用值“*”。此参数仅适用于 swap。

--im --include-modules

在密钥重新生成期间包含设备模块的标志。

属性	值
默认值:	False
接受的值:	false, true

--login -l

属性	值
Parameter group:	IoT Hub Identifier Arguments

--no-progress

隐藏批量密钥重新生成进度栏。

属性	值
默认值:	False
接受的值:	false, true

--resource-group -g

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

全局参数

--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 device-identity show

获取 IoT 中心设备的详细信息。

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

必需参数

--device-id -d

目标设备 ID。

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--auth-type

属性	值
Parameter group:	Access Control Arguments
默认值:	key
接受的值:	key, login

--hub-name -n

IoT 中心名称或主机名。如果未提供 --login，则为必需。

属性	值
Parameter group:	IoT Hub Identifier Arguments

--login -l

属性	值
Parameter group:	IoT Hub Identifier Arguments

--resource-group -g

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

全局参数

--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 device-identity update

更新 IoT 中心设备。

使用 --set 后跟属性分配来更新设备。利用从“iot 中心设备标识显示”返回的参数。

az iot hub device-identity update --device-id
                                  [--add]
                                  [--am --auth-method {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--edge-enabled --ee {false, true}]
                                  [--etag]
                                  [--force-string]
                                  [--hub-name]
                                  [--login]
                                  [--pk --primary-key]
                                  [--primary-thumbprint --ptp]
                                  [--remove]
                                  [--resource-group]
                                  [--secondary-key --sk]
                                  [--secondary-thumbprint --stp]
                                  [--set]
                                  [--sta --status {disabled, enabled}]
                                  [--star --status-reason]

示例

为设备启用边缘功能

az iot hub device-identity update -d {device_id} -n {iothub_name} --set capabilities.iotEdge=true

使用便利参数为设备启用边缘功能。

az iot hub device-identity update -d {device_id} -n {iothub_name} --ee

禁用设备状态

az iot hub device-identity update -d {device_id} -n {iothub_name} --set status=disabled

使用便利参数禁用设备状态。

az iot hub device-identity update -d {device_id} -n {iothub_name} --status disabled

在一个命令中

az iot hub device-identity update -d {device_id} -n {iothub_name} --set status=disabled capabilities.iotEdge=true

必需参数

--device-id -d

目标设备 ID。

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

通过指定路径和键值对将对象添加到对象列表。示例：--add property.listProperty <key=value, string or JSON string>。

属性	值
Parameter group:	Generic Update Arguments
默认值:	[]

--am --auth-method

要创建实体的授权方法。

属性	值
接受的值:	shared_private_key, x509_ca, x509_thumbprint

--auth-type

属性	值
Parameter group:	Access Control Arguments
默认值:	key
接受的值:	key, login

--edge-enabled --ee

指示边缘启用的标志。

属性	值
接受的值:	false, true

--etag -e

对应于资源最后状态的 Etag 或实体标记。如果未提供 etag，则使用值“*”。

--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

属性	值
Parameter group:	Generic Update Arguments
默认值:	False

--hub-name -n

IoT 中心名称或主机名。如果未提供 --login，则为必需。

属性	值
Parameter group:	IoT Hub Identifier Arguments

--login -l

属性	值
Parameter group:	IoT Hub Identifier Arguments

--pk --primary-key

以 base64 格式存储的主对称共享访问密钥。

属性	值
Parameter group:	Symmetric Key Arguments

--primary-thumbprint --ptp

用于主指纹的自签名证书指纹。

属性	值
Parameter group:	X.509 Arguments

--remove

从列表中删除属性或元素。示例： --remove property.list <indexToRemove> OR --remove propertyToRemove.

属性	值
Parameter group:	Generic Update Arguments
默认值:	[]

--resource-group -g

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

--secondary-key --sk

以 base64 格式存储的辅助对称共享访问密钥。

属性	值
Parameter group:	Symmetric Key Arguments

--secondary-thumbprint --stp

用于辅助指纹的自签名证书指纹。

属性	值
Parameter group:	X.509 Arguments

--set

通过指定要设置的属性路径和值来更新对象。示例：--set property1.property2=<value>。

属性	值
Parameter group:	Generic Update Arguments
默认值:	[]

--sta --status

创建时设置设备状态。

属性	值
接受的值:	disabled, enabled

--star --status-reason

设备状态的说明。

全局参数

--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

反馈

此页面是否有帮助？