次の方法で共有


IoTHubDeviceClient クラス

Azure IoT Hub インスタンスに接続する同期デバイス クライアント。

IoTHubDeviceClient の初期化子。

この初期化子を直接呼び出さないでください。 代わりに、'>>create_from_<<' クラスメソッドのいずれかを使用してインスタンス化します

継承
azure.iot.device.iothub.sync_clients.GenericIoTHubClient
IoTHubDeviceClient
azure.iot.device.iothub.abstract_clients.AbstractIoTHubDeviceClient
IoTHubDeviceClient

コンストラクター

IoTHubDeviceClient(mqtt_pipeline, http_pipeline)

パラメーター

mqtt_pipeline
<xref:azure.iot.device.iothub.pipeline.MQTTPipeline>
必須

IoTHub エンドポイントへの接続に使用されるパイプライン。

http_pipeline
必須

メソッド

connect

クライアントをAzure IoT Hubまたは Azure IoT Edge Hub インスタンスに接続します。

宛先は、このオブジェクトの初期化時に指定されたauth_provider パラメーターを介して渡された資格情報に基づいて選択されます。

これは同期呼び出しです。つまり、サービスへの接続が完全に確立されるまで、この関数は戻りません。

create_from_connection_string

IoTHub デバイスまたはモジュール接続文字列からクライアントをインスタンス化します。

create_from_sastoken

事前に作成された SAS トークン文字列からクライアントをインスタンス化する

create_from_symmetric_key

対称キー認証を使用してクライアントをインスタンス化します。

create_from_x509_certificate

X509 証明書認証を使用してクライアントをインスタンス化します。

disconnect

Azure IoT Hubまたは Azure IoT Edge Hub インスタンスからクライアントを切断します。

クライアント インスタンスが完全に完了したら、必ずこの関数を呼び出すようにすることをお勧めします。

これは同期呼び出しです。つまり、サービスへの接続が完全に閉じられるまで、この関数は戻りません。

get_storage_info_for_blob

HTTP 経由で POST 要求を IoTHub エンドポイントに送信します。このエンドポイントは、デバイスが接続されている IoTHub にリンクされている Azure Storage アカウントを介してアップロードするための情報を返します。

get_twin

Azure IoT Hubまたは Azure IoT Edge Hub サービスからデバイスまたはモジュール ツインを取得します。

これは同期呼び出しです。つまり、ツインがサービスから取得されるまで、この関数は戻りません。

notify_blob_upload_status

アップロードが完了すると、デバイスは BLOB へのアップロードの試行の状態に関する情報を含む POST 要求を IoT Hub エンドポイントに送信します。 これは、リッスンしているクライアントに通知するためにIoT Hubによって使用されます。

patch_twin_reported_properties

報告されたプロパティをAzure IoT Hubまたは Azure IoT Edge Hub サービスで更新します。

これは同期呼び出しです。つまり、パッチがサービスに送信されて確認されるまで、この関数は戻りません。

サービスがパッチ操作でエラーを返した場合、この関数は適切なエラーを発生させます。

receive_message

Azure IoT Hubから送信されたメッセージを受信します。

バージョン 2.3.0 以降非推奨: 代わりに .on_message_received プロパティを使用してハンドラーを設定することをお勧めします

receive_method_request

Azure IoT Hubまたは Azure IoT Edge Hub 経由でメソッド要求を受け取ります。

バージョン 2.3.0 以降非推奨: 代わりに .on_method_request_received プロパティを使用してハンドラーを設定することをお勧めします

receive_twin_desired_properties_patch

Azure IoT Hubまたは Azure IoT Edge Hub 経由で目的のプロパティパッチを受け取ります。

これは同期呼び出しであり、次のことを意味します。

  1. block=True の場合、この関数は次のいずれかが発生するまでブロックします。

    • Azure IoT Hubまたは Azure IoT Edge Hub から目的のプロパティパッチを受け取ります。

    • タイムアウト期間 (指定されている場合) が経過します。 タイムアウトが発生した場合、この関数は InboxEmpty 例外を発生させます

  2. block=False の場合、この関数は、パイプラインによって受信された可能性があるが、まだアプリケーションに返されていない必要なプロパティパッチを返します。 パイプラインで必要なプロパティパッチが受信されていない場合、この関数は InboxEmpty 例外を発生させます

バージョン 2.3.0 以降非推奨: 代わりに .on_twin_desired_properties_patch_received プロパティを使用してハンドラーを設定することをお勧めします

send_message

Azure IoT Hub または Azure IoT Edge Hub インスタンスの既定のイベント エンドポイントにメッセージを送信します。

これは同期イベントです。つまり、イベントがサービスに送信され、サービスがイベントの受信を確認するまで、この関数は戻りません。

接続する呼び出しによってサービスへの接続が以前に開かっていない場合、この関数はイベントを送信する前に接続を開きます。

send_method_response

Azure IoT Hubまたは Azure IoT Edge Hub 経由でメソッド要求に応答を送信します。

これは同期イベントです。つまり、イベントがサービスに送信され、サービスがイベントの受信を確認するまで、この関数は戻りません。

接続する呼び出しによってサービスへの接続が以前に開かっていない場合、この関数はイベントを送信する前に接続を開きます。

shutdown

正常終了のためにクライアントをシャットダウンします。

このメソッドが呼び出されると、以降のクライアント呼び出しで試行されると、ClientError が発生します

update_sastoken

認証に使用するクライアントの SAS トークンを更新し、接続を再認証します。

この API は、クライアントが最初に SAS トークンを使用して作成された場合にのみ使用できます。

connect

クライアントをAzure IoT Hubまたは Azure IoT Edge Hub インスタンスに接続します。

宛先は、このオブジェクトの初期化時に指定されたauth_provider パラメーターを介して渡された資格情報に基づいて選択されます。

これは同期呼び出しです。つまり、サービスへの接続が完全に確立されるまで、この関数は戻りません。

connect()

例外

資格情報が無効で、接続を確立できない場合は 。

接続を確立するとエラーが発生する場合は 。

実行中に接続が失われた場合は 。

接続がタイムアウトした場合は 。

実行中に予期しないエラーが発生した場合は 。

create_from_connection_string

IoTHub デバイスまたはモジュール接続文字列からクライアントをインスタンス化します。

create_from_connection_string(connection_string, **kwargs)

パラメーター

connection_string
str
必須

接続する IoTHub の接続文字列。

server_verification_cert
str
必須

構成オプション。 信頼された証明書チェーン。 プロトコル ゲートウェイなど、非標準の信頼ルートを持つエンドポイントへの接続を使用する場合に必要です。

websockets
bool
必須

構成オプション。 既定値は False です。 websocket で MQTT を使用する場合は true に設定します。

cipher
str または list(str)
必須

構成オプション。 TLS/SSL の暗号スイート。"OpenSSL 暗号リスト形式" の文字列として、または暗号スイート文字列の一覧として使用します。

product_info
str
必須

構成オプション。 既定値は空の文字列です。 文字列には、ユーザー エージェント文字列に追加される任意の製品情報が含まれています。

proxy_options
ProxyOptions
必須

プロキシ サーバー経由でトラフィックを送信するためのオプション。

sastoken_ttl
int
必須

認証に使用される作成された SasToken の有効期間 (秒単位)。 既定値は 3,600 秒 (1 時間) です。

keep_alive
int
必須

ブローカーとの通信間の最大期間 (秒単位)。 他のメッセージが交換されていない場合は、クライアントがブローカーに ping メッセージを送信する速度を制御します。 指定しない場合は、既定値の 60 秒が使用されます。

auto_connect
bool
必須

接続を確立する必要があるメソッドが呼び出されたときに、クライアントを IoTHub に自動的に接続します。 (既定値 : True)

connection_retry
bool
必須

切断された接続の再確立を試みます (既定値: True)

connection_retry_interval
int
必須

切断された接続の再確立の試行間隔 (秒単位) (既定値: 10)

ensure_desired_properties
bool
必須

再接続時に最新の必要なプロパティパッチが受信されていることを確認します (Default:True)

戻り値

認証に接続文字列を使用する IoTHub クライアントのインスタンス。

例外

ValueError if given an invalid connection_string.
TypeError if given an unsupported parameter.

create_from_sastoken

事前に作成された SAS トークン文字列からクライアントをインスタンス化する

create_from_sastoken(sastoken, **kwargs)

パラメーター

sastoken
str
必須

SAS トークン文字列

server_verification_cert
str
必須

構成オプション。 信頼された証明書チェーン。 プロトコル ゲートウェイなど、非標準の信頼ルートを持つエンドポイントへの接続を使用する場合に必要です。

gateway_hostname
str
必須

構成オプション。 ゲートウェイ デバイスのゲートウェイ ホスト名。

websockets
bool
必須

構成オプション。 既定値は False です。 websocket で MQTT を使用する場合は true に設定します。

cipher
str または list(str)
必須

構成オプション。 TLS/SSL の暗号スイート。"OpenSSL 暗号リスト形式" の文字列として、または暗号スイート文字列の一覧として使用します。

product_info
str
必須

構成オプション。 既定値は空の文字列です。 文字列には、ユーザー エージェント文字列に追加される任意の製品情報が含まれています。

proxy_options
ProxyOptions
必須

プロキシ サーバー経由でトラフィックを送信するためのオプション。

keep_alive
int
必須

ブローカーとの通信間の最大期間 (秒単位)。 他のメッセージが交換されていない場合は、クライアントがブローカーに ping メッセージを送信する速度を制御します。 指定しない場合は、既定値の 60 秒が使用されます。

auto_connect
bool
必須

接続を確立する必要があるメソッドが呼び出されたときに、クライアントを IoTHub に自動的に接続します。 (既定値 : True)

connection_retry
bool
必須

切断された接続の再確立を試みます (既定値: True)

connection_retry_interval
int
必須

切断された接続の再確立の試行間隔 (秒単位) (既定値: 10)

ensure_desired_properties
bool
必須

再接続時に最新の必要なプロパティパッチが受信されていることを確認します (Default:True)

例外

TypeError if given an unsupported parameter.
ValueError if the sastoken parameter is invalid.

create_from_symmetric_key

対称キー認証を使用してクライアントをインスタンス化します。

create_from_symmetric_key(symmetric_key, hostname, device_id, **kwargs)

パラメーター

symmetric_key
必須

対称キー。

hostname
str
必須

IotHub を実行しているホスト。 Azure portalの [概要] タブで、文字列のホスト名として確認できます。

device_id
必須

デバイス ID

server_verification_cert
str
必須

構成オプション。 信頼された証明書チェーン。 プロトコル ゲートウェイなど、非標準の信頼ルートを持つエンドポイントへの接続を使用する場合に必要です。

gateway_hostname
str
必須

構成オプション。 ゲートウェイ デバイスのゲートウェイ ホスト名。

websockets
bool
必須

構成オプション。 既定値は False です。 websocket で MQTT を使用する場合は true に設定します。

cipher
str または list(str)
必須

構成オプション。 TLS/SSL の暗号スイート。"OpenSSL 暗号リスト形式" の文字列として、または暗号スイート文字列の一覧として使用します。

product_info
str
必須

構成オプション。 既定値は空の文字列です。 文字列には、ユーザー エージェント文字列に追加される任意の製品情報が含まれています。

proxy_options
ProxyOptions
必須

プロキシ サーバー経由でトラフィックを送信するためのオプション。

sastoken_ttl
int
必須

認証に使用される作成された SasToken の有効期間 (秒単位)。 既定値は 3600 秒 (1 時間) です

keep_alive
int
必須

ブローカーとの通信間の最大期間 (秒単位)。 他のメッセージが交換されていない場合は、クライアントがブローカーに ping メッセージを送信する速度を制御します。 指定しない場合は、既定値の 60 秒が使用されます。

auto_connect
bool
必須

接続を確立する必要があるメソッドが呼び出されたときに、クライアントを IoTHub に自動的に接続します。 (既定値 : True)

connection_retry
bool
必須

切断された接続の再確立を試みます (既定値: True)

connection_retry_interval
int
必須

切断された接続の再確立の試行間隔 (秒単位) (既定値: 10)

ensure_desired_properties
bool
必須

再接続時に最新の必要なプロパティパッチが受信されていることを確認します (Default:True)

戻り値

認証に対称キーを使用する IoTHub クライアントのインスタンス。

例外

TypeError if given an unsupported parameter.
ValueError if the provided parameters are invalid.

create_from_x509_certificate

X509 証明書認証を使用してクライアントをインスタンス化します。

create_from_x509_certificate(x509, hostname, device_id, **kwargs)

パラメーター

hostname
str
必須

IotHub を実行しているホスト。 Azure portalの [概要] タブで、文字列のホスト名として確認できます。

x509
X509
必須

完全な x509 証明書オブジェクト。 証明書を使用するには、登録オブジェクトに証明書 (ルート証明書または中間 CA 証明書のいずれか) が含まれている必要があります。 証明書が CER ファイルから取得される場合は、base64 エンコードされている必要があります。

device_id
str
必須

IoTHub でデバイスを一意に識別するために使用される ID

server_verification_cert
str
必須

構成オプション。 信頼された証明書チェーン。 プロトコル ゲートウェイなど、非標準の信頼ルートを持つエンドポイントへの接続を使用する場合に必要です。

gateway_hostname
str
必須

構成オプション。 ゲートウェイ デバイスのゲートウェイ ホスト名。

websockets
bool
必須

構成オプション。 既定値は False です。 websocket で MQTT を使用する場合は true に設定します。

cipher
str または list(str)
必須

構成オプション。 TLS/SSL の暗号スイート。"OpenSSL 暗号リスト形式" の文字列として、または暗号スイート文字列の一覧として使用します。

product_info
str
必須

構成オプション。 既定値は空の文字列です。 文字列には、ユーザー エージェント文字列に追加される任意の製品情報が含まれています。

proxy_options
ProxyOptions
必須

プロキシ サーバー経由でトラフィックを送信するためのオプション。

keep_alive
int
必須

ブローカーとの通信間の最大期間 (秒単位)。 他のメッセージが交換されていない場合は、クライアントがブローカーに ping メッセージを送信する速度を制御します。 指定しない場合は、既定値の 60 秒が使用されます。

auto_connect
bool
必須

接続を確立する必要があるメソッドが呼び出されたときに、クライアントを IoTHub に自動的に接続します。 (既定値 : True)

connection_retry
bool
必須

切断された接続の再確立を試みます (既定値: True)

connection_retry_interval
int
必須

切断された接続の再確立の試行間隔 (秒単位) (既定値: 10)

ensure_desired_properties
bool
必須

再接続時に最新の必要なプロパティパッチが受信されていることを確認します (Default:True)

戻り値

認証に X509 証明書を使用する IoTHub クライアントのインスタンス。

例外

TypeError if given an unsupported parameter.

disconnect

Azure IoT Hubまたは Azure IoT Edge Hub インスタンスからクライアントを切断します。

クライアント インスタンスが完全に完了したら、必ずこの関数を呼び出すようにすることをお勧めします。

これは同期呼び出しです。つまり、サービスへの接続が完全に閉じられるまで、この関数は戻りません。

disconnect()

例外

実行中に予期しないエラーが発生した場合は 。

get_storage_info_for_blob

HTTP 経由で POST 要求を IoTHub エンドポイントに送信します。このエンドポイントは、デバイスが接続されている IoTHub にリンクされている Azure Storage アカウントを介してアップロードするための情報を返します。

get_storage_info_for_blob(blob_name)

パラメーター

blob_name
str
必須

ストレージ API を使用してアップロードされる BLOB の文字列形式の名前。 この名前は Storage の適切な資格情報を生成するために使用され、BLOB のアップロードを実行するために Azure Storage SDK で使用されるものと一致する必要があります。

戻り値

correlationId、hostName、containerName、blobName、sasToken などの関連情報を含む、IoT Hubの JSON に似た (ディクショナリ) オブジェクト。

例外

資格情報が無効で、接続を確立できない場合は 。

接続を確立するとエラーが発生する場合は 。

実行中に接続が失われた場合は 。

接続がタイムアウトした場合は 。

実行中に予期しないエラーが発生した場合は 。

get_twin

Azure IoT Hubまたは Azure IoT Edge Hub サービスからデバイスまたはモジュール ツインを取得します。

これは同期呼び出しです。つまり、ツインがサービスから取得されるまで、この関数は戻りません。

get_twin()

戻り値

JSON ディクテーションとしての完全なツイン

の戻り値の型 :

例外

資格情報が無効で、接続を確立できない場合は 。

接続を確立するとエラーが発生する場合は 。

実行中に接続が失われた場合は 。

接続試行がタイムアウトした場合

クライアントが接続されていない場合 (自動接続が有効になっていません)

実行中に予期しないエラーが発生した場合は 。

notify_blob_upload_status

アップロードが完了すると、デバイスは BLOB へのアップロードの試行の状態に関する情報を含む POST 要求を IoT Hub エンドポイントに送信します。 これは、リッスンしているクライアントに通知するためにIoT Hubによって使用されます。

notify_blob_upload_status(correlation_id, is_success, status_code, status_description)

パラメーター

correlation_id
str
必須

get_storage_info_for_blob要求でIoT Hubによって提供されます。

is_success
bool
必須

ファイルが正常にアップロードされたかどうかを示すブール値。

status_code
int
必須

ストレージへのファイルのアップロードの状態を示す数値状態コード。

status_description
str
必須

status_codeに対応する説明。

例外

資格情報が無効で、接続を確立できない場合は 。

接続を確立するとエラーが発生する場合は 。

実行中に接続が失われた場合は 。

接続がタイムアウトした場合は 。

実行中に予期しないエラーが発生した場合は 。

patch_twin_reported_properties

報告されたプロパティをAzure IoT Hubまたは Azure IoT Edge Hub サービスで更新します。

これは同期呼び出しです。つまり、パッチがサービスに送信されて確認されるまで、この関数は戻りません。

サービスがパッチ操作でエラーを返した場合、この関数は適切なエラーを発生させます。

patch_twin_reported_properties(reported_properties_patch)

パラメーター

reported_properties_patch
dict
必須

JSON dict としての Twin Reported Properties パッチ

例外

資格情報が無効で、接続を確立できない場合は 。

接続を確立するとエラーが発生する場合は 。

実行中に接続が失われた場合は 。

接続試行がタイムアウトした場合

クライアントが接続されていない場合 (自動接続が有効になっていません)

実行中に予期しないエラーが発生した場合は 。

receive_message

Azure IoT Hubから送信されたメッセージを受信します。

バージョン 2.3.0 以降非推奨: 代わりに .on_message_received プロパティを使用してハンドラーを設定することをお勧めします

receive_message(block=True, timeout=None)

パラメーター

block
bool
必須

メッセージが受信されるまで操作をブロックする必要があるかどうかを示します。

timeout
int
必須

必要に応じて、ブロックがタイムアウトするまでの秒数を指定します。

戻り値

Azure IoT Hubから送信されたメッセージ。ブロック期間の終わりまでにメソッド要求が受信されなかった場合は None。

の戻り値の型 :

例外

資格情報が無効で、接続を確立できない場合は 。

接続を確立するとエラーが発生する場合は 。

実行中に接続が失われた場合は 。

接続がタイムアウトした場合は 。

実行中に予期しないエラーが発生した場合は 。

receive_method_request

Azure IoT Hubまたは Azure IoT Edge Hub 経由でメソッド要求を受け取ります。

バージョン 2.3.0 以降非推奨: 代わりに .on_method_request_received プロパティを使用してハンドラーを設定することをお勧めします

receive_method_request(method_name=None, block=True, timeout=None)

パラメーター

method_name
str
既定値: None

必要に応じて、要求を受信するメソッドの名前を指定します。 このパラメーターが指定されていない場合、receive_methodに対する別の要求によってまだ対象とされていないすべてのメソッドが受信されます。

block
bool
既定値: True

要求が受信されるまで操作をブロックする必要があるかどうかを示します。

timeout
int
既定値: None

必要に応じて、ブロックがタイムアウトするまでの秒数を指定します。

戻り値

受信したメソッド要求を表す MethodRequest オブジェクト。ブロック期間の終わりまでにメソッド要求が受信されなかった場合は None。

例外

資格情報が無効で、接続を確立できない場合は 。

接続を確立するとエラーが発生する場合は 。

実行中に接続が失われた場合は 。

接続がタイムアウトした場合は 。

実行中に予期しないエラーが発生した場合は 。

receive_twin_desired_properties_patch

Azure IoT Hubまたは Azure IoT Edge Hub 経由で目的のプロパティパッチを受け取ります。

これは同期呼び出しであり、次のことを意味します。

  1. block=True の場合、この関数は次のいずれかが発生するまでブロックします。

    • Azure IoT Hubまたは Azure IoT Edge Hub から目的のプロパティパッチを受け取ります。

    • タイムアウト期間 (指定されている場合) が経過します。 タイムアウトが発生した場合、この関数は InboxEmpty 例外を発生させます

  2. block=False の場合、この関数は、パイプラインによって受信された可能性があるが、まだアプリケーションに返されていない必要なプロパティパッチを返します。 パイプラインで必要なプロパティパッチが受信されていない場合、この関数は InboxEmpty 例外を発生させます

バージョン 2.3.0 以降非推奨: 代わりに .on_twin_desired_properties_patch_received プロパティを使用してハンドラーを設定することをお勧めします

receive_twin_desired_properties_patch(block=True, timeout=None)

パラメーター

block
bool
既定値: True

要求が受信されるまで操作をブロックする必要があるかどうかを示します。

timeout
int
既定値: None

必要に応じて、ブロックがタイムアウトするまでの秒数を指定します。

戻り値

TWIN Desired Properties patch as a JSON dict、または None (ブロック期間の終わりまでにパッチが受信されていない場合)

の戻り値の型 :

dict,

例外

資格情報が無効で、接続を確立できない場合は 。

接続を確立するとエラーが発生する場合は 。

実行中に接続が失われた場合は 。

接続がタイムアウトした場合は 。

実行中に予期しないエラーが発生した場合は 。

send_message

Azure IoT Hub または Azure IoT Edge Hub インスタンスの既定のイベント エンドポイントにメッセージを送信します。

これは同期イベントです。つまり、イベントがサービスに送信され、サービスがイベントの受信を確認するまで、この関数は戻りません。

接続する呼び出しによってサービスへの接続が以前に開かっていない場合、この関数はイベントを送信する前に接続を開きます。

send_message(message)

パラメーター

message
Message
必須

送信する実際のメッセージ。 Message クラスのインスタンスではない渡された値はすべて、Message オブジェクトに変換されます。

例外

資格情報が無効で、接続を確立できない場合は 。

接続を確立するとエラーが発生する場合は 。

実行中に接続が失われた場合は 。

接続試行がタイムアウトした場合

クライアントが接続されていない場合 (自動接続が有効になっていません)

実行中に予期しないエラーが発生した場合は 。

ValueError if the message fails size validation.

send_method_response

Azure IoT Hubまたは Azure IoT Edge Hub 経由でメソッド要求に応答を送信します。

これは同期イベントです。つまり、イベントがサービスに送信され、サービスがイベントの受信を確認するまで、この関数は戻りません。

接続する呼び出しによってサービスへの接続が以前に開かっていない場合、この関数はイベントを送信する前に接続を開きます。

send_method_response(method_response)

パラメーター

method_response
MethodResponse
必須

送信する MethodResponse。

例外

資格情報が無効で、接続を確立できない場合は 。

接続を確立するとエラーが発生する場合は 。

実行中に接続が失われた場合は 。

接続試行がタイムアウトした場合

クライアントが接続されていない場合 (自動接続が有効になっていません)

実行中に予期しないエラーが発生した場合は 。

shutdown

正常終了のためにクライアントをシャットダウンします。

このメソッドが呼び出されると、以降のクライアント呼び出しで試行されると、ClientError が発生します

shutdown()

例外

実行中に予期しないエラーが発生した場合は 。

update_sastoken

認証に使用するクライアントの SAS トークンを更新し、接続を再認証します。

この API は、クライアントが最初に SAS トークンを使用して作成された場合にのみ使用できます。

update_sastoken(sastoken)

パラメーター

sastoken
str
必須

クライアントが使用する新しい SAS トークン文字列

例外

ValueError if the sastoken parameter is invalid

資格情報が無効で、接続を再確立できない場合は 。

接続を再確立するとエラーが発生する場合は 。

実行中に接続が失われた場合は 。

再認証の試行がタイムアウトした場合は 。

クライアントが最初に SAS トークンを使用して作成されなかった場合は 。

実行中に予期しないエラーが発生した場合は 。

属性

connected

トランスポートが接続されているかどうかを示す読み取り専用プロパティ。

on_background_exception

バックグラウンド例外が発生すると、ハンドラー関数またはコルーチンが呼び出されます。

関数またはコルーチン定義は、1 つの位置引数 (例外オブジェクト) を受け取る必要があります

on_connection_state_change

接続状態が変化したときに呼び出されるハンドラー関数またはコルーチン。

関数またはコルーチンの定義では、位置引数を受け取る必要はありません。

on_message_received

メッセージの受信時に呼び出されるハンドラー関数またはコルーチン。

関数またはコルーチン定義は、1 つの位置引数 (オブジェクト) を Message 受け取る必要があります

on_method_request_received

メソッド要求の受信時に呼び出されるハンドラー関数またはコルーチン。

クライアントの .send_method_response() メソッドを使用して、関数またはコルーチンのメソッド要求を確認してください。

関数またはコルーチン定義は、1 つの位置引数 (オブジェクト) を MethodRequest 受け取る必要があります

on_new_sastoken_required

クライアントが新しい SAS トークンを必要とする場合に呼び出されるハンドラー関数またはコルーチン。 これは、SAS トークンの有効期限が切れる約 2 分前に発生します。 Windows プラットフォームでは、有効期間が約 49 日を超える場合、SAS の有効期間に関係なく、その 49 日後に新しいトークンが必要になります。

このハンドラーは、.create_from_sastoken() メソッドを使用して作成されたクライアントを使用する場合にのみ必要であることに注意してください。

新しいトークンは、クライアントの .update_sastoken() メソッドを使用して、関数またはコルーチンで提供できます。

関数またはコルーチンの定義では、位置引数を受け取る必要はありません。

on_twin_desired_properties_patch_received

ツインの必要なプロパティパッチを受け取ったときに呼び出されるハンドラー関数またはコルーチン。

関数またはコルーチンの定義では、1 つの位置引数を受け取る必要があります (JSON ディクショナリ オブジェクトの形式のツインパッチ)