Devices - Create Or Update Identity

服務:

IoT Hub

API 版本:

2021-04-12

在 IoT 中樞的身分識別登錄中建立或更新裝置的身分識別。

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

URI 參數

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

要求標頭

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

要求本文

名稱	類型	Description
authentication	AuthenticationMechanism	裝置所使用的驗證機制。
capabilities	DeviceCapabilities	裝置的功能集。 例如，如果此裝置是邊緣裝置，則為 。
cloudToDeviceMessageCount	integer (int32)	目前佇列要傳送至裝置的雲端到裝置訊息數目。
connectionState	enum: Disconnected Connected	裝置的狀態。
connectionStateUpdatedTime	string (date-time)	上次更新連接狀態的日期和時間。
deviceId	string	裝置的唯一標識碼。
deviceScope	string	裝置的範圍。 為邊緣裝置自動產生且不可變，且可在分葉裝置中修改，以建立子系/父系關聯性。
etag	string	字串，代表裝置身分識別的弱式 ETag，根據RFC7232。
generationId	string	IoT 中樞產生的區分大小寫字串長度最多 128 個字元。 當裝置已刪除並重新建立時，這個值是用來區分具有相同 deviceId 的裝置。
lastActivityTime	string (date-time)	裝置上次連線、接收或傳送訊息的日期和時間。
parentScopes	string[]	適用時，上層邊緣裝置的範圍。 僅適用於邊緣裝置。
status	enum: enabled disabled	裝置的狀態。 如果狀態已停用，裝置就無法連線到服務。
statusReason	string	儲存裝置身分識別狀態原因的 128 個字元長字串。 允許所有 UTF-8 字元。
statusUpdatedTime	string (date-time)	上次更新狀態欄位的日期和時間。

回應

名稱	類型	Description
200 OK	Device	還行。

定義

名稱	Description
AuthenticationMechanism
Device
DeviceCapabilities	裝置上啟用的功能狀態。
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Object

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

Device

Object

名稱	類型	Description
authentication	AuthenticationMechanism	裝置所使用的驗證機制。
capabilities	DeviceCapabilities	裝置的功能集。 例如，如果此裝置是邊緣裝置，則為 。
cloudToDeviceMessageCount	integer (int32)	目前佇列要傳送至裝置的雲端到裝置訊息數目。
connectionState	enum: Connected Disconnected	裝置的狀態。
connectionStateUpdatedTime	string (date-time)	上次更新連接狀態的日期和時間。
deviceId	string	裝置的唯一標識碼。
deviceScope	string	裝置的範圍。 為邊緣裝置自動產生且不可變，且可在分葉裝置中修改，以建立子系/父系關聯性。
etag	string	字串，代表裝置身分識別的弱式 ETag，根據RFC7232。
generationId	string	IoT 中樞產生的區分大小寫字串長度最多 128 個字元。 當裝置已刪除並重新建立時，這個值是用來區分具有相同 deviceId 的裝置。
lastActivityTime	string (date-time)	裝置上次連線、接收或傳送訊息的日期和時間。
parentScopes	string[]	適用時，上層邊緣裝置的範圍。 僅適用於邊緣裝置。
status	enum: disabled enabled	裝置的狀態。 如果狀態已停用，裝置就無法連線到服務。
statusReason	string	儲存裝置身分識別狀態原因的 128 個字元長字串。 允許所有 UTF-8 字元。
statusUpdatedTime	string (date-time)	上次更新狀態欄位的日期和時間。

DeviceCapabilities

Object

裝置上啟用的功能狀態。

名稱	類型	Description
iotEdge	boolean	屬性，判斷裝置是否為邊緣裝置。

SymmetricKey

Object

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

X509Thumbprint

Object

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