Modules - Create Or Update Identity

在 IoT 中樞中建立或更新裝置的模組身分識別。 moduleId 和 generationId 無法由使用者更新。

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

URI 參數

名稱	位於	必要	類型	Description
id	path	True	string	裝置的唯一識別碼。
mid	path	True	string	模組的唯一識別碼。
api-version	query	True	string	Api 的版本。

名稱	必要	類型	Description
If-Match		string	代表模組弱式 ETag 的字串，根據RFC7232。建立模組時不應該設定此設定，但可能會在更新模組時設定。

名稱	類型	Description
authentication	AuthenticationMechanism	連接到服務和邊緣中樞時，模組所使用的驗證機制。
cloudToDeviceMessageCount	integer	目前排入佇列中等待傳送至模組的雲端到模組訊息數目。
connectionState	enum: Disconnected Connected	裝置的連線狀態。
connectionStateUpdatedTime	string	上次更新連線狀態的日期和時間。
deviceId	string	裝置的唯一識別碼。
etag	string	根據RFC7232，代表模組身分識別的弱式 ETag 字串。
generationId	string	IoT 中樞產生的區分大小寫字串，長度上限為 128 個字元。當模組已刪除並重新建立時，這個值是用來區分具有相同moduleId的模組。
lastActivityTime	string	裝置上次連線、接收或傳送訊息的日期和時間。
managedBy	string	識別管理此課程模組的人員。例如，如果邊緣執行階段擁有此模組，則此值為 "IotEdge"。
moduleId	string	模組的唯一識別碼。

名稱	類型	Description
200 OK	Module	正常。
201 Created	Module	已建立。

名稱	類型	Description
symmetricKey	SymmetricKey	用於 SAS 型驗證的主要和次要金鑰。
type	enum: certificateAuthority none sas selfSigned	用來連線至服務的驗證類型。
x509Thumbprint	X509Thumbprint	用於 x509 型驗證的主要和次要 x509 指紋。

裝置上的模組身分識別。

名稱	類型	Description
authentication	AuthenticationMechanism	連接到服務和邊緣中樞時，模組所使用的驗證機制。
cloudToDeviceMessageCount	integer	目前排入佇列中等待傳送至模組的雲端到模組訊息數目。
connectionState	enum: Connected Disconnected	裝置的連線狀態。
connectionStateUpdatedTime	string	上次更新連線狀態的日期和時間。
deviceId	string	裝置的唯一識別碼。
etag	string	根據RFC7232，代表模組身分識別的弱式 ETag 字串。
generationId	string	IoT 中樞產生的區分大小寫字串，長度上限為 128 個字元。當模組已刪除並重新建立時，這個值是用來區分具有相同moduleId的模組。
lastActivityTime	string	裝置上次連線、接收或傳送訊息的日期和時間。
managedBy	string	識別管理此課程模組的人員。例如，如果邊緣執行階段擁有此模組，則此值為 "IotEdge"。
moduleId	string	模組的唯一識別碼。

名稱	類型	Description
primaryKey	string	裝置的base64編碼主鍵。
secondaryKey	string	裝置的base64編碼次要金鑰。

名稱	類型	Description
primaryThumbprint	string	X509 用戶端憑證主要指紋。
secondaryThumbprint	string	X509 用戶端憑證次要指紋。