次の方法で共有

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

デバイス ID の状態の理由を格納する 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 を返します。

高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。

キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。

返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果のディクトと見なされます。

このファイルの 3 つの例を参照してください。

  • 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 できる dict を返します。

高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。

キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。

返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果のディクトと見なされます。

このファイルの 3 つの例を参照してください。

  • 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

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

readonly 属性をシリアル化する場合

戻り値

dict JSON 互換オブジェクト

の戻り値の型 :

dict

validate

このモデルを再帰的に検証し、ValidationError の一覧を返します。

validate()

戻り値

検証エラーの一覧

の戻り値の型 :

list