Devices - Replace Module Properties

Dienst:

IoT Central

API-Version:

2022-07-31

Ersetzen von Moduleigenschaften
Ersetzen Sie alle Eigenschaftswerte eines Moduls.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
baseDomain	path	True	string	Die Basisdomäne für alle Azure IoT Central-Dienstanforderungen.
deviceId	path	True	string	Eindeutige ID des Geräts.
moduleName	path	True	string	Name des Gerätemoduls.
subdomain	path	True	string	Die Anwendungsdomäne.
api-version	query	True	string	Die Version der aufgerufenen API.

Anforderungstext

Name	Typ	Beschreibung
body	DeviceProperties	Moduleigenschaften.

Antworten

Name	Typ	Beschreibung
202 Accepted	DeviceProperties	Erfolg
Other Status Codes	Error	Eine Vom IoT Central Service empfangene Fehlerantwort. Header x-ms-error-code: string

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Update properties of a module

Beispielanforderung

HTTP

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

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

Beispiel für eine Antwort

Statuscode:

202

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

Definitionen

Name	Beschreibung
Error	Die Antwortfehlerdefinition.
ErrorDetails	Die Detailinformationen des Fehlers.

Error

Objekt

Die Antwortfehlerdefinition.

Name	Typ	Beschreibung
error	ErrorDetails	Fehlerdetails für die aktuelle Anforderung.

ErrorDetails

Objekt

Die Detailinformationen des Fehlers.

Name	Typ	Beschreibung
code	string	Fehlercode.
message	string	Fehlermeldungsdetails.
requestId	string	Korrelations-ID für aktuelle Anforderung.
time	string (date-time-rfc1123)	Der Zeitpunkt, zu dem die Fehleranforderung fehlgeschlagen ist.