Modules - Create Or Update Identity

Service:

IoT Hub

API Version:

2021-04-12

Membuat atau memperbarui identitas modul untuk perangkat di IoT Hub. moduleId dan generationId tidak dapat diperbarui oleh pengguna.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
id	path	True	string	Pengidentifikasi unik perangkat.
mid	path	True	string	Pengidentifikasi unik modul.
api-version	query	True	string	Versi Api.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
If-Match		string	String yang mewakili ETag lemah untuk modul, sesuai RFC7232. Ini tidak boleh diatur saat membuat modul, tetapi dapat diatur saat memperbarui modul.

Isi Permintaan

Nama	Jenis	Deskripsi
authentication	AuthenticationMechanism	Mekanisme autentikasi yang digunakan oleh modul saat menyambungkan ke layanan dan hub tepi.
cloudToDeviceMessageCount	integer	Jumlah pesan cloud-to-module saat ini mengantre untuk dikirim ke modul.
connectionState	enum: Disconnected Connected	Status koneksi perangkat.
connectionStateUpdatedTime	string	Tanggal dan waktu status koneksi terakhir diperbarui.
deviceId	string	Pengidentifikasi unik perangkat.
etag	string	String yang mewakili ETag lemah untuk identitas modul, sesuai RFC7232.
generationId	string	String IoT Hub yang dihasilkan dan peka huruf besar/kecil hingga 128 karakter. Nilai ini digunakan untuk membedakan modul dengan moduleId yang sama, ketika modul telah dihapus dan dibuat ulang.
lastActivityTime	string	Tanggal dan waktu perangkat terakhir tersambung, diterima, atau mengirim pesan.
managedBy	string	Mengidentifikasi siapa yang mengelola modul ini. Misalnya, nilai ini adalah "IotEdge" jika runtime edge memiliki modul ini.
moduleId	string	Pengidentifikasi unik modul.

Respons

Nama	Jenis	Deskripsi
200 OK	Module	OK.
201 Created	Module	Dibuat.

Definisi

Nama	Deskripsi
AuthenticationMechanism
Module	Identitas modul pada perangkat.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Nama	Jenis	Deskripsi
symmetricKey	SymmetricKey	Kunci primer dan sekunder yang digunakan untuk autentikasi berbasis SAS.
type	enum: certificateAuthority none sas selfSigned	Jenis autentikasi yang digunakan untuk menyambungkan ke layanan.
x509Thumbprint	X509Thumbprint	Thumbprint x509 primer dan sekunder yang digunakan untuk autentikasi berbasis x509.

Module

Identitas modul pada perangkat.

Nama	Jenis	Deskripsi
authentication	AuthenticationMechanism	Mekanisme autentikasi yang digunakan oleh modul saat menyambungkan ke layanan dan hub tepi.
cloudToDeviceMessageCount	integer	Jumlah pesan cloud-to-module saat ini mengantre untuk dikirim ke modul.
connectionState	enum: Connected Disconnected	Status koneksi perangkat.
connectionStateUpdatedTime	string	Tanggal dan waktu status koneksi terakhir diperbarui.
deviceId	string	Pengidentifikasi unik perangkat.
etag	string	String yang mewakili ETag lemah untuk identitas modul, sesuai RFC7232.
generationId	string	String IoT Hub yang dihasilkan dan peka huruf besar/kecil hingga 128 karakter. Nilai ini digunakan untuk membedakan modul dengan moduleId yang sama, ketika modul telah dihapus dan dibuat ulang.
lastActivityTime	string	Tanggal dan waktu perangkat terakhir tersambung, diterima, atau mengirim pesan.
managedBy	string	Mengidentifikasi siapa yang mengelola modul ini. Misalnya, nilai ini adalah "IotEdge" jika runtime edge memiliki modul ini.
moduleId	string	Pengidentifikasi unik modul.

SymmetricKey

Nama	Jenis	Deskripsi
primaryKey	string	Kunci primer perangkat yang dikodekan base64.
secondaryKey	string	Kunci sekunder yang dikodekan base64 dari perangkat.

X509Thumbprint

Nama	Jenis	Deskripsi
primaryThumbprint	string	Thumbprint utama sertifikat klien X509.
secondaryThumbprint	string	Thumbprint sekunder sertifikat klien X509.