Devices - Replace Module Properties

서비스:

IoT Central

API 버전:

2022-07-31

모듈 속성 바꾸기
모듈의 모든 속성 값을 대체합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
baseDomain	path	True	string	모든 Azure IoT Central 서비스 요청에 대한 기본 도메인입니다.
deviceId	path	True	string	디바이스의 고유 ID입니다.
moduleName	path	True	string	디바이스 모듈의 이름입니다.
subdomain	path	True	string	애플리케이션 하위 도메인입니다.
api-version	query	True	string	호출되는 API의 버전입니다.

요청 본문

Name	형식	Description
body	DeviceProperties	모듈 속성입니다.

응답

Name	형식	Description
202 Accepted	DeviceProperties	성공
Other Status Codes	Error	IoT Central 서비스에서 받은 오류 응답입니다. 헤더 x-ms-error-code: string

보안

azure_auth

Azure Active Directory OAuth2 흐름

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

Update properties of a module

샘플 요청

HTTP

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

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

샘플 응답

상태 코드:

202

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

정의

Name	Description
Error	응답 오류 정의입니다.
ErrorDetails	오류의 세부 정보입니다.

Error

Object

응답 오류 정의입니다.

Name	형식	Description
error	ErrorDetails	현재 요청에 대한 오류 세부 정보입니다.

ErrorDetails

Object

오류의 세부 정보입니다.

Name	형식	Description
code	string	오류 코드입니다.
message	string	오류 메시지 세부 정보입니다.
requestId	string	현재 요청에 대한 상관 관계 ID입니다.
time	string (date-time-rfc1123)	오류 요청이 실패한 시간입니다.