Devices - Replace Module Properties

Layanan:

IoT Central

Versi API:

2022-07-31

Mengganti properti modul
Ganti semua nilai properti modul.

PUT https://{subdomain}.{baseDomain}/api/devices/{deviceId}/modules/{moduleName}/properties?api-version=2022-07-31

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
baseDomain	path	True	string	Domain dasar untuk semua permintaan layanan Azure IoT Central.
deviceId	path	True	string	ID unik perangkat.
moduleName	path	True	string	Nama modul perangkat.
subdomain	path	True	string	Subdomain aplikasi.
api-version	query	True	string	Versi API yang dipanggil.

Isi Permintaan

Nama	Jenis	Deskripsi
body	DeviceProperties	Properti modul.

Respons

Nama	Jenis	Deskripsi
202 Accepted	DeviceProperties	Keberhasilan
Other Status Codes	Error	Respons kesalahan diterima dari IoT Central Service. Header x-ms-error-code: string

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Update properties of a module

Permintaan sampel

HTTP

PUT https://appsubdomain.azureiotcentral.com/api/devices/mx1/modules/module_env/properties?api-version=2022-07-31

{
  "componentA": {
    "SensitivityDial": 200
  }
}

Respon sampel

Kode status:

202

{
  "componentA": {
    "SensitivityDial": 75,
    "$metadata": {
      "SensitivityDial": {
        "desiredValue": 200,
        "desiredVersion": 3,
        "ackVersion": 1,
        "ackDescription": "Ok",
        "ackCode": 200,
        "lastUpdateTime": "2020-04-27T22:08:55.1149957Z"
      }
    }
  }
}

Definisi

Nama	Deskripsi
Error	Definisi kesalahan respons.
ErrorDetails	Informasi detail kesalahan.

Error

Objek

Definisi kesalahan respons.

Nama	Jenis	Deskripsi
error	ErrorDetails	Detail kesalahan untuk permintaan saat ini.

ErrorDetails

Objek

Informasi detail kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
message	string	Detail pesan kesalahan.
requestId	string	Id Korelasi untuk permintaan saat ini.
time	string (date-time-rfc1123)	Waktu permintaan kesalahan gagal.