Twin Sınıf

Bir cihaz veya modülün durum bilgileri. Bu, IoT Hub ilgili cihaz/modül kimliği oluşturulduğunda veya silindiğinde örtük olarak oluşturulur ve silinir.

Devralma

Model

Twin

Oluşturucu

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)

Parametreler

device_id

str

Gerekli

IoT Hub kimlik kayıt defterindeki cihazın benzersiz tanımlayıcısı. ASCII 7 bit alfasayısal karakterlerden oluşan büyük/küçük harfe duyarlı bir dizedir (en fazla 128 karakter uzunluğunda), ve aşağıdaki özel karakterler :{'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.

module_id

str

Gerekli

IoT Hub kimlik kayıt defterindeki modülün benzersiz tanımlayıcısı. ASCII 7 bit alfasayısal karakterlerden oluşan büyük/küçük harfe duyarlı bir dizedir (en fazla 128 karakter uzunluğunda), ve aşağıdaki özel karakterler :{'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.

tags

dict[str, object]

Gerekli

Çözüm arka ucu tarafından okunan ve yazılan anahtar-değer çiftleri koleksiyonu. Bunlar cihaz uygulamalarına görünmez. Bu anahtarlar UTF-8 kodlamalı, büyük/küçük harfe duyarlı ve en fazla 1 KB uzunluğundadır. İzin verilen karakterler UNICODE denetim karakterlerini (C0 ve C1 kesimleri), '.', '$' ve boşluklarını hariç tutar. Değerler, uzunluğu en fazla 4 KB olan JSON nesneleridir.

properties

TwinProperties

Gerekli

İkizin istenen ve bildirilen özellikleri.

etag

str

Gerekli

RFC7232'ye göre cihaz ikizi için ETag'i temsil eden dize.

version

<xref:long>

Gerekli

Etiketler ve istenen özellikler dahil olmak üzere cihaz ikizi sürümü

device_etag

str

Gerekli

RFC7232'ye göre cihaz için ETag'i temsil eden dize.

status

str veya <xref:protocol.models.enum>

Gerekli

Cihazın etkin durumu. Devre dışı bırakılırsa cihaz hizmete bağlanamaz. Olası değerler şunlardır: 'enabled', 'disabled'

status_reason

str

Gerekli

Varsa cihazın geçerli durumunun nedeni.

status_update_time

datetime

Gerekli

Cihazın durumunun son güncelleştirildiği tarih ve saat.

connection_state

str veya <xref:protocol.models.enum>

Gerekli

Cihazın bağlantı durumu. Olası değerler şunlardır: 'Bağlantısı kesildi', 'Bağlandı'

last_activity_time

datetime

Gerekli

Cihazın en son bağlanıp alındığı veya ileti gönderdiği tarih ve saat. Tarih ve saat, UTC olarak ISO8601 tarih saat biçiminde belirtilir; örneğin, 2015-01-28T16:24:48.789Z. Cihaz mesajlaşma işlemlerini gerçekleştirmek için HTTP/1 protokolunu kullanıyorsa bu değer güncelleştirilmez.

cloud_to_device_message_count

int

Gerekli

Gönderilen buluttan cihaza ileti sayısı.

authentication_type

str veya <xref:protocol.models.enum>

Gerekli

Cihaz tarafından kullanılan kimlik doğrulama türü. Olası değerler şunlardır: 'sas', 'selfSigned', 'certificateAuthority', 'none'

x509_thumbprint

X509Thumbprint

Gerekli

Cihazın X509 parmak izi.

capabilities

DeviceCapabilities

Gerekli

device_scope

str

Gerekli

Cihazın kapsamı.

parent_scopes

list[str]

Gerekli

Varsa üst düzey uç cihazların kapsamları. Yalnızca uç cihazlar için kullanılabilir.

Yöntemler

as_dict	json.dump kullanarak JSONify olabilecek bir dikte döndürür. Gelişmiş kullanım isteğe bağlı olarak parametre olarak geri çağırma kullanabilir: Anahtar, Python'da kullanılan öznitelik adıdır. Attr_desc meta verilerin bir diktesidir. Şu anda msrest türüne sahip 'type' ve RestAPI kodlanmış anahtarıyla 'key' içeriyor. Değer, bu nesnedeki geçerli değerdir. Döndürülen dize, anahtarı seri hale getirmek için kullanılır. Dönüş türü bir listeyse, bu hiyerarşik sonuç diktesi olarak kabul edilir. Bu dosyadaki üç örne bakın: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer XML serileştirmesini istiyorsanız kwargs is_xml=True değerini geçirebilirsiniz.
deserialize	RestAPI söz dizimini kullanarak bir str ayrıştırın ve bir model döndürün.
enable_additional_properties_sending
from_dict	Verilen anahtar ayıklayıcıyı kullanarak bir dikteyi ayrıştırma bir model döndürür. Varsayılan olarak anahtar ayıklayıcıları (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor ve last_rest_key_case_insensitive_extractor) göz önünde bulundurun
is_xml_model
serialize	Bu modelden Azure'a gönderilecek JSON'ı döndür. Bu, as_dict(full_restapi_key_transformer, keep_readonly=False) için bir diğer addır. XML serileştirmesini istiyorsanız kwargs is_xml=True değerini geçirebilirsiniz.
validate	Bu modeli yinelemeli olarak doğrulayın ve ValidationError listesini döndürür.

as_dict

json.dump kullanarak JSONify olabilecek bir dikte döndürür.

Gelişmiş kullanım isteğe bağlı olarak parametre olarak geri çağırma kullanabilir:

Anahtar, Python'da kullanılan öznitelik adıdır. Attr_desc meta verilerin bir diktesidir. Şu anda msrest türüne sahip 'type' ve RestAPI kodlanmış anahtarıyla 'key' içeriyor. Değer, bu nesnedeki geçerli değerdir.

Döndürülen dize, anahtarı seri hale getirmek için kullanılır. Dönüş türü bir listeyse, bu hiyerarşik sonuç diktesi olarak kabul edilir.

Bu dosyadaki üç örne bakın:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

XML serileştirmesini istiyorsanız kwargs is_xml=True değerini geçirebilirsiniz.

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

Parametreler

key_transformer

<xref:function>

Anahtar transformatör işlevi.

keep_readonly

varsayılan değer: True

Döndürülenler

JSON uyumlu bir nesne dikte

Dönüş türü

dict

deserialize

RestAPI söz dizimini kullanarak bir str ayrıştırın ve bir model döndürün.

deserialize(data, content_type=None)

Parametreler

data

str

Gerekli

RestAPI yapısını kullanan bir str. Varsayılan olarak JSON.

content_type

str

varsayılan değer: None

Varsayılan olarak JSON, XML ise application/xml değerini ayarlayın.

Döndürülenler

Bu modelin bir örneği

Özel durumlar

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Verilen anahtar ayıklayıcıyı kullanarak bir dikteyi ayrıştırma bir model döndürür.

Varsayılan olarak anahtar ayıklayıcıları (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor ve last_rest_key_case_insensitive_extractor) göz önünde bulundurun

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

Parametreler

data

dict

Gerekli

RestAPI yapısını kullanan bir dikte

content_type

str

varsayılan değer: None

Varsayılan olarak JSON, XML ise application/xml değerini ayarlayın.

key_extractors

varsayılan değer: None

Döndürülenler

Bu modelin bir örneği

Özel durumlar

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Bu modelden Azure'a gönderilecek JSON'ı döndür.

Bu, as_dict(full_restapi_key_transformer, keep_readonly=False) için bir diğer addır.

XML serileştirmesini istiyorsanız kwargs is_xml=True değerini geçirebilirsiniz.

serialize(keep_readonly=False, **kwargs)

Parametreler

keep_readonly

bool

varsayılan değer: False

Salt okunur öznitelikleri seri hale getirmek istiyorsanız

Döndürülenler

JSON uyumlu bir nesne dikte

Dönüş türü

dict

validate

Bu modeli yinelemeli olarak doğrulayın ve ValidationError listesini döndürür.

validate()

Döndürülenler

Doğrulama hatası listesi

Dönüş türü

list