ExportImportDevice Classe

  • Riferimento

ExportImportDevice.

Ereditarietà
Model
ExportImportDevice

Costruttore

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)

Parametri

id
str
Necessario

Identificatore univoco del dispositivo.

module_id
str
Necessario

Identificatore univoco del modulo, se applicabile.

e_tag
str
Necessario

Stringa che rappresenta un ETag debole per il dispositivo RFC7232. Il valore viene usato solo se la modalità di importazione è updateIfMatchETag, in tal caso l'operazione di importazione viene eseguita solo se questo ETag corrisponde al valore gestito dal server.

import_mode
str oppure <xref:protocol.models.enum>
Necessario

Tipo di operazione del Registro di sistema e preferenze ETag. I valori possibili includono: 'create', 'update', 'updateIfMatchETag', 'delete', 'deleteIfMatchETag', 'updateTwin', 'updateTwinIfMatchETag'

status
str oppure <xref:protocol.models.enum>
Necessario

Stato del modulo. Se disabilitato, il modulo non può connettersi al servizio. I valori possibili includono: 'enabled', 'disabled'

status_reason
str
Necessario

Stringa lunga 128 caratteri che archivia il motivo dello stato dell'identità del dispositivo. Sono consentiti tutti i caratteri UTF-8.

authentication
AuthenticationMechanism
Necessario

Meccanismo di autenticazione usato dal modulo. Questo parametro è facoltativo e il valore predefinito è SAS se non specificato. In tal caso, le chiavi di accesso primarie/secondarie vengono generate automaticamente.

twin_etag
str
Necessario

Stringa che rappresenta un ETag debole per il dispositivo gemello RFC7232. Il valore viene usato solo se la modalità di importazione è updateIfMatchETag, in tal caso l'operazione di importazione viene eseguita solo se questo ETag corrisponde al valore gestito dal server.

tags
dict[str, object]
Necessario

Il documento JSON legge e scrive il back-end della soluzione. I tag non sono visibili alle app del dispositivo.

properties
PropertyContainer
Necessario

Proprietà desiderate e segnalate per il dispositivo.

capabilities
DeviceCapabilities
Necessario

Stato delle funzionalità abilitate nel dispositivo.

device_scope
str
Necessario

Ambito del dispositivo.

parent_scopes
list[str]
Necessario

Ambiti dei dispositivi perimetrali di livello superiore, se applicabile. Disponibile solo per i dispositivi perimetrali.

Metodi

as_dict

Restituire un dict che può essere JSONify usando json.dump.

L'utilizzo avanzato può facoltativamente usare un callback come parametro:

Key è il nome dell'attributo usato in Python. Attr_desc è un dict di metadati. Attualmente contiene 'type' con il tipo msrest e 'key' con la chiave con codifica RestAPI. Value è il valore corrente in questo oggetto.

La stringa restituita verrà utilizzata per serializzare la chiave. Se il tipo restituito è un elenco, si tratta di un risultato gerarchico dict.

Vedere i tre esempi in questo file:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se si desidera la serializzazione XML, è possibile passare i kwargs is_xml=True.
deserialize

Analizzare uno str usando la sintassi RestAPI e restituire un modello.
enable_additional_properties_sending
from_dict

Analizzare un dict usando un estrattore di chiave specificato restituisce un modello.

Per impostazione predefinita, considerare gli estrattori di chiave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)
is_xml_model
serialize

Restituire il codice JSON che verrebbe inviato ad Azure da questo modello.

Si tratta di un alias per as_dict(full_restapi_key_transformer, keep_readonly=False).

Se si desidera la serializzazione XML, è possibile passare i kwargs is_xml=True.
validate

Convalidare questo modello in modo ricorsivo e restituire un elenco di ValidationError.

as_dict

Restituire un dict che può essere JSONify usando json.dump.

L'utilizzo avanzato può facoltativamente usare un callback come parametro:

Key è il nome dell'attributo usato in Python. Attr_desc è un dict di metadati. Attualmente contiene 'type' con il tipo msrest e 'key' con la chiave con codifica RestAPI. Value è il valore corrente in questo oggetto.

La stringa restituita verrà utilizzata per serializzare la chiave. Se il tipo restituito è un elenco, si tratta di un risultato gerarchico dict.

Vedere i tre esempi in questo file:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se si desidera la serializzazione XML, è possibile passare i kwargs is_xml=True.

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

Parametri

key_transformer
<xref:function>

Funzione di trasformatore di tasti.

keep_readonly
valore predefinito: True

Restituisce

Oggetto compatibile con JSON dict

Tipo restituito

dict

deserialize

Analizzare uno str usando la sintassi RestAPI e restituire un modello.

deserialize(data, content_type=None)

Parametri

data
str
Necessario

Str che usa la struttura RestAPI. JSON per impostazione predefinita.

content_type
str
valore predefinito: None

JSON per impostazione predefinita, impostare application/xml se XML.

Restituisce

Istanza di questo modello

Eccezioni

DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending()

from_dict

Analizzare un dict usando un estrattore di chiave specificato restituisce un modello.

Per impostazione predefinita, considerare gli estrattori di chiave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)

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

Parametri

data
dict
Necessario

Oggetto dict using RestAPI structure (Struttura RESTAPI)

content_type
str
valore predefinito: None

JSON per impostazione predefinita, impostare application/xml se XML.

key_extractors
valore predefinito: None

Restituisce

Istanza di questo modello

Eccezioni

DeserializationError if something went wrong

is_xml_model 

is_xml_model()

serialize

Restituire il codice JSON che verrebbe inviato ad Azure da questo modello.

Si tratta di un alias per as_dict(full_restapi_key_transformer, keep_readonly=False).

Se si desidera la serializzazione XML, è possibile passare i kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parametri

keep_readonly
bool
valore predefinito: False

Se si desidera serializzare gli attributi readonly

Restituisce

Oggetto compatibile con JSON dict

Tipo restituito

dict

validate

Convalidare questo modello in modo ricorsivo e restituire un elenco di ValidationError.

validate()

Restituisce

Elenco di errori di convalida

Tipo restituito

list