通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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
必需

表示设备 RFC7232 的弱 ETag 的字符串。 仅当导入模式为 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
必需

表示设备孪生 RFC7232 的弱 ETag 的字符串。 仅当导入模式为 updateIfMatchETag 时才使用值，在这种情况下，仅当此 ETag 与服务器维护的值匹配时，才会执行导入操作。

tags
dict[str, object]
必需

由解决方案后端读取和写入的 JSON 文档。 这些标记对设备应用不可见。

properties
PropertyContainer
必需

设备的所需属性和报告属性。

capabilities
DeviceCapabilities
必需

设备上启用的功能的状态。

device_scope
str
必需

设备的范围。

parent_scopes
list[str]
必需

上层边缘设备的范围（如果适用）。 仅适用于边缘设备。

方法

as_dict

返回可以使用 json.dump 的 JSONify 的 dict。

高级用法可以选择使用回调作为参数：

Key 是 Python 中使用的属性名称。 Attr_desc是元数据的一个听写。 当前包含具有 msrest 类型的“type”和包含 RestAPI 编码键的“key”。 值是此对象中的当前值。

返回的字符串将用于序列化密钥。 如果返回类型是列表，则这被视为分层结果听写。

请参阅此文件中的三个示例：

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

如果需要 XML 序列化，可以传递 kwargs is_xml=True。
deserialize

使用 RestAPI 语法分析 str 并返回模型。
enable_additional_properties_sending
from_dict

使用给定的键提取程序分析 dict 返回一个模型。

默认情况下，请考虑密钥提取程序 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor和last_rest_key_case_insensitive_extractor)

is_xml_model
serialize

返回将从此模型发送到 azure 的 JSON。

这是as_dict (full_restapi_key_transformer的别名 ，keep_readonly=False) 。

如果需要 XML 序列化，可以传递 kwargs is_xml=True。
validate

以递归方式验证此模型，并返回 ValidationError 列表。

as_dict

返回可以使用 json.dump 的 JSONify 的 dict。

高级用法可以选择使用回调作为参数：

Key 是 Python 中使用的属性名称。 Attr_desc是元数据的一个听写。 当前包含具有 msrest 类型的“type”和包含 RestAPI 编码键的“key”。 值是此对象中的当前值。

返回的字符串将用于序列化密钥。 如果返回类型是列表，则这被视为分层结果听写。

请参阅此文件中的三个示例：

  • 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

返回

与 dict JSON 兼容的对象

返回类型

dict

deserialize

使用 RestAPI 语法分析 str 并返回模型。

deserialize(data, content_type=None)

参数

data
str
必需

使用 RestAPI 结构的 str。 默认情况下为 JSON。

content_type
str
默认值: None

默认情况下，如果 XML，则设置 application/xml。

返回

此模型的实例

例外

DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending()

from_dict

使用给定的键提取程序分析 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 结构的 dict

content_type
str
默认值: None

默认情况下，如果 XML，则设置 application/xml。

key_extractors
默认值: None

返回

此模型的实例

例外

DeserializationError if something went wrong

is_xml_model 

is_xml_model()

serialize

返回将从此模型发送到 azure 的 JSON。

这是as_dict (full_restapi_key_transformer的别名 ，keep_readonly=False) 。

如果需要 XML 序列化，可以传递 kwargs is_xml=True。

serialize(keep_readonly=False, **kwargs)

参数

keep_readonly
bool
默认值: False

如果要序列化只读属性

返回

与 dict JSON 兼容的对象

返回类型

dict

validate

以递归方式验证此模型，并返回 ValidationError 列表。

validate()

返回

验证错误列表

返回类型

list