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	根據RFC7232，代表模組的弱式 ETag 字串。建立模組時不應設定此設定，但在更新模組時可能會設定。

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

名稱	類型	Description
200 OK	Module	還行。
201 Created	Module	創建。

Object

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

Object

裝置上的模組身分識別。

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

Object

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

Object

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