DigitalTwinClient クラス
自動生成された IotHub REST API に基づいて DigitalTwin 操作に便利な API を提供するクラス
DigitalTwinClient の初期化子。
作成が成功すると、クラスは IoTHub で認証され、メンバー API を呼び出して IoTHub と通信する準備が整います。
- 継承
-
builtins.objectDigitalTwinClient
コンストラクター
DigitalTwinClient(connection_string=None, host=None, auth=None)パラメーター
| 名前 | 説明 |
|---|---|
|
connection_string
|
connection_str認証を使用している場合に IoTHub との接続を認証するために使用される IoTHub 接続文字列。 既定値: なし 既定値: None
|
|
host
|
トークン資格情報認証を使用している場合の Azure サービス URL。 既定値: なし 既定値: None
|
|
auth
|
トークン資格情報認証を使用している場合の Azure 認証オブジェクト。 既定値: なし 既定値: None
|
メソッド
| from_connection_string |
DigitalTwinClient サービス クライアントの Classmethod 初期化子。 接続文字列から DigitalTwinClient クラスを作成します。 作成が成功すると、クラスは IoTHub で認証され、メンバー API を呼び出して IoTHub と通信する準備が整います。 |
| from_token_credential |
DigitalTwinClient サービス クライアントの Classmethod 初期化子。 ホスト名 URL と Azure トークン資格情報から DigitalTwinClient クラスを作成します。 作成が成功すると、クラスは IoTHub で認証され、メンバー API を呼び出して IoTHub と通信する準備が整います。 |
| get_digital_twin |
特定のデバイスのデジタル ツインを取得します。 :p aram str digital_twin__id: 指定されたデバイスのデジタル ツイン ID。 |
| invoke_command |
特定のデバイスでコマンドを呼び出し、その結果を取得します。 :p aram str digital_twin__id: 指定されたデバイスのデジタル ツイン ID。 :p aram str command_name: コマンドの名前。 :p aram str ペイロード: コマンドの引数。 :p aram int connect_timeout_in_seconds: デジタル ツイン コマンドが応答を待機する最大時間間隔 (秒単位)。 :p aram int response_timeout_in_seconds: デジタル ツイン コマンドが応答を待機する最大時間間隔 (秒単位)。 値は 5 から 300 以内である必要があります。 |
| invoke_component_command |
特定のデバイスのコンポーネントでコマンドを呼び出し、その結果を取得します。 :p aram str digital_twin__id: 指定されたデバイスのデジタル ツイン ID。 :p aram str component_path: コンポーネントの名前。 :p aram str command_name: コマンドの名前。 :p aram str ペイロード: コマンドの引数。 :p aram int connect_timeout_in_seconds: デジタル ツイン コマンドが応答を待機する最大時間間隔 (秒単位)。 :p aram int response_timeout_in_seconds: デジタル ツイン コマンドが応答を待機する最大時間間隔 (秒単位)。 値は 5 から 300 以内である必要があります。 :type response_timeout_in_seconds: int |
| update_digital_twin |
パッチ オブジェクトを使用して、特定のデバイスの Digital Twin コンポーネントを更新します。 :p aram str digital_twin__id: 指定されたデバイスのデジタル ツイン ID。 :p aram list[object]: Digital Twin を更新する json-patch オブジェクト。 :p aram str etag: 更新操作に使用する etag (if_match) 値。 |
from_connection_string
DigitalTwinClient サービス クライアントの Classmethod 初期化子。 接続文字列から DigitalTwinClient クラスを作成します。
作成が成功すると、クラスは IoTHub で認証され、メンバー API を呼び出して IoTHub と通信する準備が整います。
from_connection_string(connection_string)パラメーター
| 名前 | 説明 |
|---|---|
|
connection_string
必須
|
IoTHub との接続を認証するために使用される IoTHub 接続文字列。 |
戻り値
| 型 | 説明 |
|---|---|
from_token_credential
DigitalTwinClient サービス クライアントの Classmethod 初期化子。 ホスト名 URL と Azure トークン資格情報から DigitalTwinClient クラスを作成します。
作成が成功すると、クラスは IoTHub で認証され、メンバー API を呼び出して IoTHub と通信する準備が整います。
from_token_credential(url, token_credential)パラメーター
| 名前 | 説明 |
|---|---|
|
url
必須
|
Azure サービスの URL (ホスト名)。 |
|
token_credential
必須
|
<xref:azure.core.TokenCredential>
Azure トークン資格情報オブジェクト |
戻り値
| 型 | 説明 |
|---|---|
get_digital_twin
特定のデバイスのデジタル ツインを取得します。 :p aram str digital_twin__id: 指定されたデバイスのデジタル ツイン ID。
get_digital_twin(digital_twin_id)パラメーター
| 名前 | 説明 |
|---|---|
|
digital_twin_id
必須
|
|
戻り値
| 型 | 説明 |
|---|---|
|
Digital Twin を含む return オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
invoke_command
特定のデバイスでコマンドを呼び出し、その結果を取得します。 :p aram str digital_twin__id: 指定されたデバイスのデジタル ツイン ID。 :p aram str command_name: コマンドの名前。 :p aram str ペイロード: コマンドの引数。 :p aram int connect_timeout_in_seconds: デジタル ツイン コマンドが応答を待機する最大時間間隔 (秒単位)。 :p aram int response_timeout_in_seconds: デジタル ツイン コマンドが応答を待機する最大時間間隔 (秒単位)。 値は 5 から 300 以内である必要があります。
invoke_command(digital_twin_id, command_name, payload, connect_timeout_in_seconds=None, response_timeout_in_seconds=None)パラメーター
| 名前 | 説明 |
|---|---|
|
digital_twin_id
必須
|
|
|
command_name
必須
|
|
|
payload
必須
|
|
|
connect_timeout_in_seconds
|
既定値: None
|
|
response_timeout_in_seconds
|
既定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
呼び出されたコマンドの結果。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
invoke_component_command
特定のデバイスのコンポーネントでコマンドを呼び出し、その結果を取得します。 :p aram str digital_twin__id: 指定されたデバイスのデジタル ツイン ID。 :p aram str component_path: コンポーネントの名前。 :p aram str command_name: コマンドの名前。 :p aram str ペイロード: コマンドの引数。 :p aram int connect_timeout_in_seconds: デジタル ツイン コマンドが応答を待機する最大時間間隔 (秒単位)。 :p aram int response_timeout_in_seconds: デジタル ツイン コマンドが応答を待機する最大時間間隔 (秒単位)。 値は 5 から 300 以内である必要があります。 :type response_timeout_in_seconds: int
invoke_component_command(digital_twin_id, component_path, command_name, payload, connect_timeout_in_seconds=None, response_timeout_in_seconds=None)パラメーター
| 名前 | 説明 |
|---|---|
|
digital_twin_id
必須
|
|
|
component_path
必須
|
|
|
command_name
必須
|
|
|
payload
必須
|
|
|
connect_timeout_in_seconds
|
既定値: None
|
|
response_timeout_in_seconds
|
既定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
呼び出されたコマンドの結果。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_digital_twin
パッチ オブジェクトを使用して、特定のデバイスの Digital Twin コンポーネントを更新します。 :p aram str digital_twin__id: 指定されたデバイスのデジタル ツイン ID。 :p aram list[object]: Digital Twin を更新する json-patch オブジェクト。 :p aram str etag: 更新操作に使用する etag (if_match) 値。
update_digital_twin(digital_twin_id, digital_twin_patch, etag=None)パラメーター
| 名前 | 説明 |
|---|---|
|
digital_twin_id
必須
|
|
|
digital_twin_patch
必須
|
|
|
etag
|
既定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
更新された Digital Twin を含む return オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
Azure SDK for Python