Twin class
디바이스 쌍은 Azure IoT Hub에 의해 저장되고 디바이스가 오프라인인 경우에도 사용할 수 있는 디바이스의 상태를 설명하는 문서입니다. 다음 3개 섹션을 중심으로 빌드됩니다.
- 태그: 서비스 쪽에서만 액세스할 수 있는 키/값 쌍
- Desired 속성: 서비스에 의해 업데이트되고 디바이스에서 수신됨
- Reported 속성: 디바이스에서 업데이트되고 서비스에서 수신합니다.
가능하지만 desired 및 reported 속성은 일치할 필요가 없으며 필요한 경우 이러한 두 컬렉션을 동기화하는 논리는 SDK 사용자에게 둡니다.
자세한 내용은 디바이스 쌍 이해를 참조하세요.
특정 디바이스에 대해 를 Twin 가져오는 권장 방법은 메서드를 getTwin(string, HttpResponseCallback<Twin>) 사용하는 것입니다.
생성자
| Twin(string | Device |
새 Twin을 인스턴스화합니다. 새 Twin 개체를 가져오는 권장 방법은 메서드를 사용하는 것입니다 getTwin(string, HttpResponseCallback<Twin>) . |
속성
| device |
쌍과 연결된 디바이스 ID의 고유 식별자는 디바이스 ID 레지스트리에 존재합니다. |
| etag | 디바이스 쌍의 여러 병렬 버전을 방지하기 위해 낙관적 동시성에 사용되는 태그입니다. |
| model |
쌍과 연결된 디바이스 ID의 모델 ID입니다(디바이스 ID 레지스트리에 있음). |
| module |
디바이스 ID 레지스트리에 있는 트윈과 연결된 모듈의 모듈 식별자입니다. |
| properties | desired 및 reported 속성 dictionnaries(각각 및 |
| tags | 서비스 쪽에서만 사용할 수 있고 쿼리에서 특정 디바이스를 찾는 데 사용할 수 있는 키/값 쌍의 컬렉션입니다. |
메서드
| get() | |
| get(Incoming |
IoT Hub 서비스에서 이 디바이스 쌍의 최신 버전을 가져옵니다. |
| toJSON() | |
| update(any) | |
| update(any, Incoming |
인수로 제공되는 패치를 사용하여 디바이스 쌍을 업데이트합니다. |
생성자 세부 정보
Twin(string | DeviceIdentity, Registry)
새 Twin을 인스턴스화합니다. 새 Twin 개체를 가져오는 권장 방법은 메서드를 사용하는 것입니다 getTwin(string, HttpResponseCallback<Twin>) .
new Twin(device: string | DeviceIdentity, registryClient: Registry)매개 변수
- device
-
string | DeviceIdentity
디바이스 식별자 문자열 또는 디바이스를 설명하는 개체입니다. 개체인 경우 deviceId 속성을 포함해야 합니다.
- registryClient
- Registry
REST API 호출을 실행하는 데 사용되는 HTTP 레지스트리 클라이언트입니다.
속성 세부 정보
deviceId
쌍과 연결된 디바이스 ID의 고유 식별자는 디바이스 ID 레지스트리에 존재합니다.
deviceId: string속성 값
string
etag
디바이스 쌍의 여러 병렬 버전을 방지하기 위해 낙관적 동시성에 사용되는 태그입니다.
etag: string속성 값
string
modelId
쌍과 연결된 디바이스 ID의 모델 ID입니다(디바이스 ID 레지스트리에 있음).
modelId?: string속성 값
string
moduleId
디바이스 ID 레지스트리에 있는 트윈과 연결된 모듈의 모듈 식별자입니다.
moduleId?: string속성 값
string
properties
desired 및 reported 속성 dictionnaries(각각 및 properties.reported)properties.desired입니다.
properties: { desired: {[key: string]: any}, reported: {[key: string]: any} }속성 값
{ desired: {[key: string]: any}, reported: {[key: string]: any} }
tags
서비스 쪽에서만 사용할 수 있고 쿼리에서 특정 디바이스를 찾는 데 사용할 수 있는 키/값 쌍의 컬렉션입니다.
tags: {[key: string]: string}속성 값
{[key: string]: string}
메서드 세부 정보
get()
function get(): Promise<ResultWithIncomingMessage<Twin>>반환
Promise<ResultWithIncomingMessage<Twin>>
get(IncomingMessageCallback<Twin>)
IoT Hub 서비스에서 이 디바이스 쌍의 최신 버전을 가져옵니다.
function get(done?: IncomingMessageCallback<Twin>)매개 변수
toJSON()
function toJSON(): object반환
object
update(any)
function update(patch: any): Promise<ResultWithIncomingMessage<Twin>>매개 변수
- patch
-
any
반환
Promise<ResultWithIncomingMessage<Twin>>
update(any, IncomingMessageCallback<Twin>)
인수로 제공되는 패치를 사용하여 디바이스 쌍을 업데이트합니다.
function update(patch: any, done?: IncomingMessageCallback<Twin>)매개 변수
- patch
-
any
이 디바이스 쌍에 적용할 새 값을 포함하는 개체입니다.