共用方式為

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'、'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 的聽寫。

進階用法可以選擇性地使用回呼作為參數：

索引鍵是 Python 中使用的屬性名稱。 Attr_desc是中繼資料的聽寫。 目前包含具有 msrest 類型的 'type'，以及具有 RestAPI 編碼金鑰的 'key'。 Value 是這個 物件中的目前值。

傳回的字串將用來序列化索引鍵。 如果傳回類型是清單，則會將此視為階層式結果聽寫。

請參閱此檔案中的三個範例：

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

如果您想要 XML 序列化，您可以傳遞 kwargs is_xml=True。
deserialize

使用 RestAPI 語法剖析 str 並傳回模型。
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

傳回會從此模型傳送至 Azure 的 JSON。

這是 as_dict (full_restapi_key_transformer別名，keep_readonly=False) 。

如果您想要 XML 序列化，您可以傳遞 kwargs is_xml=True。
validate

以遞迴方式驗證此模型，並傳回 ValidationError 的清單。

as_dict

使用 json.dump 傳回可以是 JSONify 的聽寫。

進階用法可以選擇性地使用回呼作為參數：

索引鍵是 Python 中使用的屬性名稱。 Attr_desc是中繼資料的聽寫。 目前包含具有 msrest 類型的 'type'，以及具有 RestAPI 編碼金鑰的 'key'。 Value 是這個 物件中的目前值。

傳回的字串將用來序列化索引鍵。 如果傳回類型是清單，則會將此視為階層式結果聽寫。

請參閱此檔案中的三個範例：

  • 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

使用 RestAPI 語法剖析 str 並傳回模型。

deserialize(data, content_type=None)

參數

data
str
必要

使用 RestAPI 結構的 str。 JSON 預設為 。

content_type
str
預設值: None

JSON 預設會設定 application/xml if 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 if 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

如果您想要序列化唯讀屬性

傳回

與聽寫 JSON 相容的物件

傳回類型

dict

validate

以遞迴方式驗證此模型，並傳回 ValidationError 的清單。

validate()

傳回

驗證錯誤清單

傳回類型

list