Devices - Replace Module Properties

Service:

IoT Central

API-versie:

2022-07-31

Module-eigenschappen vervangen
Vervang alle eigenschapswaarden van een module.

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

URI-parameters

Name	In	Vereist	Type	Description
baseDomain	path	True	string	Het basisdomein voor alle Azure IoT Central-serviceaanvragen.
deviceId	path	True	string	Unieke id van het apparaat.
moduleName	path	True	string	Naam van de apparaatmodule.
subdomain	path	True	string	Het subdomein van de toepassing.
api-version	query	True	string	De versie van de API die wordt aangeroepen.

Aanvraagbody

Name	Type	Description
body	DeviceProperties	Module-eigenschappen.

Antwoorden

Name	Type	Description
202 Accepted	DeviceProperties	Geslaagd
Other Status Codes	Error	Er is een foutbericht ontvangen van de IoT Central-service. Kopteksten x-ms-error-code: string

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Update properties of a module

Voorbeeldaanvraag

HTTP

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

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

Voorbeeldrespons

Statuscode:

202

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

Definities

Name	Description
Error	De antwoordfoutdefinitie.
ErrorDetails	De gedetailleerde informatie over de fout.

Error

Object

De antwoordfoutdefinitie.

Name	Type	Description
error	ErrorDetails	Foutdetails voor de huidige aanvraag.

ErrorDetails

Object

De gedetailleerde informatie over de fout.

Name	Type	Description
code	string	Foutcode.
message	string	Details van foutbericht.
requestId	string	Correlatie-id voor huidige aanvraag.
time	string (date-time-rfc1123)	Het tijdstip waarop de foutaanvraag is mislukt.