Devices - Replace Module Properties

Servizio:

IoT Central

Versione API:

2022-07-31

Sostituire le proprietà del modulo
Sostituire tutti i valori delle proprietà di un modulo.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
baseDomain	path	True	string	Dominio di base per tutte le richieste del servizio Azure IoT Central.
deviceId	path	True	string	ID univoco del dispositivo.
moduleName	path	True	string	Nome del modulo del dispositivo.
subdomain	path	True	string	Sottodominio dell'applicazione.
api-version	query	True	string	Versione dell'API chiamata.

Corpo della richiesta

Nome	Tipo	Descrizione
body	DeviceProperties	Proprietà del modulo.

Risposte

Nome	Tipo	Descrizione
202 Accepted	DeviceProperties	Successo
Other Status Codes	Error	Risposta di errore ricevuta dal servizio IoT Central. Intestazioni x-ms-error-code: string

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Update properties of a module

Esempio di richiesta

HTTP

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

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

Risposta di esempio

Codice di stato:

202

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

Definizioni

Nome	Descrizione
Error	Definizione dell'errore di risposta.
ErrorDetails	Informazioni dettagliate sull'errore.

Error

Object

Definizione dell'errore di risposta.

Nome	Tipo	Descrizione
error	ErrorDetails	Dettagli dell'errore per la richiesta corrente.

ErrorDetails

Object

Informazioni dettagliate sull'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Dettagli del messaggio di errore.
requestId	string	ID correlazione per la richiesta corrente.
time	string (date-time-rfc1123)	Ora in cui la richiesta di errore non è riuscita.