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
-
Twin
Oluşturucu
Twin(**kwargs)
Parametreler
- device_id
- str
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ğundadır) ve aşağıdaki özel karakterler :{'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
- module_id
- str
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ğundadır) ve aşağıdaki özel karakterler :{'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
Çözüm arka ucu tarafından okunan ve yazılan anahtar-değer çiftleri koleksiyonu. Bunlar cihaz uygulamaları tarafından görünmez. Bu anahtarlar UTF-8 kodlu, 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şluğu hariç tutar. Değerler, uzunluğu en çok 4 KB olan JSON nesneleridir.
- version
- <xref:long>
Etiketler ve istenen özellikler dahil olmak üzere cihaz ikizinin sürümü
- status
- str veya <xref:protocol.models.enum>
Cihazın etkin durumu. Devre dışı bırakılırsa cihaz hizmete bağlanamaz. Olası değerler şunlardır: 'enabled', 'disabled'
- connection_state
- str veya <xref:protocol.models.enum>
Cihazın bağlantı durumu. Olası değerler şunlardır: 'Bağlantısı kesildi', 'Bağlandı'
- last_activity_time
- datetime
Cihazın en son bağlanıp aldığı 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.
- authentication_type
- str veya <xref:protocol.models.enum>
Cihaz tarafından kullanılan kimlik doğrulama türü. Olası değerler şunlardır: 'sas', 'selfSigned', 'certificateAuthority', 'none'
- capabilities
- DeviceCapabilities
Varsa üst düzey uç cihazların kapsamları. Yalnızca uç cihazlarda kullanılabilir.
Yöntemler
as_dict |
json.dump kullanarak JSONify olabilecek bir dikte döndürebilirsiniz. Gelişmiş kullanım isteğe bağlı olarak parametre olarak bir geri çağırma kullanabilir: Anahtar, Python'da kullanılan öznitelik adıdır. Attr_desc, meta verilerin bir diktesidir. Şu anda msrest türüyle 'type' ve RestAPI kodlanmış anahtarıyla 'key' içerir. 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:
XML serileştirme istiyorsanız, kwargs is_xml=True 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 kodunu döndür. Bu, as_dict(full_restapi_key_transformer, keep_readonly=False) için bir diğer addır. XML serileştirme istiyorsanız, kwargs is_xml=True 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ürebilirsiniz.
Gelişmiş kullanım isteğe bağlı olarak parametre olarak bir geri çağırma kullanabilir:
Anahtar, Python'da kullanılan öznitelik adıdır. Attr_desc, meta verilerin bir diktesidir. Şu anda msrest türüyle 'type' ve RestAPI kodlanmış anahtarıyla 'key' içerir. 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ştirme istiyorsanız, kwargs is_xml=True 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
Döndürülenler
JSON uyumlu bir dikte nesnesi
Dönüş türü
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
- content_type
- str
JSON varsayılan olarak, XML ise application/xml değerini ayarlayın.
Döndürülenler
Bu modelin bir örneği
Özel durumlar
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
- content_type
- str
JSON varsayılan olarak, XML ise application/xml değerini ayarlayın.
- key_extractors
Döndürülenler
Bu modelin bir örneği
Özel durumlar
is_xml_model
is_xml_model()
serialize
Bu modelden Azure'a gönderilecek JSON kodunu döndür.
Bu, as_dict(full_restapi_key_transformer, keep_readonly=False) için bir diğer addır.
XML serileştirme istiyorsanız, kwargs is_xml=True geçirebilirsiniz.
serialize(keep_readonly=False, **kwargs)
Parametreler
- keep_readonly
- bool
Salt okunur öznitelikleri seri hale getirmek istiyorsanız
Döndürülenler
JSON uyumlu bir dikte nesnesi
Dönüş türü
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ü
Azure SDK for Python