Devices - Replace Module Properties

Service:

IoT Central

API Version:

2022-07-31

Replace module properties
Replace all property values of a module.

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

URI Parameters

Name	In	Required	Type	Description
baseDomain	path	True	string	The base domain for all Azure IoT Central service requests.
deviceId	path	True	string	Unique ID of the device.
moduleName	path	True	string	Name of the device module.
subdomain	path	True	string	The application subdomain.
api-version	query	True	string	The version of the API being called.

Request Body

Name	Type	Description
body	DeviceProperties	Module properties.

Responses

Name	Type	Description
202 Accepted	DeviceProperties	Success
Other Status Codes	Error	An error response received from the IoT Central Service. Headers x-ms-error-code: string

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Update properties of a module

Sample request

HTTP

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

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

Sample response

Status code:

202

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

Definitions

Name	Description
Error	The response error definition.
ErrorDetails	The detail information of the error.

Error

Object

The response error definition.

Name	Type	Description
error	ErrorDetails	Error details for current request.

ErrorDetails

Object

The detail information of the error.

Name	Type	Description
code	string	Error code.
message	string	Error message details.
requestId	string	Correlation Id for current request.
time	string (date-time-rfc1123)	The time that error request failed.