Twin 클래스

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

상속

Model

Twin

생성자

Twin(*, device_id: str = None, module_id: str = None, tags=None, properties=None, etag: str = None, version: int = None, device_etag: str = None, status=None, status_reason: str = None, status_update_time=None, connection_state=None, last_activity_time=None, cloud_to_device_message_count: int = None, authentication_type=None, x509_thumbprint=None, capabilities=None, device_scope: str = None, parent_scopes=None, **kwargs)

매개 변수

device_id

str

필수

IoT Hub ID 레지스트리에 있는 디바이스의 고유 식별자입니다. ASCII 7비트 영숫자 문자의 대/소문자를 구분하는 문자열(최대 128자 길이)입니다. 다음 특수 문자 {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '!', '(', ')', '', '=', '@', ';', '$', '''}.

module_id

str

필수

IoT Hub ID 레지스트리에 있는 모듈의 고유 식별자입니다. ASCII 7비트 영숫자 문자의 대/소문자를 구분하는 문자열(최대 128자 길이)입니다. 다음 특수 문자 {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '!', '(', ')', '', '=', '@', ';', '$', '''}.

tags

dict[str, object]

필수

솔루션 백 엔드에서 읽고 쓴 키-값 쌍의 컬렉션입니다. 디바이스 앱에는 표시되지 않습니다. 키는 UTF-8로 인코딩되고 대/소문자를 구분하며 길이가 최대 1KB입니다. 허용되는 문자는 UNICODE 컨트롤 문자(세그먼트 C0 및 C1), '.', '$' 및 공백을 제외합니다. 값은 길이가 최대 4KB인 JSON 개체입니다.

properties

TwinProperties

필수

트윈의 desired 및 reported 속성입니다.

etag

str

필수

RFC7232에 따라 디바이스 쌍에 대한 ETag를 나타내는 문자열입니다.

version

<xref:long>

필수

태그 및 desired 속성을 포함하는 디바이스 쌍의 버전

device_etag

str

필수

RFC7232에 따라 디바이스에 대한 ETag를 나타내는 문자열입니다.

status

str 또는 <xref:protocol.models.enum>

필수

디바이스의 활성화된 상태. 사용하지 않도록 설정하면 디바이스가 서비스에 연결할 수 없습니다. 가능한 값은 'enabled', 'disabled'입니다.

status_reason

str

필수

디바이스의 현재 상태 이유입니다(있는 경우).

status_update_time

datetime

필수

디바이스의 상태 마지막으로 업데이트된 날짜 및 시간입니다.

connection_state

str 또는 <xref:protocol.models.enum>

필수

디바이스의 연결 상태입니다. 가능한 값은 '연결 끊김', '연결됨'입니다.

last_activity_time

datetime

필수

디바이스가 마지막으로 연결되었거나 메시지를 받거나 보낸 날짜 및 시간입니다. 날짜 및 시간은 UTC의 ISO8601 날짜/시간 형식으로 지정됩니다(예: 2015-01-28T16:24:48.789Z). 디바이스가 HTTP/1 프로토콜을 사용하여 메시징 작업을 수행하는 경우 이 값은 업데이트되지 않습니다.

cloud_to_device_message_count

int

필수

전송된 클라우드-디바이스 메시지 수입니다.

authentication_type

str 또는 <xref:protocol.models.enum>

필수

디바이스에서 사용하는 인증 유형입니다. 가능한 값은 'sas', 'selfSigned', 'certificateAuthority', 'none'입니다.

x509_thumbprint

X509Thumbprint

필수

디바이스의 X509 지문입니다.

capabilities

DeviceCapabilities

필수

device_scope

str

필수

디바이스의 범위입니다.

parent_scopes

list[str]

필수

해당하는 경우 상위 수준 에지 디바이스의 범위입니다. 에지 디바이스에만 사용할 수 있습니다.

메서드

as_dict	json.dump를 사용하여 JSONify일 수 있는 받아쓰기를 반환합니다. 고급 사용은 필요에 따라 콜백을 매개 변수로 사용할 수 있습니다. 키는 Python에서 사용되는 특성 이름입니다. Attr_desc 메타데이터의 받아쓰기입니다. 현재 msrest 형식의 'type'과 RestAPI로 인코딩된 키가 있는 'key'가 포함되어 있습니다. Value는 이 개체의 현재 값입니다. 반환된 문자열은 키를 serialize하는 데 사용됩니다. 반환 형식이 목록인 경우 계층적 결과 받아쓰기로 간주됩니다. 이 파일의 세 가지 예제를 참조하세요. attribute_transformer full_restapi_key_transformer last_restapi_key_transformer XML serialization을 원하는 경우 kwargs is_xml=True를 전달할 수 있습니다.
deserialize	RestAPI 구문을 사용하여 str을 구문 분석하고 모델을 반환합니다.
enable_additional_properties_sending
from_dict	지정된 키 추출기를 사용하여 받아쓰기를 구문 분석하여 모델을 반환합니다. 기본적으로 키 추출기(rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor 및 last_rest_key_case_insensitive_extractor)를 고려합니다.
is_xml_model
serialize	이 모델에서 azure로 전송될 JSON을 반환합니다. 이는 as_dict(full_restapi_key_transformer, keep_readonly=False)에 대한 별칭입니다. XML serialization을 원하는 경우 kwargs is_xml=True를 전달할 수 있습니다.
validate	이 모델의 유효성을 재귀적으로 검사하고 ValidationError 목록을 반환합니다.

as_dict

json.dump를 사용하여 JSONify일 수 있는 받아쓰기를 반환합니다.

고급 사용은 필요에 따라 콜백을 매개 변수로 사용할 수 있습니다.

키는 Python에서 사용되는 특성 이름입니다. Attr_desc 메타데이터의 받아쓰기입니다. 현재 msrest 형식의 'type'과 RestAPI로 인코딩된 키가 있는 'key'가 포함되어 있습니다. Value는 이 개체의 현재 값입니다.

반환된 문자열은 키를 serialize하는 데 사용됩니다. 반환 형식이 목록인 경우 계층적 결과 받아쓰기로 간주됩니다.

이 파일의 세 가지 예제를 참조하세요.

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

XML serialization을 원하는 경우 kwargs is_xml=True를 전달할 수 있습니다.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

매개 변수

key_transformer

<xref:function>

키 변환기 함수입니다.

keep_readonly

기본값: True

반환

dict JSON 호환 개체

반환 형식

dict

deserialize

RestAPI 구문을 사용하여 str을 구문 분석하고 모델을 반환합니다.

deserialize(data, content_type=None)

매개 변수

data

str

필수

RestAPI 구조를 사용하는 str입니다. 기본적으로 JSON입니다.

content_type

str

기본값: None

기본적으로 JSON은 XML인 경우 application/xml을 설정합니다.

반환

이 모델의 instance

예외

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

지정된 키 추출기를 사용하여 받아쓰기를 구문 분석하여 모델을 반환합니다.

기본적으로 키 추출기(rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor 및 last_rest_key_case_insensitive_extractor)를 고려합니다.

from_dict(data, key_extractors=None, content_type=None)

매개 변수

data

dict

필수

RestAPI 구조를 사용하는 받아쓰기

content_type

str

기본값: None

기본적으로 JSON은 XML인 경우 application/xml을 설정합니다.

key_extractors

기본값: None

반환

이 모델의 instance

예외

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

이 모델에서 azure로 전송될 JSON을 반환합니다.

이는 as_dict(full_restapi_key_transformer, keep_readonly=False)에 대한 별칭입니다.

XML serialization을 원하는 경우 kwargs is_xml=True를 전달할 수 있습니다.

serialize(keep_readonly=False, **kwargs)

매개 변수

keep_readonly

bool

기본값: False

읽기 전용 특성을 직렬화하려는 경우

반환

dict JSON 호환 개체

반환 형식

dict

validate

이 모델의 유효성을 재귀적으로 검사하고 ValidationError 목록을 반환합니다.

validate()

반환

유효성 검사 오류 목록

반환 형식

list