ExportImportDevice Classe

ExportImportDevice.

Héritage

Model

ExportImportDevice

Constructeur

ExportImportDevice(*, id: str = None, module_id: str = None, e_tag: str = None, import_mode=None, status=None, status_reason: str = None, authentication=None, twin_etag: str = None, tags=None, properties=None, capabilities=None, device_scope: str = None, parent_scopes=None, **kwargs)

Paramètres

id

str

Obligatoire

Identificateur unique de l’appareil.

module_id

str

Obligatoire

Identificateur unique du module, le cas échéant.

e_tag

str

Obligatoire

Chaîne représentant un ETag faible pour l’appareil RFC7232. La valeur est utilisée uniquement si le mode d’importation est updateIfMatchETag. Dans ce cas, l’opération d’importation est effectuée uniquement si cet ETag correspond à la valeur gérée par le serveur.

import_mode

str ou <xref:protocol.models.enum>

Obligatoire

Type d’opération de registre et préférences ETag. Les valeurs possibles sont les suivantes : « create », « update », « updateIfMatchETag », « delete », « deleteIfMatchETag », « updateTwin », « updateTwin », « updateTwinIfMatchETag »

status

str ou <xref:protocol.models.enum>

Obligatoire

Status du module. S’il est désactivé, le module ne peut pas se connecter au service. Les valeurs possibles sont les suivantes : « enabled », « disabled »

status_reason

str

Obligatoire

Chaîne de 128 caractères qui stocke la raison de l’identité de l’appareil status. Tous les caractères UTF-8 sont autorisés.

authentication

AuthenticationMechanism

Obligatoire

Mécanisme d’authentification utilisé par le module. Ce paramètre est facultatif et est défini par défaut sur SAP s’il n’est pas fourni. Dans ce cas, les clés d’accès primaires/secondaires sont générées automatiquement.

twin_etag

str

Obligatoire

Chaîne représentant un ETag faible pour le jumeau d’appareil RFC7232. La valeur est utilisée uniquement si le mode d’importation est updateIfMatchETag. Dans ce cas, l’opération d’importation est effectuée uniquement si cet ETag correspond à la valeur gérée par le serveur.

tags

dict[str, object]

Obligatoire

Document JSON lu et écrit par le back-end de la solution. Les étiquettes ne sont pas visibles pour les applications d’appareil.

properties

PropertyContainer

Obligatoire

Propriétés souhaitées et signalées pour l’appareil.

capabilities

DeviceCapabilities

Obligatoire

Status des fonctionnalités activées sur l’appareil.

device_scope

str

Obligatoire

Portée de l’appareil.

parent_scopes

list[str]

Obligatoire

Étendues des périphériques de niveau supérieur, le cas échéant. Disponible uniquement pour les appareils de périphérie.

Méthodes

as_dict	Retourne un dictée 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 un 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 dans cet objet. La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, cela 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 une sérialisation XML, vous pouvez passer les kwargs is_xml=True.
deserialize	Analysez un str à l’aide de la syntaxe RestAPI et retournez un modèle.
enable_additional_properties_sending
from_dict	L’analyse d’un 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 une 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ée 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 un 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 dans cet objet.

La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, cela 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 une 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

valeur par défaut: True

Retours

Objet compatible JSON de dict

Type de retour

dict

deserialize

Analysez un str à l’aide de la syntaxe RestAPI et retournez un modèle.

deserialize(data, content_type=None)

Paramètres

data

str

Obligatoire

Str utilisant la structure RestAPI. JSON par défaut.

content_type

str

valeur par défaut: None

JSON par défaut, définissez application/xml si XML.

Retours

Une instance de ce modèle

Exceptions

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

L’analyse d’un 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

data

dict

Obligatoire

Dict utilisant la structure RestAPI

content_type

str

valeur par défaut: None

JSON par défaut, définissez application/xml si XML.

key_extractors

valeur par défaut: None

Retours

Une instance de ce modèle

Exceptions

DeserializationError if something went wrong

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 une sérialisation XML, vous pouvez passer les kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Paramètres

keep_readonly

bool

valeur par défaut: False

Si vous souhaitez sérialiser les attributs readonly

Retours

Objet compatible JSON de dict

Type de retour

dict

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

list