Module Classe
Identité du module sur un appareil.
- Héritage
-
Module
Constructeur
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)
Paramètres
- managed_by
- str
Identifie qui gère ce module. Par exemple, cette valeur est « IotEdge » si le runtime Edge possède ce module.
- generation_id
- str
La chaîne IoT Hub générée, qui respecte la casse, jusqu’à 128 caractères. Cette valeur est utilisée pour distinguer les modules avec le même moduleId, lorsqu’ils ont été supprimés et recréés.
- etag
- str
Chaîne représentant un ETag faible pour l’identité de module, conformément à la RFC7232.
- connection_state
- str ou <xref:protocol.models.enum>
État de connexion de l’appareil. Les valeurs possibles sont les suivantes : « Déconnecté », « Connecté »
- connection_state_updated_time
- datetime
Date et heure de la dernière mise à jour de l’état de la connexion.
- last_activity_time
- datetime
Date et heure de la dernière connexion, réception ou envoi d’un message à l’appareil.
- cloud_to_device_message_count
- int
Nombre de messages cloud-à-module actuellement mis en file d’attente à envoyer au module.
- authentication
- AuthenticationMechanism
Mécanisme d’authentification utilisé par le module lors de la connexion au service et au hub edge.
Méthodes
as_dict |
Retourne un dict qui peut être JSONify à l’aide de json.dump. L’utilisation avancée peut éventuellement utiliser un rappel comme paramètre : La clé est le nom d’attribut utilisé dans Python. Attr_desc est une dictée de métadonnées. Contient actuellement « type » avec le type msrest et « key » avec la clé encodée RestAPI. Value est la valeur actuelle de cet objet. La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, il est considéré comme un dict de résultat hiérarchique. Consultez les trois exemples de ce fichier :
Si vous souhaitez la sérialisation XML, vous pouvez passer les kwargs is_xml=True. |
deserialize |
Analysez une str à l’aide de la syntaxe RestAPI et retournez un modèle. |
enable_additional_properties_sending | |
from_dict |
Analyser une dict à l’aide de l’extracteur de clé donné retourne un modèle. Par défaut, considérez les extracteurs de clés (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor et last_rest_key_case_insensitive_extractor) |
is_xml_model | |
serialize |
Retourne le json qui serait envoyé à Azure à partir de ce modèle. Il s’agit d’un alias pour as_dict(full_restapi_key_transformer, keep_readonly=False). Si vous souhaitez la sérialisation XML, vous pouvez passer les kwargs is_xml=True. |
validate |
Validez ce modèle de manière récursive et retournez une liste de ValidationError. |
as_dict
Retourne un dict qui peut être JSONify à l’aide de json.dump.
L’utilisation avancée peut éventuellement utiliser un rappel comme paramètre :
La clé est le nom d’attribut utilisé dans Python. Attr_desc est une dictée de métadonnées. Contient actuellement « type » avec le type msrest et « key » avec la clé encodée RestAPI. Value est la valeur actuelle de cet objet.
La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, il est considéré comme un dict de résultat hiérarchique.
Consultez les trois exemples de ce fichier :
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
Si vous souhaitez la sérialisation XML, vous pouvez passer les kwargs is_xml=True.
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)
Paramètres
- key_transformer
- <xref:function>
Fonction de transformateur de clé.
- keep_readonly
Retours
Objet compatible JSON dict
Type de retour
deserialize
Analysez une str à l’aide de la syntaxe RestAPI et retournez un modèle.
deserialize(data, content_type=None)
Paramètres
Retours
Une instance de ce modèle
Exceptions
enable_additional_properties_sending
enable_additional_properties_sending()
from_dict
Analyser une dict à l’aide de l’extracteur de clé donné retourne un modèle.
Par défaut, considérez les extracteurs de clés (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor et last_rest_key_case_insensitive_extractor)
from_dict(data, key_extractors=None, content_type=None)
Paramètres
- key_extractors
Retours
Une instance de ce modèle
Exceptions
is_xml_model
is_xml_model()
serialize
Retourne le json qui serait envoyé à Azure à partir de ce modèle.
Il s’agit d’un alias pour as_dict(full_restapi_key_transformer, keep_readonly=False).
Si vous souhaitez la sérialisation XML, vous pouvez passer les kwargs is_xml=True.
serialize(keep_readonly=False, **kwargs)
Paramètres
Retours
Objet compatible JSON dict
Type de retour
validate
Validez ce modèle de manière récursive et retournez une liste de ValidationError.
validate()
Retours
Liste des erreurs de validation
Type de retour
Azure SDK for Python