Поделиться через

ExportImportDevice Класс

  • Ссылка

ExportImportDevice.

Наследование
Model
ExportImportDevice

Конструктор

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)

Параметры

id
str
Обязательно

Уникальный идентификатор устройства.

module_id
str
Обязательно

Уникальный идентификатор модуля, если применимо.

e_tag
str
Обязательно

Строка, представляющая слабый ETag для устройства RFC7232. Значение используется только в том случае, если режим импорта — updateIfMatchETag. В этом случае операция импорта выполняется только в том случае, если этот ETag соответствует значению, поддерживаемму сервером.

import_mode
str или <xref:protocol.models.enum>
Обязательно

Тип операции реестра и параметры ETag. Возможные значения: "create", "update", "updateIfMatchETag", "delete", "deleteIfMatchETag", "updateTwin", "updateTwinIfMatchETag".

status
str или <xref:protocol.models.enum>
Обязательно

Состояние модуля. Если он отключен, модуль не сможет подключиться к службе. Возможные значения: "enabled", "disabled"

status_reason
str
Обязательно

Строка длиной 128 символов, в которой хранится причина для состояния удостоверения устройства. Разрешены все символы UTF-8.

authentication
AuthenticationMechanism
Обязательно

Механизм проверки подлинности, используемый модулем. Этот параметр является необязательным и по умолчанию использует SAS, если он не указан. В этом случае первичный или вторичный ключи доступа создаются автоматически.

twin_etag
str
Обязательно

Строка, представляющая слабый ETag для двойника устройства RFC7232. Значение используется только в том случае, если режим импорта — updateIfMatchETag. В этом случае операция импорта выполняется только в том случае, если этот ETag соответствует значению, поддерживаемму сервером.

tags
dict[str, object]
Обязательно

Документ JSON, считываемый и записанный внутренней частью решения. Теги не видны приложениям устройств.

properties
PropertyContainer
Обязательно

Требуемые и сообщаемые свойства для устройства.

capabilities
DeviceCapabilities
Обязательно

Состояние возможностей, включенных на устройстве.

device_scope
str
Обязательно

Область действия устройства.

parent_scopes
list[str]
Обязательно

Области пограничных устройств верхнего уровня, если применимо. Доступно только для пограничных устройств.

Методы

as_dict

Возвращает диктовку, которая может иметь значение JSONify с помощью json.dump.

При дополнительном использовании можно использовать обратный вызов в качестве параметра:

Ключ — это имя атрибута, используемого в Python. Attr_desc — это диктовка метаданных. В настоящее время содержит тип с типом msrest и key с ключом в кодировке RestAPI. Значение — это текущее значение в этом объекте.

Возвращаемая строка будет использоваться для сериализации ключа. Если тип возвращаемого значения является списком, это считается иерархическим результирующим диктом.

См. три примера в этом файле:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Если требуется сериализация XML, можно передать kwargs is_xml=True.
deserialize

Выполните синтаксический анализ str с помощью синтаксиса RestAPI и верните модель.
enable_additional_properties_sending
from_dict

Синтаксический анализ диктовки с помощью заданного средства извлечения ключей возвращает модель.

По умолчанию рекомендуется использовать средства извлечения ключей (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor и last_rest_key_case_insensitive_extractor).
is_xml_model
serialize

Возвращает json, который будет отправлен в Azure из этой модели.

Это псевдоним для as_dict(full_restapi_key_transformer, keep_readonly=False).

Если требуется сериализация XML, можно передать kwargs is_xml=True.
validate

Рекурсивная проверка модели и возврат списка ValidationError.

as_dict

Возвращает диктовку, которая может иметь значение JSONify с помощью json.dump.

При дополнительном использовании можно использовать обратный вызов в качестве параметра:

Ключ — это имя атрибута, используемого в Python. Attr_desc — это диктовка метаданных. В настоящее время содержит тип с типом msrest и key с ключом в кодировке RestAPI. Значение — это текущее значение в этом объекте.

Возвращаемая строка будет использоваться для сериализации ключа. Если тип возвращаемого значения является списком, это считается иерархическим результирующим диктом.

См. три примера в этом файле:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Если требуется сериализация XML, можно передать kwargs is_xml=True.

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

Параметры

key_transformer
<xref:function>

Функция преобразователя ключей.

keep_readonly
значение по умолчанию: True

Возвращаемое значение

Объект, совместимый с JSON для диктовки

Возвращаемый тип

dict

deserialize

Выполните синтаксический анализ str с помощью синтаксиса RestAPI и верните модель.

deserialize(data, content_type=None)

Параметры

data
str
Обязательно

Str, использующий структуру RestAPI. JSON по умолчанию.

content_type
str
значение по умолчанию: None

JSON по умолчанию задайте значение application/xml, если XML.

Возвращаемое значение

Экземпляр этой модели

Исключения

DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending()

from_dict

Синтаксический анализ диктовки с помощью заданного средства извлечения ключей возвращает модель.

По умолчанию рекомендуется использовать средства извлечения ключей (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor и last_rest_key_case_insensitive_extractor).

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

Параметры

data
dict
Обязательно

Диктовка, использующий структуру RestAPI

content_type
str
значение по умолчанию: None

JSON по умолчанию задайте значение application/xml, если XML.

key_extractors
значение по умолчанию: None

Возвращаемое значение

Экземпляр этой модели

Исключения

DeserializationError if something went wrong

is_xml_model 

is_xml_model()

serialize

Возвращает json, который будет отправлен в Azure из этой модели.

Это псевдоним для as_dict(full_restapi_key_transformer, keep_readonly=False).

Если требуется сериализация XML, можно передать kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Параметры

keep_readonly
bool
значение по умолчанию: False

Если вы хотите сериализовать атрибуты только для чтения

Возвращаемое значение

Объект, совместимый с JSON для диктовки

Возвращаемый тип

dict

validate

Рекурсивная проверка модели и возврат списка ValidationError.

validate()

Возвращаемое значение

Список ошибок проверки

Возвращаемый тип

list