IoTHubConfigurationManager クラス
自動生成された IotHub REST API に基づいて、IoTHub Configuration Manager操作に便利な API を提供するクラス
Configuration Manager サービス クライアントの初期化子。
作成が成功すると、クラスは IoTHub で認証され、メンバー API を呼び出して IoTHub と通信する準備が整います。
- 継承
-
builtins.objectIoTHubConfigurationManager
コンストラクター
IoTHubConfigurationManager(connection_string=None, host=None, auth=None)パラメーター
| 名前 | 説明 |
|---|---|
|
connection_string
|
connection_str認証を使用している場合に IoTHub との接続を認証するために使用される IoTHub 接続文字列。 既定値: なし 既定値: None
|
|
host
|
トークン資格情報認証を使用している場合の Azure サービス URL。 既定値: なし 既定値: None
|
|
auth
|
トークン資格情報認証を使用している場合の Azure 認証オブジェクト。 既定値: なし 既定値: None
|
メソッド
| apply_configuration_on_edge_device |
指定した構成コンテンツを、指定したエッジ デバイスに適用します。 モジュールの内容は必須です。 |
| create_configuration |
IoTHub のデバイスまたはモジュールの構成を作成します。 |
| delete_configuration |
IoTHub から構成を削除します。 |
| from_connection_string |
IoTHubConfigurationManager サービス クライアントの Classmethod 初期化子。 接続文字列から IoTHubConfigurationManager クラスを作成します。 作成が成功すると、クラスは IoTHub で認証され、メンバー API を呼び出して IoTHub と通信する準備が整います。 |
| from_token_credential |
IoTHubConfigurationManager サービス クライアントの Classmethod 初期化子。 ホスト名 URL と Azure トークン資格情報から IoTHubConfigurationManager クラスを作成します。 作成が成功すると、クラスは IoTHub で認証され、メンバー API を呼び出して IoTHub と通信する準備が整います。 |
| get_configuration |
特定のデバイスの IoTHub 構成を取得します。 |
| get_configurations |
IoTHub のデバイスとモジュールの複数の構成を取得します。 指定した数の構成を返します。 改ページ位置の設定はサポートされていません。 |
| test_configuration_queries |
構成のターゲット条件クエリとカスタム メトリック クエリを検証します。 |
| update_configuration |
IoTHub のデバイスまたはモジュールの構成を更新します。 注: 構成 ID とコンテンツは、ユーザーが更新できないことに注意してください。 |
apply_configuration_on_edge_device
指定した構成コンテンツを、指定したエッジ デバイスに適用します。 モジュールの内容は必須です。
apply_configuration_on_edge_device(device_id, configuration_content)パラメーター
| 名前 | 説明 |
|---|---|
|
configuration_content
必須
|
エッジ デバイスの名前 (ID)。 |
|
device_id
必須
|
|
戻り値
| 型 | 説明 |
|---|---|
|
オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_configuration
IoTHub のデバイスまたはモジュールの構成を作成します。
create_configuration(configuration)パラメーター
| 名前 | 説明 |
|---|---|
|
configuration_id
必須
|
構成の ID。 |
|
configuration
必須
|
作成する構成。 |
戻り値
| 型 | 説明 |
|---|---|
|
作成された構成を含む構成オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
delete_configuration
IoTHub から構成を削除します。
delete_configuration(configuration_id, etag=None)パラメーター
| 名前 | 説明 |
|---|---|
|
configuration_id
必須
|
構成の ID。 |
|
configuration
必須
|
作成する構成。 |
|
etag
|
削除操作に使用する etag (if_match) 値。 既定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
更新された構成を含む構成オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
from_connection_string
IoTHubConfigurationManager サービス クライアントの Classmethod 初期化子。 接続文字列から IoTHubConfigurationManager クラスを作成します。
作成が成功すると、クラスは IoTHub で認証され、メンバー API を呼び出して IoTHub と通信する準備が整います。
from_connection_string(connection_string)パラメーター
| 名前 | 説明 |
|---|---|
|
connection_string
必須
|
IoTHub との接続を認証するために使用される IoTHub 接続文字列。 |
戻り値
| 型 | 説明 |
|---|---|
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
from_token_credential
IoTHubConfigurationManager サービス クライアントの Classmethod 初期化子。 ホスト名 URL と Azure トークン資格情報から IoTHubConfigurationManager クラスを作成します。
作成が成功すると、クラスは IoTHub で認証され、メンバー API を呼び出して IoTHub と通信する準備が整います。
from_token_credential(url, token_credential)パラメーター
| 名前 | 説明 |
|---|---|
|
url
必須
|
Azure サービスの URL (ホスト名)。 |
|
token_credential
必須
|
<xref:azure.core.TokenCredential>
Azure トークン資格情報オブジェクト |
戻り値
| 型 | 説明 |
|---|---|
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_configuration
特定のデバイスの IoTHub 構成を取得します。
get_configuration(configuration_id)パラメーター
| 名前 | 説明 |
|---|---|
|
configuration_id
必須
|
構成の ID。 |
戻り値
| 型 | 説明 |
|---|---|
|
Configuration オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_configurations
IoTHub のデバイスとモジュールの複数の構成を取得します。 指定した数の構成を返します。 改ページ位置の設定はサポートされていません。
get_configurations(max_count=None)パラメーター
| 名前 | 説明 |
|---|---|
|
max_count
|
要求された構成の最大数。 既定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
list[Configuration] オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
test_configuration_queries
構成のターゲット条件クエリとカスタム メトリック クエリを検証します。
test_configuration_queries(configuration_queries_test_input)パラメーター
| 名前 | 説明 |
|---|---|
|
configuration_queries_test_input
必須
|
クエリは入力をテストします。 |
戻り値
| 型 | 説明 |
|---|---|
|
ConfigurationQueriesTestResponse オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_configuration
IoTHub のデバイスまたはモジュールの構成を更新します。 注: 構成 ID とコンテンツは、ユーザーが更新できないことに注意してください。
update_configuration(configuration, etag)パラメーター
| 名前 | 説明 |
|---|---|
|
configuration_id
必須
|
構成の ID。 |
|
configuration
必須
|
構成には、更新された構成が含まれています。 |
|
etag
必須
|
更新操作に使用する etag (if_match) 値。 |
戻り値
| 型 | 説明 |
|---|---|
|
更新された構成を含む構成オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
Azure SDK for Python