通过

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

Modules - Create Or Update Identity

  • 参考
服务:
IoT Hub
API 版本:
2021-04-12

创建或更新IoT 中心中的设备的模块标识。 用户无法更新 moduleId 和 generationId。

PUT https://fully-qualified-iothubname.azure-devices.net/devices/{id}/modules/{mid}?api-version=2021-04-12

URI 参数

名称 在 必需 类型 说明
id
 path True

string

设备的唯一标识符。
mid
 path True

string

模块的唯一标识符。
api-version
 query True

string

Api 的版本。

请求头

名称 必需 类型 说明
If-Match

string

表示模块的弱 ETag 的字符串，根据 RFC7232。 创建模块时不应设置此值，但可以在更新模块时设置。

请求正文

名称 类型 说明
authentication

AuthenticationMechanism

模块在连接到服务和边缘中心时使用的身份验证机制。
cloudToDeviceMessageCount

integer

当前排队等待发送到模块的云到模块消息的数量。
connectionState enum:
  • Disconnected
  • Connected

设备的连接状态。
connectionStateUpdatedTime

string

上次更新连接状态的日期和时间。
deviceId

string

设备的唯一标识符。
etag

string

表示模块标识的弱 ETag 的字符串，根据 RFC7232。
generationId

string

IoT 中心生成的、区分大小写的字符串，长度最大为 128 个字符。 此值用于在删除并重新创建模块时区分具有相同 moduleId 的模块。
lastActivityTime

string

设备上次连接、接收或发送消息的日期和时间。
managedBy

string

标识管理此模块的人。 例如，如果 Edge 运行时拥有此模块，则此值为“IotEdge”。
moduleId

string

模块的唯一标识符。

响应

名称 类型 说明
200 OK

Module

没问题。
201 Created

Module

Created.

定义

名称 说明
AuthenticationMechanism
Module

设备上的模块标识。
SymmetricKey
X509Thumbprint

AuthenticationMechanism

名称 类型 说明
symmetricKey

SymmetricKey

用于基于 SAS 的身份验证的主密钥和辅助密钥。
type enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

用于连接到服务的身份验证类型。
x509Thumbprint

X509Thumbprint

用于基于 x509 的身份验证的主要和辅助 x509 指纹。

Module

设备上的模块标识。

名称 类型 说明
authentication

AuthenticationMechanism

模块在连接到服务和边缘中心时使用的身份验证机制。
cloudToDeviceMessageCount

integer

当前排队等待发送到模块的云到模块消息的数量。
connectionState enum:
  • Connected
  • Disconnected

设备的连接状态。
connectionStateUpdatedTime

string

上次更新连接状态的日期和时间。
deviceId

string

设备的唯一标识符。
etag

string

表示模块标识的弱 ETag 的字符串，根据 RFC7232。
generationId

string

IoT 中心生成的、区分大小写的字符串，长度最大为 128 个字符。 此值用于在删除并重新创建模块时区分具有相同 moduleId 的模块。
lastActivityTime

string

设备上次连接、接收或发送消息的日期和时间。
managedBy

string

标识管理此模块的人。 例如，如果 Edge 运行时拥有此模块，则此值为“IotEdge”。
moduleId

string

模块的唯一标识符。

SymmetricKey

名称 类型 说明
primaryKey

string

设备的 base64 编码主键。
secondaryKey

string

设备的 base64 编码辅助密钥。

X509Thumbprint

名称 类型 说明
primaryThumbprint

string

X509 客户端证书主指纹。
secondaryThumbprint

string

X509 客户端证书辅助指纹。