DevicesOperations クラス

  • リファレンス

DevicesOperations 操作。

継承
builtins.object
DevicesOperations

コンストラクター

DevicesOperations(client, config, serializer, deserializer)

パラメーター

client
必須

サービス要求のクライアント。

config
必須

サービス クライアントの構成。

serializer
必須

オブジェクト モデル シリアライザー。

deserializer
必須

オブジェクト モデル逆シリアライザー。

変数

api_version

Api のバージョン。 定数値: "2021-04-12"

メソッド

create_or_update_identity

IoT Hubの ID レジストリでデバイスの ID を作成または更新します。
delete_identity

IoT Hubの ID レジストリからデバイスの ID を削除します。
get_devices

IoT Hub ID レジストリから複数のデバイスの ID を取得します。 非推奨。 IoT Hub クエリ API を使用して、デバイス ツインとデバイス 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_identity

IoT Hubの ID レジストリからデバイスを取得します。
get_twin

デバイス ツインを取得します。 詳細については、「 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins 」を参照してください。
invoke_method

デバイスでダイレクト メソッドを呼び出します。 詳細については、「 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods 」を参照してください。
replace_twin

デバイス ツインのタグと必要なプロパティを置き換えます。 詳細については、「 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins 」を参照してください。
update_twin

デバイス ツインのタグと必要なプロパティを更新します。 詳細については、「 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins 」を参照してください。

create_or_update_identity

IoT Hubの ID レジストリでデバイスの ID を作成または更新します。

create_or_update_identity(id, device, if_match=None, custom_headers=None, raw=False, **operation_config)

パラメーター

id
str
必須

デバイスの一意識別子。

device
Device
必須

デバイス ID の内容。

if_match
str
既定値: None

RFC7232 に従って、デバイス ID の弱い ETag を表す文字列。 これは、デバイスの作成時には設定しないでくださいが、デバイスを更新するときに設定される場合があります。

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド。

戻り値

device or ClientRawResponse if raw=true

の戻り値の型 :

Device,
ClientRawResponse

例外

HttpOperationError

delete_identity

IoT Hubの ID レジストリからデバイスの ID を削除します。

delete_identity(id, if_match=None, custom_headers=None, raw=False, **operation_config)

パラメーター

id
str
必須

デバイスの一意識別子。

if_match
str
既定値: None

RFC7232 に従って、デバイス ID の弱い ETag を表す文字列。 削除操作は、この ETag がサーバーによって保持されている値と一致する場合にのみ実行されます。これは、デバイス ID が最後に取得されてから変更されていないことを示します。 無条件削除を強制するには、If-Matchをワイルドカード文字 (*) に設定します。

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド。

戻り値

none または ClientRawResponse (raw=true の場合)

の戻り値の型 :

None,
ClientRawResponse

例外

HttpOperationError

get_devices

IoT Hub ID レジストリから複数のデバイスの ID を取得します。 非推奨。 IoT Hub クエリ API を使用して、デバイス ツインとデバイス 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(top=None, custom_headers=None, raw=False, **operation_config)

パラメーター

top
int
既定値: None

クエリによって返されるデバイス ID の最大数。 1 から 1000 の範囲外の値は 1000 と見なされます。

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド。

戻り値

list または ClientRawResponse (raw=true の場合)

の戻り値の型 :

list[Device],
ClientRawResponse

例外

HttpOperationError

get_identity

IoT Hubの ID レジストリからデバイスを取得します。

get_identity(id, custom_headers=None, raw=False, **operation_config)

パラメーター

id
str
必須

デバイスの一意識別子。

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド。

戻り値

device or ClientRawResponse if raw=true

の戻り値の型 :

Device,
ClientRawResponse

例外

HttpOperationError

get_twin

デバイス ツインを取得します。 詳細については、「 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins 」を参照してください。

get_twin(id, custom_headers=None, raw=False, **operation_config)

パラメーター

id
str
必須

デバイスの一意識別子。

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド。

戻り値

ツインまたは ClientRawResponse (raw=true の場合)

の戻り値の型 :

Twin,
ClientRawResponse

例外

HttpOperationError

invoke_method

デバイスでダイレクト メソッドを呼び出します。 詳細については、「 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods 」を参照してください。

invoke_method(device_id, direct_method_request, custom_headers=None, raw=False, **operation_config)

パラメーター

device_id
str
必須

デバイスの一意識別子。

direct_method_request
CloudToDeviceMethod
必須

デバイスでダイレクト メソッドを実行するパラメーター。

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド。

戻り値

CloudToDeviceMethodResult または ClientRawResponse (raw=true の場合)

の戻り値の型 :

CloudToDeviceMethodResult,
ClientRawResponse

例外

HttpOperationError

replace_twin

デバイス ツインのタグと必要なプロパティを置き換えます。 詳細については、「 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins 」を参照してください。

replace_twin(id, device_twin_info, if_match=None, custom_headers=None, raw=False, **operation_config)

パラメーター

id
str
必須

デバイスの一意識別子。

device_twin_info
Twin
必須

既存の情報を置き換えるデバイス ツイン情報。

if_match
str
既定値: None

RFC7232 に従って、デバイス ツインの弱い ETag を表す文字列。 置換操作を実行する必要があるかどうかを決定します。

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド。

戻り値

ツインまたは ClientRawResponse (raw=true の場合)

の戻り値の型 :

Twin,
ClientRawResponse

例外

HttpOperationError

update_twin

デバイス ツインのタグと必要なプロパティを更新します。 詳細については、「 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins 」を参照してください。

update_twin(id, device_twin_info, if_match=None, custom_headers=None, raw=False, **operation_config)

パラメーター

id
str
必須

デバイスの一意識別子。

device_twin_info
Twin
必須

タグと更新する必要なプロパティを含むデバイス ツイン情報。

if_match
str
既定値: None

RFC7232 に従って、デバイス ツインの弱い ETag を表す文字列。 更新操作を実行する必要があるかどうかを決定します。

custom_headers
dict
既定値: None

要求に追加されるヘッダー

raw
bool
既定値: False

は、逆シリアル化された応答と共に直接応答を返します

operation_config
必須

操作構成のオーバーライド。

戻り値

ツインまたは ClientRawResponse (raw=true の場合)

の戻り値の型 :

Twin,
ClientRawResponse

例外

HttpOperationError

属性

models 

models = <module 'azure.iot.hub.protocol.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\iot\\hub\\protocol\\models\\__init__.py'>