Devices - Get Twin

참조

서비스:: IoT Hub

API 버전:: 2021-04-12

디바이스 쌍을 가져옵니다. 자세한 내용은 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins 을 참조하세요.

GET https://fully-qualified-iothubname.azure-devices.net/twins/{id}?api-version=2021-04-12

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
id	path	True	string	디바이스의 고유 식별자입니다.
api-version	query	True	string	API의 버전입니다.

응답

Name	형식	Description
200 OK	Twin	OK.

정의

Name	Description
DeviceCapabilities	디바이스에서 사용하도록 설정된 기능의 상태.
Twin	디바이스 또는 모듈의 상태 정보입니다. IoT Hub 해당 디바이스/모듈 ID를 만들거나 삭제할 때 암시적으로 만들어지고 삭제됩니다.
TwinProperties	트윈의 desired 및 reported 속성입니다. 개체의 최대 깊이는 10입니다.
X509Thumbprint

DeviceCapabilities

디바이스에서 사용하도록 설정된 기능의 상태.

Name	형식	Description
iotEdge	boolean	디바이스가 에지 디바이스인지 여부를 결정하는 속성입니다.

Twin

디바이스 또는 모듈의 상태 정보입니다. IoT Hub 해당 디바이스/모듈 ID를 만들거나 삭제할 때 암시적으로 만들어지고 삭제됩니다.

Name	형식	Description
authenticationType	enum: certificateAuthority none sas selfSigned	디바이스에서 사용하는 인증 유형입니다.
capabilities	DeviceCapabilities	디바이스에서 사용하도록 설정된 기능의 상태.
cloudToDeviceMessageCount	integer	전송된 클라우드-디바이스 메시지 수입니다.
connectionState	enum: Connected Disconnected	디바이스의 연결 상태입니다.
deviceEtag	string	RFC7232 따라 디바이스에 대한 ETag를 나타내는 문자열입니다.
deviceId	string	IoT Hub ID 레지스트리에 있는 디바이스의 고유 식별자입니다. ASCII 7비트 영숫자 문자의 대/소문자를 구분하는 문자열(최대 128자 길이)입니다. 다음 특수 문자 {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '!', '(', ')', '', '=', '@', ';', '$', '''}.
deviceScope	string	디바이스의 범위입니다.
etag	string	RFC7232 따라 디바이스 쌍에 대한 ETag를 나타내는 문자열입니다.
lastActivityTime	string	디바이스가 마지막으로 연결되었거나 메시지를 받거나 보낸 날짜 및 시간입니다. 날짜 및 시간은 UTC의 ISO8601 날짜/시간 형식으로 지정됩니다(예: 2015-01-28T16:24:48.789Z). 디바이스가 HTTP/1 프로토콜을 사용하여 메시징 작업을 수행하는 경우 이 값은 업데이트되지 않습니다.
moduleId	string	IoT Hub ID 레지스트리에 있는 모듈의 고유 식별자입니다. ASCII 7비트 영숫자 문자의 대/소문자를 구분하는 문자열(최대 128자 길이)입니다. 다음 특수 문자 {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '!', '(', ')', '', '=', '@', ';', '$', '''}.
parentScopes	string[]	해당하는 경우 상위 수준 에지 디바이스의 범위입니다. 에지 디바이스에만 사용할 수 있습니다.
properties	TwinProperties	트윈의 desired 및 reported 속성입니다.
status	enum: disabled enabled	디바이스의 활성화된 상태. 사용하지 않도록 설정하면 디바이스가 서비스에 연결할 수 없습니다.
statusReason	string	디바이스의 현재 상태 이유입니다(있는 경우).
statusUpdateTime	string	디바이스의 상태 마지막으로 업데이트된 날짜 및 시간입니다.
tags	object	솔루션 백 엔드에서 읽고 쓴 키-값 쌍의 컬렉션입니다. 디바이스 앱에는 표시되지 않습니다. 키는 UTF-8로 인코딩되고 대/소문자를 구분하며 길이가 최대 1KB입니다. 허용되는 문자는 UNICODE 컨트롤 문자(세그먼트 C0 및 C1), '.', '$' 및 공백을 제외합니다. 값은 길이가 최대 4KB인 JSON 개체입니다.
version	integer	태그 및 desired 속성을 포함하는 디바이스 쌍의 버전
x509Thumbprint	X509Thumbprint	디바이스의 X509 지문입니다.

TwinProperties

트윈의 desired 및 reported 속성입니다. 개체의 최대 깊이는 10입니다.

Name	형식	Description
desired	object	원하는 속성 키-값 쌍의 컬렉션입니다. 키는 UTF-8로 인코딩되고 대/소문자를 구분하며 길이가 최대 1KB입니다. 허용되는 문자는 UNICODE 컨트롤 문자(세그먼트 C0 및 C1), '.', '$' 및 공백을 제외합니다. 원하는 porperty 값은 길이가 최대 4KB인 JSON 개체입니다.
reported	object	reported 속성 키-값 쌍의 컬렉션입니다. 키는 UTF-8로 인코딩되고 대/소문자를 구분하며 길이가 최대 1KB입니다. 허용되는 문자는 UNICODE 컨트롤 문자(세그먼트 C0 및 C1), '.', '$' 및 공백을 제외합니다. reported 속성 값은 길이가 최대 4KB인 JSON 개체입니다.

X509Thumbprint

Name	형식	Description
primaryThumbprint	string	X509 클라이언트 인증서 기본 지문입니다.
secondaryThumbprint	string	X509 클라이언트 인증서 보조 지문입니다.

다음을 통해 공유