Devices - Replace Module Properties

Usługa:

IoT Central

Wersja interfejsu API:

2022-07-31

Zamień właściwości modułu
Zastąp wszystkie wartości właściwości modułu.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
baseDomain	path	True	string	Domena podstawowa dla wszystkich żądań obsługi usługi Azure IoT Central.
deviceId	path	True	string	Unikatowy identyfikator urządzenia.
moduleName	path	True	string	Nazwa modułu urządzenia.
subdomain	path	True	string	Poddomena aplikacji.
api-version	query	True	string	Wywoływana wersja interfejsu API.

Treść żądania

Nazwa	Typ	Opis
body	DeviceProperties	Właściwości modułu.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted	DeviceProperties	Powodzenie
Other Status Codes	Error	Odebrano odpowiedź o błędzie z usługi IoT Central. Nagłówki x-ms-error-code: string

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Update properties of a module

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:

202

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

Definicje

Nazwa	Opis
Error	Definicja błędu odpowiedzi.
ErrorDetails	Szczegółowe informacje o błędzie.

Error

Objekt

Definicja błędu odpowiedzi.

Nazwa	Typ	Opis
error	ErrorDetails	Szczegóły błędu dla bieżącego żądania.

ErrorDetails

Objekt

Szczegółowe informacje o błędzie.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Szczegóły komunikatu o błędzie.
requestId	string	Identyfikator korelacji dla bieżącego żądania.
time	string (date-time-rfc1123)	Czas niepowodzenia żądania błędu.