Modules - Update Twin
Updates tag dan properti yang diinginkan dari kembar modul. Lihat https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins untuk informasi lebih lanjut.
PATCH https://fully-qualified-iothubname.azure-devices.net/twins/{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 kembar perangkat, sesuai RFC7232. Ini menentukan apakah operasi pembaruan harus dilakukan. |
Isi Permintaan
Nama | Jenis | Deskripsi |
---|---|---|
authenticationType |
enum:
|
Jenis autentikasi yang digunakan oleh perangkat. |
capabilities |
Status kemampuan yang diaktifkan pada perangkat. |
|
cloudToDeviceMessageCount |
integer |
Jumlah pesan cloud-ke-perangkat yang dikirim. |
connectionState |
enum:
|
Status koneksi perangkat. |
deviceEtag |
string |
String yang mewakili ETag untuk perangkat, sesuai RFC7232. |
deviceId |
string |
Pengidentifikasi unik perangkat dalam registri identitas IoT Hub. Ini adalah string peka huruf besar/kecil (panjang hingga 128 karakter) dari karakter alfanumerik ASCII 7-bit, dan karakter khusus berikut {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}. |
deviceScope |
string |
Cakupan perangkat. |
etag |
string |
String yang mewakili ETag untuk kembar perangkat, sesuai RFC7232. |
lastActivityTime |
string |
Tanggal dan waktu saat perangkat terakhir tersambung atau menerima atau mengirim pesan. Tanggal dan waktu dipisahkan dalam format tanggalwaktu ISO8601 dalam UTC, misalnya, 2015-01-28T16:24:48.789Z. Nilai ini tidak diperbarui jika perangkat menggunakan protokol HTTP/1 untuk melakukan operasi olahpesan. |
moduleId |
string |
Pengidentifikasi unik modul dalam registri identitas IoT Hub. Ini adalah string peka huruf besar/kecil (panjang hingga 128 karakter) dari karakter alfanumerik ASCII 7-bit, dan karakter khusus berikut {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}. |
parentScopes |
string[] |
Cakupan perangkat tepi tingkat atas jika berlaku. Hanya tersedia untuk perangkat edge. |
properties |
Properti kembar yang diinginkan dan dilaporkan. |
|
status |
enum:
|
Status perangkat yang diaktifkan. Jika dinonaktifkan, perangkat tidak dapat tersambung ke layanan. |
statusReason |
string |
Alasan status perangkat saat ini, jika ada. |
statusUpdateTime |
string |
Tanggal dan waktu saat status perangkat terakhir diperbarui. |
tags |
object |
Kumpulan pasangan kunci-nilai dibaca dan ditulis oleh back end solusi. Mereka tidak terlihat oleh aplikasi perangkat. Kuncinya adalah UTF-8 yang dikodekan, peka huruf besar/kecil, dan panjangnya hingga 1KB. Karakter yang diizinkan mengecualikan karakter kontrol UNICODE (segmen C0 dan C1), '.', '$' dan spasi. Nilainya adalah objek JSON, panjangnya hingga 4KB. |
version |
integer |
Versi untuk perangkat kembar termasuk tag dan properti yang diinginkan |
x509Thumbprint |
Thumbprint X509 perangkat. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
OK. |
Definisi
Nama | Deskripsi |
---|---|
Device |
Status kemampuan yang diaktifkan pada perangkat. |
Twin |
Informasi status untuk perangkat atau modul. Ini secara implisit dibuat dan dihapus saat identitas perangkat/modul yang sesuai dibuat atau dihapus di IoT Hub. |
Twin |
Properti kembar yang diinginkan dan dilaporkan. Kedalaman maksimum objek adalah 10. |
X509Thumbprint |
DeviceCapabilities
Status kemampuan yang diaktifkan pada perangkat.
Nama | Jenis | Deskripsi |
---|---|---|
iotEdge |
boolean |
Properti yang menentukan apakah perangkat adalah perangkat edge atau tidak. |
Twin
Informasi status untuk perangkat atau modul. Ini secara implisit dibuat dan dihapus saat identitas perangkat/modul yang sesuai dibuat atau dihapus di IoT Hub.
Nama | Jenis | Deskripsi |
---|---|---|
authenticationType |
enum:
|
Jenis autentikasi yang digunakan oleh perangkat. |
capabilities |
Status kemampuan yang diaktifkan pada perangkat. |
|
cloudToDeviceMessageCount |
integer |
Jumlah pesan cloud-ke-perangkat yang dikirim. |
connectionState |
enum:
|
Status koneksi perangkat. |
deviceEtag |
string |
String yang mewakili ETag untuk perangkat, sesuai RFC7232. |
deviceId |
string |
Pengidentifikasi unik perangkat dalam registri identitas IoT Hub. Ini adalah string peka huruf besar/kecil (panjang hingga 128 karakter) dari karakter alfanumerik ASCII 7-bit, dan karakter khusus berikut {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}. |
deviceScope |
string |
Cakupan perangkat. |
etag |
string |
String yang mewakili ETag untuk kembar perangkat, sesuai RFC7232. |
lastActivityTime |
string |
Tanggal dan waktu saat perangkat terakhir tersambung atau menerima atau mengirim pesan. Tanggal dan waktu dipisahkan dalam format tanggalwaktu ISO8601 dalam UTC, misalnya, 2015-01-28T16:24:48.789Z. Nilai ini tidak diperbarui jika perangkat menggunakan protokol HTTP/1 untuk melakukan operasi olahpesan. |
moduleId |
string |
Pengidentifikasi unik modul dalam registri identitas IoT Hub. Ini adalah string peka huruf besar/kecil (panjang hingga 128 karakter) dari karakter alfanumerik ASCII 7-bit, dan karakter khusus berikut {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}. |
parentScopes |
string[] |
Cakupan perangkat tepi tingkat atas jika berlaku. Hanya tersedia untuk perangkat edge. |
properties |
Properti kembar yang diinginkan dan dilaporkan. |
|
status |
enum:
|
Status perangkat yang diaktifkan. Jika dinonaktifkan, perangkat tidak dapat tersambung ke layanan. |
statusReason |
string |
Alasan status perangkat saat ini, jika ada. |
statusUpdateTime |
string |
Tanggal dan waktu saat status perangkat terakhir diperbarui. |
tags |
object |
Kumpulan pasangan kunci-nilai dibaca dan ditulis oleh back end solusi. Mereka tidak terlihat oleh aplikasi perangkat. Kuncinya adalah UTF-8 yang dikodekan, peka huruf besar/kecil, dan panjangnya hingga 1KB. Karakter yang diizinkan mengecualikan karakter kontrol UNICODE (segmen C0 dan C1), '.', '$' dan spasi. Nilainya adalah objek JSON, panjangnya hingga 4KB. |
version |
integer |
Versi untuk perangkat kembar termasuk tag dan properti yang diinginkan |
x509Thumbprint |
Thumbprint X509 perangkat. |
TwinProperties
Properti kembar yang diinginkan dan dilaporkan. Kedalaman maksimum objek adalah 10.
Nama | Jenis | Deskripsi |
---|---|---|
desired |
object |
Kumpulan pasangan kunci-nilai properti yang diinginkan. Kuncinya adalah UTF-8 yang dikodekan, peka huruf besar/kecil, dan panjangnya hingga 1KB. Karakter yang diizinkan mengecualikan karakter kontrol UNICODE (segmen C0 dan C1), '.', '$' dan spasi. Nilai porperty yang diinginkan adalah objek JSON, panjangnya hingga 4KB. |
reported |
object |
Kumpulan pasangan kunci-nilai properti yang dilaporkan. Kuncinya adalah UTF-8 yang dikodekan, peka huruf besar/kecil, dan panjangnya hingga 1KB. Karakter yang diizinkan mengecualikan karakter kontrol UNICODE (segmen C0 dan C1), '.', '$' dan spasi. Nilai properti yang dilaporkan adalah objek JSON, panjangnya hingga 4KB. |
X509Thumbprint
Nama | Jenis | Deskripsi |
---|---|---|
primaryThumbprint |
string |
Thumbprint utama sertifikat klien X509. |
secondaryThumbprint |
string |
Thumbprint sekunder sertifikat klien X509. |