Twin クラス
デバイスまたはモジュールの状態情報。 これは、対応するデバイス/モジュール ID がIoT Hubで作成または削除されると、暗黙的に作成および削除されます。
- 継承
-
Twin
コンストラクター
Twin(**kwargs)パラメーター
- device_id
- str
IoT Hubの ID レジストリ内のデバイスの一意識別子。 ASCII 7 ビット英数字文字の大文字と小文字を区別する文字列 (最大 128 文字)、次の特殊文字 {'-'、':'、'.'、'+'、'%'、'_'、'#'、'*'、'?'、'!'、'('、')'、'、'='、'@'、';'、'$'、''} です。
- module_id
- str
IoT Hubの ID レジストリ内のモジュールの一意識別子。 ASCII 7 ビット英数字文字の大文字と小文字を区別する文字列 (最大 128 文字)、次の特殊文字 {'-'、':'、'.'、'+'、'%'、'_'、'#'、'*'、'?'、'!'、'('、')'、'、'='、'@'、';'、'$'、''} です。
ソリューション バックエンドによって読み書きされるキーと値のペアのコレクション。 デバイス アプリには表示されません。 これらのキーは UTF-8 でエンコードされ、大文字と小文字が区別され、最大 1 KB の長さです。 使用できる文字は、UNICODE 制御文字 (セグメント C0 および C1)、'.'、'$'、およびスペースを除外します。 値は JSON オブジェクトで、最大 4 KB の長さです。
- version
- <xref:long>
タグと必要なプロパティを含むデバイス ツインのバージョン
- status
- str または <xref:protocol.models.enum>
デバイスの有効な状態。 無効にした場合、デバイスはサービスに接続できません。 使用可能な値は次のとおりです: 'enabled'、'disabled'
- connection_state
- str または <xref:protocol.models.enum>
デバイスの接続状態。 使用可能な値には、'Disconnected'、'Connected' などがあります。
- last_activity_time
- datetime
デバイスが最後に接続されたか、メッセージを受信または送信した日時。 日付と時刻は、ISO8601 datetime 形式 (UTC) で区切られ、たとえば 2015-01-28T16:24:48.789Z になります。 デバイスが HTTP/1 プロトコルを使用してメッセージング操作を実行する場合、この値は更新されません。
- authentication_type
- str または <xref:protocol.models.enum>
デバイスで使用される認証の種類。 使用できる値は、'sas'、'selfSigned'、'certificateAuthority'、'none' です。
- capabilities
- DeviceCapabilities
メソッド
| as_dict |
json.dump を使用して JSONify できる dict を返します。 高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。 キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。 返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果 dict と見なされます。 このファイルの 3 つの例を参照してください。
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' が含まれています。 値は、このオブジェクトの現在の値です。
返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果 dict と見なされます。
このファイルの 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
戻り値
dict JSON 互換オブジェクト
の戻り値の型 :
deserialize
RestAPI 構文を使用して str を解析し、モデルを返します。
deserialize(data, content_type=None)パラメーター
戻り値
このモデルのインスタンス
例外
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)パラメーター
- key_extractors
戻り値
このモデルのインスタンス
例外
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)パラメーター
戻り値
dict JSON 互換オブジェクト
の戻り値の型 :
validate
Azure SDK for Python