Devices - Replace Module Properties

Tjänst:

IoT Central

API-version:

2022-07-31

Ersätt modulegenskaper
Ersätt alla egenskapsvärden för en modul.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
baseDomain	path	True	string	Basdomänen för alla Azure IoT Central-tjänstbegäranden.
deviceId	path	True	string	Enhetens unika ID.
moduleName	path	True	string	Namnet på enhetsmodulen.
subdomain	path	True	string	Programmets underdomän.
api-version	query	True	string	Den version av API:et som anropas.

Begärandetext

Name	Typ	Description
body	DeviceProperties	Modulegenskaper.

Svar

Name	Typ	Description
202 Accepted	DeviceProperties	Framgång
Other Status Codes	Error	Ett felsvar som togs emot från IoT Central-tjänsten. Sidhuvuden x-ms-error-code: string

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Update properties of a module

Exempelbegäran

HTTP

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

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

Exempelsvar

Statuskod:

202

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

Definitioner

Name	Description
Error	Svarsfeldefinitionen.
ErrorDetails	Information om felet.

Error

Objekt

Svarsfeldefinitionen.

Name	Typ	Description
error	ErrorDetails	Felinformation för aktuell begäran.

ErrorDetails

Objekt

Information om felet.

Name	Typ	Description
code	string	Felkod.
message	string	Information om felmeddelande.
requestId	string	Korrelations-ID för aktuell begäran.
time	string (date-time-rfc1123)	Den tid då felbegäran misslyckades.