Devices - Replace Module Properties

Service:

IoT Central

Version d'API:

2022-07-31

Remplacer les propriétés du module
Remplacez toutes les valeurs de propriété d’un module.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
baseDomain	path	True	string	Domaine de base pour toutes les demandes de service Azure IoT Central.
deviceId	path	True	string	ID unique de l’appareil.
moduleName	path	True	string	Nom du module d’appareil.
subdomain	path	True	string	Sous-domaine de l’application.
api-version	query	True	string	Version de l’API appelée.

Corps de la demande

Nom	Type	Description
body	DeviceProperties	Propriétés du module.

Réponses

Nom	Type	Description
202 Accepted	DeviceProperties	Succès
Other Status Codes	Error	Réponse d’erreur reçue du service IoT Central. En-têtes x-ms-error-code: string

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Update properties of a module

Exemple de requête

HTTP

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

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

Exemple de réponse

Code d’état:

202

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

Définitions

Nom	Description
Error	Définition de l’erreur de réponse.
ErrorDetails	Informations détaillées de l’erreur.

Error

Object

Définition de l’erreur de réponse.

Nom	Type	Description
error	ErrorDetails	Détails de l’erreur pour la requête actuelle.

ErrorDetails

Object

Informations détaillées de l’erreur.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Détails du message d’erreur.
requestId	string	ID de corrélation pour la requête actuelle.
time	string (date-time-rfc1123)	Heure à laquelle la demande d’erreur a échoué.