Modules - Create Or Update Identity

IoT Hub 内のデバイスのモジュール ID を作成または更新します。 moduleId と generationId をユーザーが更新することはできません。

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

URI パラメーター

名前	必須	型	説明
If-Match		string	RFC7232に従って、モジュールの弱い ETag を表す文字列。これは、モジュールの作成時には設定しないでくださいが、モジュールの更新時に設定できます。

名前	型	説明
authentication	AuthenticationMechanism	サービスとエッジハブに接続するときにモジュールによって使用される認証メカニズム。
cloudToDeviceMessageCount	integer (int32)	モジュールに送信するために現在キューに登録されている、クラウドからモジュールへのメッセージの数。
connectionState	enum: Disconnected Connected	デバイスの接続状態。
connectionStateUpdatedTime	string (date-time)	接続状態が最後に更新された日時。
deviceId	string	デバイスの一意識別子。
etag	string	RFC7232に従って、モジュール ID の弱い ETag を表す文字列。
generationId	string	IoT Hub によって生成された、最大 128 文字の大文字と小文字を区別する文字列。この値は、削除されて再作成されたときに、同じ moduleId を持つモジュールを区別するために使用されます。
lastActivityTime	string (date-time)	デバイスが最後に接続、受信、またはメッセージを送信した日時。
managedBy	string	このモジュールを管理している主体を識別します。たとえば、エッジランタイムがこのモジュールを所有している場合、この値は "IotEdge" になります。
moduleId	string	モジュールの一意識別子。

名前	型	説明
200 OK	Module	わかりました。
201 Created	Module	作成。

Object

名前	型	説明
symmetricKey	SymmetricKey	SAS ベースの認証に使用されるプライマリキーとセカンダリキー。
type	enum: certificateAuthority none sas selfSigned	サービスへの接続に使用される認証の種類。
x509Thumbprint	X509Thumbprint	x509 ベースの認証に使用されるプライマリとセカンダリの x509 拇印。

Object

デバイス上のモジュール ID。

名前	型	説明
authentication	AuthenticationMechanism	サービスとエッジハブに接続するときにモジュールによって使用される認証メカニズム。
cloudToDeviceMessageCount	integer (int32)	モジュールに送信するために現在キューに登録されている、クラウドからモジュールへのメッセージの数。
connectionState	enum: Connected Disconnected	デバイスの接続状態。
connectionStateUpdatedTime	string (date-time)	接続状態が最後に更新された日時。
deviceId	string	デバイスの一意識別子。
etag	string	RFC7232に従って、モジュール ID の弱い ETag を表す文字列。
generationId	string	IoT Hub によって生成された、最大 128 文字の大文字と小文字を区別する文字列。この値は、削除されて再作成されたときに、同じ moduleId を持つモジュールを区別するために使用されます。
lastActivityTime	string (date-time)	デバイスが最後に接続、受信、またはメッセージを送信した日時。
managedBy	string	このモジュールを管理している主体を識別します。たとえば、エッジランタイムがこのモジュールを所有している場合、この値は "IotEdge" になります。
moduleId	string	モジュールの一意識別子。

Object

名前	型	説明
primaryKey	string	デバイスの base64 でエンコードされた主キー。
secondaryKey	string	デバイスの base64 でエンコードされたセカンダリキー。

Object

名前	型	説明
primaryThumbprint	string	X509 クライアント証明書のプライマリ拇印。
secondaryThumbprint	string	X509 クライアント証明書のセカンダリ拇印。