Module Sınıf
Bir cihazdaki modül kimliği.
- Devralma
-
Module
Oluşturucu
Module(*, module_id: str = None, managed_by: str = None, device_id: str = None, generation_id: str = None, etag: str = None, connection_state=None, connection_state_updated_time=None, last_activity_time=None, cloud_to_device_message_count: int = None, authentication=None, **kwargs)
Parametreler
- managed_by
- str
Bu modülü kimin yönettiğini tanımlar. Örneğin, bu modülün sahibi edge çalışma zamanıysa bu değer "IotEdge" olur.
- generation_id
- str
Oluşturulan IoT Hub, büyük/küçük harfe duyarlı dize en fazla 128 karakter uzunluğundadır. Bu değer, silinip yeniden oluşturulduklarında aynı moduleId'ye sahip modülleri ayırt etmek için kullanılır.
- connection_state
- str veya <xref:protocol.models.enum>
Cihazın bağlantı durumu. Olası değerler şunlardır: 'Bağlantısı kesildi', 'Bağlandı'
- connection_state_updated_time
- datetime
Bağlantı durumunun son güncelleştirildiği tarih ve saat.
- last_activity_time
- datetime
Cihazın en son bağlanıp alındığı veya ileti gönderdiği tarih ve saat.
- cloud_to_device_message_count
- int
Şu anda modüle gönderilmek üzere kuyruğa alınan buluttan modüle ileti sayısı.
- authentication
- AuthenticationMechanism
Hizmet ve uç hub'ına bağlanırken modül tarafından kullanılan kimlik doğrulama mekanizması.
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