ModulesOperations Osztály

ModulesOperations műveletek.

Öröklődés

builtins.object

ModulesOperations

Konstruktor

ModulesOperations(client, config, serializer, deserializer)

Paraméterek

client

Kötelező

Ügyfél a szolgáltatáskérésekhez.

config

Kötelező

A szolgáltatásügyfél konfigurálása.

serializer

Kötelező

Egy objektummodell szerializálója.

deserializer

Kötelező

Objektummodell-deszerializáló.

Változók

api_version

Az API verziója. Állandó érték: "2021-04-12".

Metódusok

create_or_update_identity	Létrehozza vagy frissíti egy eszköz modulidentitását a IoT Hub. A felhasználó nem tudja frissíteni a moduleId és a generationId azonosítót.
delete_identity	Törli egy eszköz modulidentitását a IoT Hub.
get_identity	Lekéri a modulidentitást az eszközön.
get_modules_on_device	Lekéri az eszközön található összes modulidentitást.
get_twin	Lekéri a modul ikerpéldányát. További információ: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.
invoke_method	Közvetlen metódust hív meg egy eszköz modulján. További információ: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods.
replace_twin	Lecseréli egy moduli ikerpéldány címkéit és kívánt tulajdonságait. További információ: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.
update_twin	Frissítések egy moduli ikerpéldány címkéinek és kívánt tulajdonságainak. További információ: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.

create_or_update_identity

Létrehozza vagy frissíti egy eszköz modulidentitását a IoT Hub. A felhasználó nem tudja frissíteni a moduleId és a generationId azonosítót.

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

Paraméterek

id

str

Kötelező

Az eszköz egyedi azonosítója.

mid

str

Kötelező

A modul egyedi azonosítója.

module

Module

Kötelező

A modul identitása.

if_match

str

alapértelmezett érték: None

A modul gyenge ETag-jének megfelelő sztring az RFC7232 szerint. Ezt nem szabad beállítani modul létrehozásakor, de a modul frissítésekor be lehet állítani.

custom_headers

dict

alapértelmezett érték: None

a kérelemhez hozzáadandó fejlécek

raw

bool

alapértelmezett érték: False

a deszerializált válasz mellett a közvetlen választ adja vissza

operation_config

Kötelező

Műveleti konfiguráció felülbírálásai.

Válaszok

Modul vagy ClientRawResponse, ha raw=true

Visszatérési típus

Module,

ClientRawResponse

Kivételek

HttpOperationError

delete_identity

Törli egy eszköz modulidentitását a IoT Hub.

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

Paraméterek

id

str

Kötelező

A deivce egyedi azonosítója.

mid

str

Kötelező

A modul egyedi azonosítója.

if_match

str

alapértelmezett érték: None

A modul gyenge ETag-jének megfelelő sztring az RFC7232 szerint. A törlési műveletet csak akkor hajtja végre a rendszer, ha ez az ETag megegyezik a kiszolgáló által fenntartott értékkel, ami azt jelzi, hogy a modul nem lett módosítva a legutóbbi lekérése óta. Feltétel nélküli törlés kényszerítéséhez állítsa a If-Match helyettesítő karakterre (*).

custom_headers

dict

alapértelmezett érték: None

a kérelemhez hozzáadandó fejlécek

raw

bool

alapértelmezett érték: False

a deszerializált válasz mellett a közvetlen választ adja vissza

operation_config

Kötelező

Műveleti konfiguráció felülbírálásai.

Válaszok

Nincs vagy ClientRawResponse, ha raw=true

Visszatérési típus

None,

ClientRawResponse

Kivételek

HttpOperationError

get_identity

Lekéri a modulidentitást az eszközön.

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

Paraméterek

id

str

Kötelező

Az eszköz egyedi azonosítója.

mid

str

Kötelező

A modul egyedi azonosítója.

custom_headers

dict

alapértelmezett érték: None

a kérelemhez hozzáadandó fejlécek

raw

bool

alapértelmezett érték: False

a deszerializált válasz mellett a közvetlen választ adja vissza

operation_config

Kötelező

Műveleti konfiguráció felülbírálásai.

Válaszok

Modul vagy ClientRawResponse, ha raw=true

Visszatérési típus

Module,

ClientRawResponse

Kivételek

HttpOperationError

get_modules_on_device

Lekéri az eszközön található összes modulidentitást.

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

Paraméterek

id

str

Kötelező

Az eszköz egyedi azonosítója.

custom_headers

dict

alapértelmezett érték: None

a kérelemhez hozzáadandó fejlécek

raw

bool

alapértelmezett érték: False

a deszerializált válasz mellett a közvetlen választ adja vissza

operation_config

Kötelező

Műveleti konfiguráció felülbírálásai.

Válaszok

list vagy ClientRawResponse if raw=true

Visszatérési típus

list[Module],

ClientRawResponse

Kivételek

HttpOperationError

get_twin

Lekéri a modul ikerpéldányát. További információ: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.

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

Paraméterek

id

str

Kötelező

Az eszköz egyedi azonosítója.

mid

str

Kötelező

A modul egyedi azonosítója.

custom_headers

dict

alapértelmezett érték: None

a kérelemhez hozzáadandó fejlécek

raw

bool

alapértelmezett érték: False

a deszerializált válasz mellett a közvetlen választ adja vissza

operation_config

Kötelező

Műveleti konfiguráció felülbírálásai.

Válaszok

Ikerpéldány vagy ClientRawResponse, ha raw=true

Visszatérési típus

Twin,

ClientRawResponse

Kivételek

HttpOperationError

invoke_method

Közvetlen metódust hív meg egy eszköz modulján. További információ: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods.

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

Paraméterek

device_id

str

Kötelező

Az eszköz egyedi azonosítója.

module_id

str

Kötelező

A modul egyedi azonosítója.

direct_method_request

CloudToDeviceMethod

Kötelező

A modul közvetlen metódusának végrehajtásához használt paraméterek.

custom_headers

dict

alapértelmezett érték: None

a kérelemhez hozzáadandó fejlécek

raw

bool

alapértelmezett érték: False

a deszerializált válasz mellett a közvetlen választ adja vissza

operation_config

Kötelező

Műveleti konfiguráció felülbírálásai.

Válaszok

CloudToDeviceMethodResult vagy ClientRawResponse, ha raw=true

Visszatérési típus

CloudToDeviceMethodResult,

ClientRawResponse

Kivételek

HttpOperationError

replace_twin

Lecseréli egy moduli ikerpéldány címkéit és kívánt tulajdonságait. További információ: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.

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

Paraméterek

id

str

Kötelező

Az eszköz egyedi azonosítója.

mid

str

Kötelező

A modul egyedi azonosítója.

device_twin_info

Twin

Kötelező

A modul ikeradatai, amelyek lecserélik a meglévő adatokat.

if_match

str

alapértelmezett érték: None

Az ikereszköz gyenge ETag-jének sztringje az RFC7232 szerint. Meghatározza, hogy a csereműveletet végre kell-e hajtani.

custom_headers

dict

alapértelmezett érték: None

a kérelemhez hozzáadandó fejlécek

raw

bool

alapértelmezett érték: False

a deszerializált válasz mellett a közvetlen választ adja vissza

operation_config

Kötelező

Műveleti konfiguráció felülbírálásai.

Válaszok

Ikerpéldány vagy ClientRawResponse, ha raw=true

Visszatérési típus

Twin,

ClientRawResponse

Kivételek

HttpOperationError

update_twin

Frissítések egy moduli ikerpéldány címkéinek és kívánt tulajdonságainak. További információ: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.

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

Paraméterek

id

str

Kötelező

Az eszköz egyedi azonosítója.

mid

str

Kötelező

A modul egyedi azonosítója.

device_twin_info

Twin

Kötelező

A frissíteni kívánt címkéket és kívánt tulajdonságokat tartalmazó ikermodul-információ.

if_match

str

alapértelmezett érték: None

Az ikereszköz gyenge ETag-jének sztringje az RFC7232 szerint. Meghatározza, hogy a frissítési műveletet végre kell-e hajtani.

custom_headers

dict

alapértelmezett érték: None

a kérelemhez hozzáadandó fejlécek

raw

bool

alapértelmezett érték: False

a deszerializált válasz mellett a közvetlen választ adja vissza

operation_config

Kötelező

Műveleti konfiguráció felülbírálásai.

Válaszok

Ikerpéldány vagy ClientRawResponse, ha raw=true

Visszatérési típus

Twin,

ClientRawResponse

Kivételek

HttpOperationError

Attribútumok

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'>