IoTHubRegistryManager クラス
自動生成された IotHub REST API に基づいて、IoTHub Registry Manager 操作に便利な API を提供するクラス
レジストリ マネージャー サービス クライアントの初期化子。
ユーザーはこれを直接呼び出さないでください。 むしろ、from_connection_string() または from_token_credential() ファクトリ メソッドである必要があります。
作成が成功すると、クラスは IoTHub で認証され、メンバー API を呼び出して IoTHub と通信する準備が整います。
- 継承
-
builtins.objectIoTHubRegistryManager
コンストラクター
IoTHubRegistryManager(connection_string=None, host=None, token_credential=None)パラメーター
| 名前 | 説明 |
|---|---|
|
connection_string
|
connection_str認証を使用している場合に IoTHub との接続を認証するために使用される IoTHub 接続文字列。 既定値: なし 既定値: None
|
|
host
|
トークン資格情報認証を使用している場合の Azure サービス URL。 既定値: なし 既定値: None
|
|
auth
必須
|
トークン資格情報認証を使用している場合の Azure 認証オブジェクト。 既定値: なし |
|
token_credential
|
既定値: None
|
メソッド
| bulk_create_or_update_devices |
IoTHub ID レジストリから複数のデバイスの ID を作成、更新、または削除します。 IoTHub ID レジストリから複数のデバイスの ID を作成、更新、または削除します。 デバイス ID は、一覧で 1 回だけ指定できます。 デバイスごとに異なる操作 (作成、更新、削除) が許可されます。 呼び出しごとに最大 100 台のデバイスを指定できます。 大規模な操作の場合は、BLOB Storage(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities) を使用したインポート機能の使用を検討してください。 |
| create_device_with_certificate_authority |
証明機関を使用して IoTHub にデバイス ID を作成します。 |
| create_device_with_sas |
SAS 認証を使用して IoTHub にデバイス ID を作成します。 |
| create_device_with_x509 |
X509 認証を使用して IoTHub にデバイス ID を作成します。 |
| create_module_with_certificate_authority |
証明機関を使用して、IoTHub 上のデバイスのモジュール ID を作成します。 |
| create_module_with_sas |
SAS 認証を使用して、IoTHub 上のデバイスのモジュール ID を作成します。 |
| create_module_with_x509 |
X509 認証を使用して、IoTHub 上のデバイスのモジュール ID を作成します。 |
| delete_device |
IoTHub からデバイス ID を削除します。 |
| delete_module |
IoTHub からデバイスのモジュール ID を削除します。 |
| from_connection_string |
Registry Manager サービス クライアントの Classmethod 初期化子。 接続文字列から Registry Manager クラスを作成します。 作成が成功すると、クラスは IoTHub で認証され、メンバー API を呼び出して IoTHub と通信する準備が整います。 |
| from_token_credential |
Registry Manager サービス クライアントの Classmethod 初期化子。 ホスト名 URL と Azure トークン資格情報から Registry Manager クラスを作成します。 作成が成功すると、クラスは IoTHub で認証され、メンバー API を呼び出して IoTHub と通信する準備が整います。 |
| get_device |
IoTHub からデバイス ID を取得します。 |
| get_device_registry_statistics |
IoTHub デバイス レジストリの統計情報を取得します。 |
| get_devices |
IoTHub ID レジストリから複数のデバイスの ID を取得します。 非推奨。 IoTHub クエリ言語を使用して、デバイス ツインとデバイス ID 情報を取得します。 詳細については、「https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub」および「https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language」を参照してください。 |
| get_module |
IoTHub からデバイスのモジュール ID を取得します。 |
| get_module_twin |
モジュール ツインを取得します。 |
| get_modules |
デバイス上のすべてのモジュール ID を取得します。 |
| get_service_statistics |
IoTHub サービスの統計情報を取得します。 |
| get_twin |
デバイス ツインを取得します。 |
| invoke_device_method |
デバイスでダイレクト メソッドを呼び出します。 |
| invoke_device_module_method |
デバイスでダイレクト メソッドを呼び出します。 |
| query_iot_hub |
IoTHub にクエリを実行し、SQL に似た言語を使用してデバイス ツインに関する情報を取得します。 詳細については、「 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language 」を参照してください。 結果の改ページがサポートされています。 これにより、デバイス ツインに関する情報のみが返されます。 |
| replace_module_twin |
モジュール ツインのタグと必要なプロパティを置き換えます。 |
| replace_twin |
デバイス ツインのタグと必要なプロパティを置き換えます。 |
| send_c2d_message |
IoTHub デバイスに C2D メッセージを送信します。 |
| update_device_with_certificate_authority |
証明機関を使用して IoTHub でデバイス ID を更新します。 |
| update_device_with_sas |
SAS 認証を使用して IoTHub でデバイス ID を更新します。 |
| update_device_with_x509 |
X509 認証を使用して IoTHub でデバイス ID を更新します。 |
| update_module_twin |
モジュール ツインのタグと必要なプロパティを更新します。 |
| update_module_with_certificate_authority |
証明機関を使用して IoTHub 上のデバイスのモジュール ID を更新します。 |
| update_module_with_sas |
SAS 認証を使用して IoTHub 上のデバイスのモジュール ID を更新します。 |
| update_module_with_x509 |
X509 認証を使用して IoTHub 上のデバイスのモジュール ID を更新します。 |
| update_twin |
デバイス ツインのタグと必要なプロパティを更新します。 |
bulk_create_or_update_devices
IoTHub ID レジストリから複数のデバイスの ID を作成、更新、または削除します。
IoTHub ID レジストリから複数のデバイスの ID を作成、更新、または削除します。 デバイス ID は、一覧で 1 回だけ指定できます。 デバイスごとに異なる操作 (作成、更新、削除) が許可されます。 呼び出しごとに最大 100 台のデバイスを指定できます。 大規模な操作の場合は、BLOB Storage(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities) を使用したインポート機能の使用を検討してください。
bulk_create_or_update_devices(devices)パラメーター
| 名前 | 説明 |
|---|---|
|
devices
必須
|
操作するデバイス オブジェクトの一覧。 |
戻り値
| 型 | 説明 |
|---|---|
|
BulkRegistryOperationResult オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_device_with_certificate_authority
証明機関を使用して IoTHub にデバイス ID を作成します。
create_device_with_certificate_authority(device_id, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)パラメーター
| 名前 | 説明 |
|---|---|
|
device_id
必須
|
デバイスの名前 (ID)。 |
|
status
必須
|
作成されたデバイスの初期状態。 (使用可能な値: "enabled" または "disabled")。 |
|
iot_edge
|
作成されたデバイスがIoT Edge デバイスであるかどうか。 既定値: False 既定値: False
|
|
status_reason
|
デバイス ID の状態の理由。 既定値: なし 既定値: None
|
|
device_scope
|
デバイスのスコープ。 既定値: エッジ デバイスに対して自動生成および変更不可なし。リーフ デバイスで子/親リレーションシップを作成するために変更可能です。 リーフ デバイスの場合、親エッジ デバイスを設定する値は、親エッジ デバイスの device_scope プロパティから取得できます。 既定値: None
|
|
parent_scopes
|
該当する場合は、上位レベルのエッジ デバイスのスコープ。 既定値: None エッジ デバイスの場合、親エッジ デバイスを設定する値は、親エッジ デバイスの device_scope プロパティから取得できます。 リーフ デバイスの場合、これはdevice_scopeと同じ値に設定することも、サービスをコピーするために残しておく場合もあります。 既定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
作成されたデバイスを含む Device オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_device_with_sas
SAS 認証を使用して IoTHub にデバイス ID を作成します。
create_device_with_sas(device_id, primary_key, secondary_key, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)パラメーター
| 名前 | 説明 |
|---|---|
|
device_id
必須
|
デバイスの名前 (ID)。 |
|
primary_key
必須
|
プライマリ認証キー。 |
|
secondary_key
必須
|
セカンダリ認証キー。 |
|
status
必須
|
作成されたデバイスの初期状態。 (使用可能な値: "enabled" または "disabled") |
|
iot_edge
|
作成されたデバイスがIoT Edge デバイスであるかどうか。 既定値: False 既定値: False
|
|
status_reason
|
デバイス ID の状態の理由。 既定値: なし 既定値: None
|
|
device_scope
|
デバイスのスコープ。 既定値: エッジ デバイスに対して自動生成および変更不可なし。リーフ デバイスで子/親リレーションシップを作成するために変更可能です。 リーフ デバイスの場合、親エッジ デバイスを設定する値は、親エッジ デバイスの device_scope プロパティから取得できます。 既定値: None
|
|
parent_scopes
|
該当する場合は、上位レベルのエッジ デバイスのスコープ。 既定値: None エッジ デバイスの場合、親エッジ デバイスを設定する値は、親エッジ デバイスの device_scope プロパティから取得できます。 リーフ デバイスの場合、これはdevice_scopeと同じ値に設定することも、サービスをコピーするために残しておく場合もあります。 既定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
作成されたデバイスを含む Device オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_device_with_x509
X509 認証を使用して IoTHub にデバイス ID を作成します。
create_device_with_x509(device_id, primary_thumbprint, secondary_thumbprint, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)パラメーター
| 名前 | 説明 |
|---|---|
|
device_id
必須
|
デバイスの名前 (ID)。 |
|
primary_thumbprint
必須
|
プライマリ X509 拇印。 |
|
secondary_thumbprint
必須
|
セカンダリ X509 拇印。 |
|
status
必須
|
作成されたデバイスの初期状態。 (使用可能な値: "enabled" または "disabled") |
|
iot_edge
|
作成されたデバイスがIoT Edge デバイスであるかどうか。 既定値: False 既定値: False
|
|
status_reason
|
デバイス ID の状態の理由。 既定値: なし 既定値: None
|
|
device_scope
|
デバイスのスコープ。 既定値: エッジ デバイスに対して自動生成および変更不可なし。リーフ デバイスで子/親リレーションシップを作成するために変更可能です。 リーフ デバイスの場合、親エッジ デバイスを設定する値は、親エッジ デバイスの device_scope プロパティから取得できます。 既定値: None
|
|
parent_scopes
|
該当する場合は、上位レベルのエッジ デバイスのスコープ。 既定値: None エッジ デバイスの場合、親エッジ デバイスを設定する値は、親エッジ デバイスの device_scope プロパティから取得できます。 リーフ デバイスの場合、これはdevice_scopeと同じ値に設定することも、サービスをコピーするために残しておく場合もあります。 既定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
作成されたデバイスを含む Device オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_module_with_certificate_authority
証明機関を使用して、IoTHub 上のデバイスのモジュール ID を作成します。
create_module_with_certificate_authority(device_id, module_id, managed_by)パラメーター
| 名前 | 説明 |
|---|---|
|
device_id
必須
|
デバイスの名前 (ID)。 |
|
module_id
必須
|
モジュールの名前 (ID)。 |
|
managed_by
必須
|
マネージャー デバイス (エッジ) の名前。 |
戻り値
| 型 | 説明 |
|---|---|
|
作成されたモジュールを含む Module オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_module_with_sas
SAS 認証を使用して、IoTHub 上のデバイスのモジュール ID を作成します。
create_module_with_sas(device_id, module_id, managed_by, primary_key, secondary_key)パラメーター
| 名前 | 説明 |
|---|---|
|
device_id
必須
|
デバイスの名前 (ID)。 |
|
module_id
必須
|
モジュールの名前 (ID)。 |
|
managed_by
必須
|
マネージャー デバイス (エッジ) の名前。 |
|
primary_key
必須
|
プライマリ認証キー。 |
|
secondary_key
必須
|
セカンダリ認証キー。 |
戻り値
| 型 | 説明 |
|---|---|
|
作成されたモジュールを含む Module オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
create_module_with_x509
X509 認証を使用して、IoTHub 上のデバイスのモジュール ID を作成します。
create_module_with_x509(device_id, module_id, managed_by, primary_thumbprint, secondary_thumbprint)パラメーター
| 名前 | 説明 |
|---|---|
|
device_id
必須
|
デバイスの名前 (ID)。 |
|
module_id
必須
|
モジュールの名前 (ID)。 |
|
managed_by
必須
|
マネージャー デバイス (エッジ) の名前。 |
|
primary_thumbprint
必須
|
プライマリ X509 拇印。 |
|
secondary_thumbprint
必須
|
セカンダリ X509 拇印。 |
戻り値
| 型 | 説明 |
|---|---|
|
作成されたモジュールを含む Module オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
delete_device
IoTHub からデバイス ID を削除します。
delete_device(device_id, etag=None)パラメーター
| 名前 | 説明 |
|---|---|
|
device_id
必須
|
デバイスの名前 (ID)。 |
|
etag
|
削除操作に使用する etag (if_match) 値。 既定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
[なし] : |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
delete_module
IoTHub からデバイスのモジュール ID を削除します。
delete_module(device_id, module_id, etag=None)パラメーター
| 名前 | 説明 |
|---|---|
|
device_id
必須
|
デバイスの名前 (ID)。 |
|
module_id
必須
|
モジュールの名前 (ID)。 |
|
etag
|
削除操作に使用する etag (if_match) 値。 既定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
[なし] : |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
from_connection_string
Registry Manager サービス クライアントの Classmethod 初期化子。 接続文字列から Registry Manager クラスを作成します。
作成が成功すると、クラスは 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
Registry Manager サービス クライアントの Classmethod 初期化子。 ホスト名 URL と Azure トークン資格情報から Registry Manager クラスを作成します。
作成が成功すると、クラスは 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_device
IoTHub からデバイス ID を取得します。
get_device(device_id)パラメーター
| 名前 | 説明 |
|---|---|
|
device_id
必須
|
デバイスの名前 (ID)。 |
戻り値
| 型 | 説明 |
|---|---|
|
要求されたデバイスを含む Device オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_device_registry_statistics
IoTHub デバイス レジストリの統計情報を取得します。
get_device_registry_statistics()戻り値
| 型 | 説明 |
|---|---|
|
RegistryStatistics オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_devices
IoTHub ID レジストリから複数のデバイスの ID を取得します。 非推奨。 IoTHub クエリ言語を使用して、デバイス ツインとデバイス ID 情報を取得します。 詳細については、「https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub」および「https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language」を参照してください。
get_devices(max_number_of_devices=None)パラメーター
| 名前 | 説明 |
|---|---|
|
max_number_of_devices
|
このパラメーターを指定すると、返されるデバイス ID の最大数が定義されます。 1 から 1000 の範囲外の値は 1000 と見なされます 既定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
デバイス情報の一覧。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_module
IoTHub からデバイスのモジュール ID を取得します。
get_module(device_id, module_id)パラメーター
| 名前 | 説明 |
|---|---|
|
device_id
必須
|
デバイスの名前 (ID)。 |
|
module_id
必須
|
モジュールの名前 (ID)。 |
戻り値
| 型 | 説明 |
|---|---|
|
要求されたモジュールを含む Module オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_module_twin
モジュール ツインを取得します。
get_module_twin(device_id, module_id)パラメーター
| 名前 | 説明 |
|---|---|
|
device_id
必須
|
デバイスの名前 (ID)。 |
|
module_id
必須
|
モジュールの名前 (ID)。 |
戻り値
| 型 | 説明 |
|---|---|
|
Twin オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_modules
デバイス上のすべてのモジュール ID を取得します。
get_modules(device_id)パラメーター
| 名前 | 説明 |
|---|---|
|
device_id
必須
|
デバイスの名前 (ID)。 |
戻り値
| 型 | 説明 |
|---|---|
|
デバイス上のすべてのモジュールを含む list[Module] 。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_service_statistics
IoTHub サービスの統計情報を取得します。
get_service_statistics()戻り値
| 型 | 説明 |
|---|---|
|
ServiceStatistics オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
get_twin
デバイス ツインを取得します。
get_twin(device_id)パラメーター
| 名前 | 説明 |
|---|---|
|
device_id
必須
|
デバイスの名前 (ID)。 |
戻り値
| 型 | 説明 |
|---|---|
|
Twin オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
invoke_device_method
デバイスでダイレクト メソッドを呼び出します。
invoke_device_method(device_id, direct_method_request)パラメーター
| 名前 | 説明 |
|---|---|
|
device_id
必須
|
デバイスの名前 (ID)。 |
|
direct_method_request
必須
|
メソッド要求。 |
戻り値
| 型 | 説明 |
|---|---|
|
CloudToDeviceMethodResult オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
invoke_device_module_method
デバイスでダイレクト メソッドを呼び出します。
invoke_device_module_method(device_id, module_id, direct_method_request)パラメーター
| 名前 | 説明 |
|---|---|
|
device_id
必須
|
デバイスの名前 (ID)。 |
|
module_id
必須
|
モジュールの名前 (ID)。 |
|
direct_method_request
必須
|
メソッド要求。 |
戻り値
| 型 | 説明 |
|---|---|
|
CloudToDeviceMethodResult オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
query_iot_hub
IoTHub にクエリを実行し、SQL に似た言語を使用してデバイス ツインに関する情報を取得します。 詳細については、「 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language 」を参照してください。 結果の改ページがサポートされています。 これにより、デバイス ツインに関する情報のみが返されます。
query_iot_hub(query_specification, continuation_token=None, max_item_count=None)パラメーター
| 名前 | 説明 |
|---|---|
|
query
必須
|
クエリの仕様。 |
|
continuation_token
|
ページングの継続トークン 既定値: None
|
|
max_item_count
|
要求されたデバイス ツインの最大数 既定値: None
|
|
query_specification
必須
|
|
戻り値
| 型 | 説明 |
|---|---|
|
QueryResult オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
replace_module_twin
モジュール ツインのタグと必要なプロパティを置き換えます。
replace_module_twin(device_id, module_id, module_twin, etag=None)パラメーター
| 名前 | 説明 |
|---|---|
|
device_id
必須
|
デバイスの名前 (ID)。 |
|
module_id
必須
|
モジュールの名前 (ID)。 |
|
module_twin
必須
|
モジュールのツイン情報。 |
|
etag
|
置換操作に使用する etag (if_match) 値。 既定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
Twin オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
replace_twin
デバイス ツインのタグと必要なプロパティを置き換えます。
replace_twin(device_id, device_twin, etag=None)パラメーター
| 名前 | 説明 |
|---|---|
|
device_id
必須
|
デバイスの名前 (ID)。 |
|
device_twin
必須
|
デバイスのツイン情報。 |
|
etag
|
置換操作に使用する etag (if_match) 値。 既定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
Twin オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
send_c2d_message
IoTHub デバイスに C2D メッセージを送信します。
send_c2d_message(device_id, message, properties={})パラメーター
| 名前 | 説明 |
|---|---|
|
device_id
必須
|
デバイスの名前 (ID)。 |
|
message
必須
|
デバイスに配信されるメッセージ。 |
|
properties
|
メッセージと共に送信するプロパティ。 アプリケーション プロパティとシステム プロパティを含めることができます 既定値: {}
|
例外
| 型 | 説明 |
|---|---|
|
Exception if the Send command is not able to send the message
|
update_device_with_certificate_authority
証明機関を使用して IoTHub でデバイス ID を更新します。
update_device_with_certificate_authority(device_id, etag, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)パラメーター
| 名前 | 説明 |
|---|---|
|
device_id
必須
|
デバイスの名前 (ID)。 |
|
etag
必須
|
更新操作に使用する etag (if_match) 値。 |
|
status
必須
|
作成されたデバイスの初期状態。 (使用可能な値: "enabled" または "disabled")。 |
|
iot_edge
|
作成されたデバイスがIoT Edge デバイスであるかどうか。 既定値: False 既定値: False
|
|
status_reason
|
デバイス ID の状態の理由。 既定値: なし 既定値: None
|
|
device_scope
|
デバイスのスコープ。 既定値: エッジ デバイスに対して自動生成および変更不可なし。リーフ デバイスで変更可能で、子/親リレーションシップを作成できます。 リーフ デバイスの場合、親エッジ デバイスを設定する値は、親エッジ デバイスの device_scope プロパティから取得できます。 既定値: None
|
|
parent_scopes
|
該当する場合は、上位レベルのエッジ デバイスのスコープ。 既定値: None エッジ デバイスの場合、親エッジ デバイスを設定する値は、親エッジ デバイスの device_scope プロパティから取得できます。 リーフ デバイスの場合、これはdevice_scopeと同じ値に設定することも、サービスがコピーする場合は左に設定することもできます。 既定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
作成されたデバイスを含む更新された Device オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_device_with_sas
SAS 認証を使用して IoTHub でデバイス ID を更新します。
update_device_with_sas(device_id, etag, primary_key, secondary_key, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)パラメーター
| 名前 | 説明 |
|---|---|
|
device_id
必須
|
デバイスの名前 (ID)。 |
|
etag
必須
|
更新操作に使用する etag (if_match) 値。 |
|
primary_key
必須
|
プライマリ認証キー。 |
|
secondary_key
必須
|
セカンダリ認証キー。 |
|
status
必須
|
作成されたデバイスの初期状態。 (使用可能な値: "enabled" または "disabled")。 |
|
iot_edge
|
作成されたデバイスがIoT Edge デバイスであるかどうか。 既定値: False 既定値: False
|
|
status_reason
|
デバイス ID の状態の理由。 既定値: なし 既定値: None
|
|
device_scope
|
デバイスのスコープ。 既定値: エッジ デバイスに対して自動生成および変更不可なし。リーフ デバイスで変更可能で、子/親リレーションシップを作成できます。 リーフ デバイスの場合、親エッジ デバイスを設定する値は、親エッジ デバイスの device_scope プロパティから取得できます。 既定値: None
|
|
parent_scopes
|
該当する場合は、上位レベルのエッジ デバイスのスコープ。 既定値: None エッジ デバイスの場合、親エッジ デバイスを設定する値は、親エッジ デバイスの device_scope プロパティから取得できます。 リーフ デバイスの場合、これはdevice_scopeと同じ値に設定することも、サービスがコピーする場合は左に設定することもできます。 既定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
作成されたデバイスを含む更新された Device オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_device_with_x509
X509 認証を使用して IoTHub でデバイス ID を更新します。
update_device_with_x509(device_id, etag, primary_thumbprint, secondary_thumbprint, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)パラメーター
| 名前 | 説明 |
|---|---|
|
device_id
必須
|
デバイスの名前 (ID)。 |
|
etag
必須
|
更新操作に使用する etag (if_match) 値。 |
|
primary_thumbprint
必須
|
プライマリ X509 拇印。 |
|
secondary_thumbprint
必須
|
セカンダリ X509 拇印。 |
|
status
必須
|
作成されたデバイスの初期状態。 (使用可能な値: "enabled" または "disabled")。 |
|
iot_edge
|
作成されたデバイスがIoT Edge デバイスであるかどうか。 既定値: False 既定値: False
|
|
status_reason
|
デバイス ID の状態の理由。 既定値: なし 既定値: None
|
|
device_scope
|
デバイスのスコープ。 既定値: エッジ デバイスに対して自動生成および変更不可なし。リーフ デバイスで変更可能で、子/親リレーションシップを作成できます。 リーフ デバイスの場合、親エッジ デバイスを設定する値は、親エッジ デバイスの device_scope プロパティから取得できます。 既定値: None
|
|
parent_scopes
|
該当する場合は、上位レベルのエッジ デバイスのスコープ。 既定値: None エッジ デバイスの場合、親エッジ デバイスを設定する値は、親エッジ デバイスの device_scope プロパティから取得できます。 リーフ デバイスの場合、これはdevice_scopeと同じ値に設定することも、サービスがコピーする場合は左に設定することもできます。 既定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
作成されたデバイスを含む更新された Device オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_module_twin
モジュール ツインのタグと必要なプロパティを更新します。
update_module_twin(device_id, module_id, module_twin, etag=None)パラメーター
| 名前 | 説明 |
|---|---|
|
device_id
必須
|
デバイスの名前 (ID)。 |
|
module_id
必須
|
モジュールの名前 (ID)。 |
|
module_twin
必須
|
モジュールのツイン情報。 |
|
etag
|
更新操作に使用する etag (if_match) 値。 既定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
Twin オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_module_with_certificate_authority
証明機関を使用して IoTHub 上のデバイスのモジュール ID を更新します。
update_module_with_certificate_authority(device_id, module_id, managed_by, etag)パラメーター
| 名前 | 説明 |
|---|---|
|
device_id
必須
|
デバイスの名前 (ID)。 |
|
module_id
必須
|
モジュールの名前 (ID)。 |
|
managed_by
必須
|
マネージャー デバイス (エッジ) の名前。 |
|
etag
必須
|
更新操作に使用する etag (if_match) 値。 |
戻り値
| 型 | 説明 |
|---|---|
|
作成されたモジュールを含む更新された Module オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_module_with_sas
SAS 認証を使用して IoTHub 上のデバイスのモジュール ID を更新します。
update_module_with_sas(device_id, module_id, managed_by, etag, primary_key, secondary_key)パラメーター
| 名前 | 説明 |
|---|---|
|
device_id
必須
|
デバイスの名前 (ID)。 |
|
module_id
必須
|
モジュールの名前 (ID)。 |
|
managed_by
必須
|
マネージャー デバイス (エッジ) の名前。 |
|
etag
必須
|
更新操作に使用する etag (if_match) 値。 |
|
primary_key
必須
|
プライマリ認証キー。 |
|
secondary_key
必須
|
セカンダリ認証キー。 |
戻り値
| 型 | 説明 |
|---|---|
|
作成されたモジュールを含む更新された Module オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_module_with_x509
X509 認証を使用して IoTHub 上のデバイスのモジュール ID を更新します。
update_module_with_x509(device_id, module_id, managed_by, etag, primary_thumbprint, secondary_thumbprint)パラメーター
| 名前 | 説明 |
|---|---|
|
device_id
必須
|
デバイスの名前 (ID)。 |
|
module_id
必須
|
モジュールの名前 (ID)。 |
|
managed_by
必須
|
マネージャー デバイス (エッジ) の名前。 |
|
etag
必須
|
更新操作に使用する etag (if_match) 値。 |
|
primary_thumbprint
必須
|
プライマリ X509 拇印。 |
|
secondary_thumbprint
必須
|
セカンダリ X509 拇印。 |
戻り値
| 型 | 説明 |
|---|---|
|
作成されたモジュールを含む更新された Module オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_twin
Azure SDK for Python