Megosztás a következőn keresztül:


IoTHubDeviceClient Osztály

Aszinkron eszközügyfél, amely egy Azure IoT Hub-példányhoz csatlakozik.

IoTHubDeviceClient inicializálója.

Ezt az inicializálót nem szabad közvetlenül meghívni. Ehelyett használja az egyik ">>create_from_<<" osztálymetódit a példányosításhoz

Öröklődés
azure.iot.device.iothub.aio.async_clients.GenericIoTHubClient
IoTHubDeviceClient
azure.iot.device.iothub.abstract_clients.AbstractIoTHubDeviceClient
IoTHubDeviceClient

Konstruktor

IoTHubDeviceClient(mqtt_pipeline, http_pipeline)

Paraméterek

mqtt_pipeline
<xref:azure.iot.device.iothub.pipeline.MQTTPipeline>
Kötelező

Az IoTHub-végponthoz való csatlakozáshoz használt folyamat.

http_pipeline
Kötelező

Metódusok

connect

Csatlakoztatja az ügyfelet egy Azure IoT Hub vagy Azure IoT Edge Hub-példányhoz.

A célhelyet az objektum inicializálásakor megadott auth_provider paraméteren keresztül átadott hitelesítő adatok alapján választja ki.

create_from_connection_string

Példányosíthatja az ügyfelet egy IoTHub-eszközről vagy modulból kapcsolati sztring.

create_from_sastoken

Az ügyfél példányosítása egy előre létrehozott SAS-jogkivonat-sztringből

create_from_symmetric_key

Ügyfél példányosítása szimmetrikus kulcsos hitelesítéssel.

create_from_x509_certificate

Ügyfél példányosítása X509-tanúsítványhitelesítéssel.

disconnect

Válassza le az ügyfelet a Azure IoT Hub vagy az Azure IoT Edge Hub-példányról.

Javasoljuk, hogy mindenképpen hívja meg ezt a koroutint, ha teljesen elkészült az ügyfélpéldányával.

get_storage_info_for_blob

POST kérést küld HTTP-kapcsolaton keresztül egy IoTHub-végpontnak, amely adatokat ad vissza az eszközhöz csatlakoztatott IoTHubhoz csatolt Azure Storage-fiókon keresztül történő feltöltéshez.

get_twin

Lekéri az ikereszközt vagy modult a Azure IoT Hub vagy az Azure IoT Edge Hub szolgáltatásból.

notify_blob_upload_status

Amikor a feltöltés befejeződött, az eszköz POST kérést küld a IoT Hub végpontnak, amely információkat tartalmaz a blobba való feltöltési kísérlet állapotáról. Ezt a IoT Hub a figyelési ügyfelek értesítésére használja.

patch_twin_reported_properties

Frissítse a jelentett tulajdonságokat a Azure IoT Hub vagy az Azure IoT Edge Hub szolgáltatással.

Ha a szolgáltatás hibát ad vissza a javítási művelettel kapcsolatban, ez a függvény a megfelelő hibát eredményezi.

receive_message

A Azure IoT Hub küldött üzenet fogadása.

Ha még nem érhető el üzenet, megvárja, amíg egy elem elérhetővé válik.

Elavult a 2.3.0-s verzió óta: Javasoljuk, hogy a .on_message_received tulajdonság használatával állítson be egy kezelőt.

receive_method_request

Metóduskérés fogadása a Azure IoT Hub vagy az Azure IoT Edge Hubon keresztül.

Ha még nem érhető el metóduskérés, megvárja, amíg elérhetővé válik.

Elavult a 2.3.0-s verzió óta: Javasoljuk, hogy a .on_method_request_received tulajdonság használatával állítson be kezelőt.

receive_twin_desired_properties_patch

A kívánt tulajdonságjavítás fogadása a Azure IoT Hub vagy az Azure IoT Edge Hubon keresztül.

Ha még nem érhető el metóduskérés, megvárja, amíg elérhetővé válik.

Elavult a 2.3.0-s verzió óta: Javasoljuk, hogy inkább a .on_twin_desired_properties_patch_received tulajdonságot használja egy kezelő beállításához

send_message

Üzenetet küld a Azure IoT Hub vagy az Azure IoT Edge Hub-példány alapértelmezett eseményvégpontjának.

Ha a szolgáltatáshoz való csatlakozást korábban nem nyitotta meg egy csatlakozási hívás, ez a függvény az esemény elküldése előtt megnyitja a kapcsolatot.

send_method_response

Válasz küldése metóduskérésre az Azure IoT Hub vagy az Azure IoT Edge Hubon keresztül.

Ha a szolgáltatáshoz való csatlakozást korábban nem nyitotta meg egy csatlakozási hívás, ez a függvény az esemény elküldése előtt megnyitja a kapcsolatot.

shutdown

Állítsa le az ügyfelet a szabályos kilépéshez.

A metódus meghívása után a további ügyfélhívásokra tett kísérletek a ClientError indítását eredményezik.

update_sastoken

Frissítse az ügyfél hitelesítéshez használt SAS-jogkivonatát, majd újrahitelesíti a kapcsolatot.

Ez az API csak akkor használható, ha az ügyfél eredetileg SAS-jogkivonattal lett létrehozva.

connect

Csatlakoztatja az ügyfelet egy Azure IoT Hub vagy Azure IoT Edge Hub-példányhoz.

A célhelyet az objektum inicializálásakor megadott auth_provider paraméteren keresztül átadott hitelesítő adatok alapján választja ki.

async connect()

Kivételek

ha a hitelesítő adatok érvénytelenek, és nem hozható létre kapcsolat.

ha egy kapcsolat létrehozása hibát eredményez.

ha a kapcsolat megszakad a végrehajtás során.

ha a kapcsolat túllépi az időkorlátot.

ha a végrehajtás során váratlan hiba történik.

create_from_connection_string

Példányosíthatja az ügyfelet egy IoTHub-eszközről vagy modulból kapcsolati sztring.

create_from_connection_string(connection_string, **kwargs)

Paraméterek

connection_string
str
Kötelező

Annak az IoTHubnak a kapcsolati sztring, amelyhez csatlakozni szeretne.

server_verification_cert
str
Kötelező

Konfigurációs lehetőség. A megbízható tanúsítványlánc. Olyan végponthoz való csatlakozáshoz szükséges, amely nem szabványos megbízhatósági gyökerű, például protokollátjáróval rendelkezik.

websockets
bool
Kötelező

Konfigurációs lehetőség. Az alapértelmezett érték Hamis. Állítsa true (igaz) értékre, ha az MQTT-t websocketeken keresztül használja.

cipher
str vagy list(str)
Kötelező

Konfigurációs lehetőség. Titkosítási csomag(ok) TLS/SSL-hez, "OpenSSL titkosítólista-formátum" sztringként vagy titkosítócsomag-sztringek listájaként.

product_info
str
Kötelező

Konfigurációs lehetőség. Az alapértelmezett érték az üres sztring. A sztring tetszőleges termékadatokat tartalmaz, amelyek hozzá lesznek fűzve a felhasználói ügynök sztringjéhez.

proxy_options
ProxyOptions
Kötelező

A forgalom proxykiszolgálókon keresztüli küldésének lehetőségei.

sastoken_ttl
int
Kötelező

A hitelesítéshez használt létrehozott SasToken élettartamának (másodpercben). Az alapértelmezett érték 3600 másodperc (1 óra).

keep_alive
int
Kötelező

A közvetítővel folytatott kommunikáció közötti maximális időtartam másodpercben. Ha nincs más üzenetváltás, ez szabályozza, hogy az ügyfél milyen sebességgel küld pingüzeneteket a közvetítőnek. Ha nem adja meg az alapértelmezett 60 másodperces értéket, a rendszer a függvényt fogja használni.

auto_connect
bool
Kötelező

Automatikusan csatlakoztassa az ügyfelet az IoTHubhoz egy olyan metódus meghívásakor, amely megköveteli a kapcsolat létrehozását. (Alapértelmezett: Igaz)

connection_retry
bool
Kötelező

Megszakadt kapcsolat újbóli létrehozása (alapértelmezett: Igaz)

connection_retry_interval
int
Kötelező

Megszakadt kapcsolat újbóli létesítésére tett kísérletek közötti időköz másodpercben (alapértelmezett: 10)

ensure_desired_properties
bool
Kötelező

Győződjön meg arról, hogy a legutóbbi kívánt tulajdonságjavítás érkezett az újrakapcsolatok esetén (Alapértelmezett:Igaz)

Válaszok

Egy IoTHub-ügyfél egy példánya, amely kapcsolati sztring használ a hitelesítéshez.

Kivételek

ValueError if given an invalid connection_string.
TypeError if given an unsupported parameter.

create_from_sastoken

Az ügyfél példányosítása egy előre létrehozott SAS-jogkivonat-sztringből

create_from_sastoken(sastoken, **kwargs)

Paraméterek

sastoken
str
Kötelező

Az SAS-jogkivonat sztringje

server_verification_cert
str
Kötelező

Konfigurációs lehetőség. A megbízható tanúsítványlánc. Olyan végponthoz való csatlakozáshoz szükséges, amely nem szabványos megbízhatósági gyökerű, például protokollátjáróval rendelkezik.

gateway_hostname
str
Kötelező

Konfigurációs lehetőség. Az átjáróeszköz átjáró-állomásneve.

websockets
bool
Kötelező

Konfigurációs lehetőség. Az alapértelmezett érték Hamis. Állítsa true (igaz) értékre, ha az MQTT-t websocketeken keresztül használja.

cipher
str vagy list(str)
Kötelező

Konfigurációs lehetőség. Titkosítási csomag(ok) TLS/SSL-hez, "OpenSSL titkosítólista-formátum" sztringként vagy titkosítócsomag-sztringek listájaként.

product_info
str
Kötelező

Konfigurációs lehetőség. Az alapértelmezett érték az üres sztring. A sztring tetszőleges termékadatokat tartalmaz, amelyek hozzá lesznek fűzve a felhasználói ügynök sztringjéhez.

proxy_options
ProxyOptions
Kötelező

A forgalom proxykiszolgálókon keresztüli küldésének lehetőségei.

keep_alive
int
Kötelező

A közvetítővel folytatott kommunikáció közötti maximális időtartam másodpercben. Ha nincs más üzenetváltás, ez szabályozza, hogy az ügyfél milyen sebességgel küld pingüzeneteket a közvetítőnek. Ha nem adja meg az alapértelmezett 60 másodperces értéket, a rendszer a függvényt fogja használni.

auto_connect
bool
Kötelező

Automatikusan csatlakoztassa az ügyfelet az IoTHubhoz egy olyan metódus meghívásakor, amely megköveteli a kapcsolat létrehozását. (Alapértelmezett: Igaz)

connection_retry
bool
Kötelező

Megszakadt kapcsolat újbóli létrehozása (alapértelmezett: Igaz)

connection_retry_interval
int
Kötelező

Megszakadt kapcsolat újbóli létesítésére tett kísérletek közötti időköz másodpercben (alapértelmezett: 10)

ensure_desired_properties
bool
Kötelező

Győződjön meg arról, hogy a legutóbbi kívánt tulajdonságjavítás érkezett az újrakapcsolatok esetén (Alapértelmezett:Igaz)

Kivételek

TypeError if given an unsupported parameter.
ValueError if the sastoken parameter is invalid.

create_from_symmetric_key

Ügyfél példányosítása szimmetrikus kulcsos hitelesítéssel.

create_from_symmetric_key(symmetric_key, hostname, device_id, **kwargs)

Paraméterek

symmetric_key
Kötelező

A szimmetrikus kulcs.

hostname
str
Kötelező

Az IotHubot futtató gazdagép. A sztring állomásneve az Áttekintés lap Azure Portal található.

device_id
Kötelező

Az eszköz azonosítója

server_verification_cert
str
Kötelező

Konfigurációs lehetőség. A megbízható tanúsítványlánc. Olyan végponthoz való csatlakozáshoz szükséges, amely nem szabványos megbízhatósági gyökerű, például protokollátjáróval rendelkezik.

gateway_hostname
str
Kötelező

Konfigurációs lehetőség. Az átjáróeszköz átjáró-állomásneve.

websockets
bool
Kötelező

Konfigurációs lehetőség. Az alapértelmezett érték Hamis. Állítsa true (igaz) értékre, ha az MQTT-t websocketeken keresztül használja.

cipher
str vagy list(str)
Kötelező

Konfigurációs lehetőség. Titkosítási csomag(ok) TLS/SSL-hez, "OpenSSL titkosítólista-formátum" sztringként vagy titkosítócsomag-sztringek listájaként.

product_info
str
Kötelező

Konfigurációs lehetőség. Az alapértelmezett érték az üres sztring. A sztring tetszőleges termékadatokat tartalmaz, amelyek hozzá lesznek fűzve a felhasználói ügynök sztringjéhez.

proxy_options
ProxyOptions
Kötelező

A forgalom proxykiszolgálókon keresztüli küldésének lehetőségei.

sastoken_ttl
int
Kötelező

A hitelesítéshez használt létrehozott SasToken élettartamának (másodpercben). Az alapértelmezett érték 3600 másodperc (1 óra)

keep_alive
int
Kötelező

A közvetítővel folytatott kommunikáció közötti maximális időtartam másodpercben. Ha nincs más üzenetváltás, ez szabályozza, hogy az ügyfél milyen sebességgel küld pingüzeneteket a közvetítőnek. Ha nem adja meg az alapértelmezett 60 másodperces értéket, a rendszer a függvényt fogja használni.

auto_connect
bool
Kötelező

Automatikusan csatlakoztassa az ügyfelet az IoTHubhoz egy olyan metódus meghívásakor, amely megköveteli a kapcsolat létrehozását. (Alapértelmezett: Igaz)

connection_retry
bool
Kötelező

Megszakadt kapcsolat újbóli létrehozása (alapértelmezett: Igaz)

connection_retry_interval
int
Kötelező

Megszakadt kapcsolat újbóli létesítésére tett kísérletek közötti időköz másodpercben (alapértelmezett: 10)

ensure_desired_properties
bool
Kötelező

Győződjön meg arról, hogy a legutóbbi kívánt tulajdonságjavítás érkezett az újrakapcsolatok esetén (Alapértelmezett:Igaz)

Válaszok

Egy IoTHub-ügyfél egy példánya, amely szimmetrikus kulcsot használ a hitelesítéshez.

Kivételek

TypeError if given an unsupported parameter.
ValueError if the provided parameters are invalid.

create_from_x509_certificate

Ügyfél példányosítása X509-tanúsítványhitelesítéssel.

create_from_x509_certificate(x509, hostname, device_id, **kwargs)

Paraméterek

hostname
str
Kötelező

Az IotHubot futtató gazdagép. A sztring állomásneve az Áttekintés lap Azure Portal található.

x509
X509
Kötelező

A teljes x509-tanúsítványobjektum. A tanúsítvány használatához a regisztrációs objektumnak tartalmaznia kell a tanúsítványt (a főtanúsítványt vagy az egyik köztes hitelesítésszolgáltatói tanúsítványt). Ha a tanúsítvány egy CER-fájlból származik, base64 kódolásúnak kell lennie.

device_id
str
Kötelező

Az eszköz egyedi azonosítására használt azonosító az IoTHubon

server_verification_cert
str
Kötelező

Konfigurációs lehetőség. A megbízható tanúsítványlánc. Olyan végponthoz való csatlakozáshoz szükséges, amely nem szabványos megbízhatósági gyökerű, például protokollátjáróval rendelkezik.

gateway_hostname
str
Kötelező

Konfigurációs lehetőség. Az átjáróeszköz átjáró-állomásneve.

websockets
bool
Kötelező

Konfigurációs lehetőség. Az alapértelmezett érték Hamis. Állítsa true (igaz) értékre, ha az MQTT-t websocketeken keresztül használja.

cipher
str vagy list(str)
Kötelező

Konfigurációs lehetőség. Titkosítási csomag(ok) TLS/SSL-hez, "OpenSSL titkosítólista-formátum" sztringként vagy titkosítócsomag-sztringek listájaként.

product_info
str
Kötelező

Konfigurációs lehetőség. Az alapértelmezett érték az üres sztring. A sztring tetszőleges termékadatokat tartalmaz, amelyek hozzá lesznek fűzve a felhasználói ügynök sztringjéhez.

proxy_options
ProxyOptions
Kötelező

A forgalom proxykiszolgálókon keresztüli küldésének lehetőségei.

keep_alive
int
Kötelező

A közvetítővel folytatott kommunikáció közötti maximális időtartam másodpercben. Ha nincs más üzenetváltás, ez szabályozza, hogy az ügyfél milyen sebességgel küld pingüzeneteket a közvetítőnek. Ha nem adja meg az alapértelmezett 60 másodperces értéket, a rendszer a függvényt fogja használni.

auto_connect
bool
Kötelező

Automatikusan csatlakoztassa az ügyfelet az IoTHubhoz egy olyan metódus meghívásakor, amely megköveteli a kapcsolat létrehozását. (Alapértelmezett: Igaz)

connection_retry
bool
Kötelező

Megszakadt kapcsolat újbóli létrehozása (alapértelmezett: Igaz)

connection_retry_interval
int
Kötelező

Megszakadt kapcsolat újbóli létesítésére tett kísérletek közötti időköz másodpercben (alapértelmezett: 10)

ensure_desired_properties
bool
Kötelező

Győződjön meg arról, hogy a legutóbbi kívánt tulajdonságjavítás érkezett az újrakapcsolatok esetén (Alapértelmezett:Igaz)

Válaszok

Egy IoTHub-ügyfél egy példánya, amely X509-tanúsítványt használ a hitelesítéshez.

Kivételek

TypeError if given an unsupported parameter.

disconnect

Válassza le az ügyfelet a Azure IoT Hub vagy az Azure IoT Edge Hub-példányról.

Javasoljuk, hogy mindenképpen hívja meg ezt a koroutint, ha teljesen elkészült az ügyfélpéldányával.

async disconnect()

Kivételek

ha a végrehajtás során váratlan hiba történik.

get_storage_info_for_blob

POST kérést küld HTTP-kapcsolaton keresztül egy IoTHub-végpontnak, amely adatokat ad vissza az eszközhöz csatlakoztatott IoTHubhoz csatolt Azure Storage-fiókon keresztül történő feltöltéshez.

async get_storage_info_for_blob(blob_name)

Paraméterek

blob_name
str
Kötelező

A storage API-val feltöltendő blob sztringformátumú neve. Ez a név fogja létrehozni a storage megfelelő hitelesítő adatait, és meg kell egyeznie azzal, amit az Azure Storage SDK-val használ a blobfeltöltés végrehajtásához.

Válaszok

A IoT Hub JSON-szerű (szótárbeli) objektuma, amely a következő információkat tartalmazza: correlationId, hostName, containerName, blobName, sasToken.

Kivételek

ha a hitelesítő adatok érvénytelenek, és nem hozható létre kapcsolat.

ha egy kapcsolat létrehozása hibát eredményez.

ha a kapcsolat megszakad a végrehajtás során.

ha a kapcsolat túllépi az időkorlátot.

ha a végrehajtás során váratlan hiba történik.

get_twin

Lekéri az ikereszközt vagy modult a Azure IoT Hub vagy az Azure IoT Edge Hub szolgáltatásból.

async get_twin()

Válaszok

Teljes ikerpéldány JSON-diktálásként

Visszatérési típus

Kivételek

ha a hitelesítő adatok érvénytelenek, és nem hozható létre kapcsolat.

ha egy kapcsolat létrehozása hibát eredményez.

ha a kapcsolat megszakad a végrehajtás során.

ha a csatlakozási kísérlet túllépi az időkorlátot

ha az ügyfél nincs csatlakoztatva (és nincs engedélyezve az automatikus csatlakozás)

ha a végrehajtás során váratlan hiba történik.

notify_blob_upload_status

Amikor a feltöltés befejeződött, az eszköz POST kérést küld a IoT Hub végpontnak, amely információkat tartalmaz a blobba való feltöltési kísérlet állapotáról. Ezt a IoT Hub a figyelési ügyfelek értesítésére használja.

async notify_blob_upload_status(correlation_id, is_success, status_code, status_description)

Paraméterek

correlation_id
str
Kötelező

A IoT Hub get_storage_info_for_blob kérésre.

is_success
bool
Kötelező

Logikai érték, amely azt jelzi, hogy a fájl feltöltése sikerült-e.

status_code
int
Kötelező

Numerikus állapotkód, amely a fájl tárba való feltöltésének állapota.

status_description
str
Kötelező

A status_code megfelelő leírás.

Kivételek

ha a hitelesítő adatok érvénytelenek, és nem hozható létre kapcsolat.

ha egy kapcsolat létrehozása hibát eredményez.

ha a kapcsolat megszakad a végrehajtás során.

ha a kapcsolat túllépi az időkorlátot.

ha a végrehajtás során váratlan hiba történik.

patch_twin_reported_properties

Frissítse a jelentett tulajdonságokat a Azure IoT Hub vagy az Azure IoT Edge Hub szolgáltatással.

Ha a szolgáltatás hibát ad vissza a javítási művelettel kapcsolatban, ez a függvény a megfelelő hibát eredményezi.

async patch_twin_reported_properties(reported_properties_patch)

Paraméterek

reported_properties_patch
dict
Kötelező

Twin Reported Properties patch as a JSON dict

Kivételek

ha a hitelesítő adatok érvénytelenek, és nem hozható létre kapcsolat.

ha egy kapcsolat létrehozása hibát eredményez.

ha a kapcsolat megszakad a végrehajtás során.

ha a csatlakozási kísérlet túllépi az időkorlátot

ha az ügyfél nincs csatlakoztatva (és nincs engedélyezve az automatikus csatlakozás)

ha a végrehajtás során váratlan hiba történik.

receive_message

A Azure IoT Hub küldött üzenet fogadása.

Ha még nem érhető el üzenet, megvárja, amíg egy elem elérhetővé válik.

Elavult a 2.3.0-s verzió óta: Javasoljuk, hogy a .on_message_received tulajdonság használatával állítson be egy kezelőt.

receive_message()

Válaszok

A Azure IoT Hub küldött üzenet.

Visszatérési típus

Kivételek

ha a hitelesítő adatok érvénytelenek, és nem hozható létre kapcsolat.

ha egy kapcsolat létrehozása hibát eredményez.

ha a kapcsolat megszakad a végrehajtás során.

ha a kapcsolat túllépi az időkorlátot.

ha a végrehajtás során váratlan hiba történik.

receive_method_request

Metóduskérés fogadása a Azure IoT Hub vagy az Azure IoT Edge Hubon keresztül.

Ha még nem érhető el metóduskérés, megvárja, amíg elérhetővé válik.

Elavult a 2.3.0-s verzió óta: Javasoljuk, hogy a .on_method_request_received tulajdonság használatával állítson be kezelőt.

receive_method_request(method_name=None)

Paraméterek

method_name
str
alapértelmezett érték: None

Igény szerint adja meg annak a metódusnak a nevét, amelyre a kérelmeket fogadni szeretné. Ha ez a paraméter nincs megadva, az összes metódust, amelyet még nem célzott meg egy másik hívás receive_method, a rendszer fogadja.

Válaszok

A fogadott metóduskérést jelölő MethodRequest objektum.

Visszatérési típus

Kivételek

ha a hitelesítő adatok érvénytelenek, és nem hozható létre kapcsolat.

ha egy kapcsolat létrehozása hibát eredményez.

ha a kapcsolat megszakad a végrehajtás során.

ha a kapcsolat túllépi az időkorlátot.

ha a végrehajtás során váratlan hiba történik.

receive_twin_desired_properties_patch

A kívánt tulajdonságjavítás fogadása a Azure IoT Hub vagy az Azure IoT Edge Hubon keresztül.

Ha még nem érhető el metóduskérés, megvárja, amíg elérhetővé válik.

Elavult a 2.3.0-s verzió óta: Javasoljuk, hogy inkább a .on_twin_desired_properties_patch_received tulajdonságot használja egy kezelő beállításához

receive_twin_desired_properties_patch()

Válaszok

Ikerpéldány kívánt tulajdonságainak javítása JSON-diktálásként

Visszatérési típus

Kivételek

ha a hitelesítő adatok érvénytelenek, és nem hozható létre kapcsolat.

ha egy kapcsolat létrehozása hibát eredményez.

ha a kapcsolat megszakad a végrehajtás során.

ha a kapcsolat túllépi az időkorlátot.

ha a végrehajtás során váratlan hiba történik.

send_message

Üzenetet küld a Azure IoT Hub vagy az Azure IoT Edge Hub-példány alapértelmezett eseményvégpontjának.

Ha a szolgáltatáshoz való csatlakozást korábban nem nyitotta meg egy csatlakozási hívás, ez a függvény az esemény elküldése előtt megnyitja a kapcsolatot.

async send_message(message)

Paraméterek

message
Message
Kötelező

A tényleges elküldendő üzenet. A rendszer minden olyan átadott üzenetet, amely nem az Üzenet osztály egy példánya, üzenetobjektummá lesz konvertálva.

Kivételek

ha a hitelesítő adatok érvénytelenek, és nem hozható létre kapcsolat.

ha egy kapcsolat létrehozása hibát eredményez.

ha a kapcsolat megszakad a végrehajtás során.

ha a csatlakozási kísérlet túllépi az időkorlátot

ha az ügyfél nincs csatlakoztatva (és nincs engedélyezve az automatikus csatlakozás)

ha a végrehajtás során váratlan hiba történik.

ValueError if the message fails size validation.

send_method_response

Válasz küldése metóduskérésre az Azure IoT Hub vagy az Azure IoT Edge Hubon keresztül.

Ha a szolgáltatáshoz való csatlakozást korábban nem nyitotta meg egy csatlakozási hívás, ez a függvény az esemény elküldése előtt megnyitja a kapcsolatot.

async send_method_response(method_response)

Paraméterek

method_response
MethodResponse
Kötelező

A küldendő MethodResponse

Kivételek

ha a hitelesítő adatok érvénytelenek, és nem hozható létre kapcsolat.

ha egy kapcsolat létrehozása hibát eredményez.

ha a kapcsolat megszakad a végrehajtás során.

ha a csatlakozási kísérlet túllépi az időkorlátot

ha az ügyfél nincs csatlakoztatva (és nincs engedélyezve az automatikus csatlakozás)

ha a végrehajtás során váratlan hiba történik.

shutdown

Állítsa le az ügyfelet a szabályos kilépéshez.

A metódus meghívása után a további ügyfélhívásokra tett kísérletek a ClientError indítását eredményezik.

async shutdown()

Kivételek

ha a végrehajtás során váratlan hiba történik.

update_sastoken

Frissítse az ügyfél hitelesítéshez használt SAS-jogkivonatát, majd újrahitelesíti a kapcsolatot.

Ez az API csak akkor használható, ha az ügyfél eredetileg SAS-jogkivonattal lett létrehozva.

async update_sastoken(sastoken)

Paraméterek

sastoken
str
Kötelező

Az ügyfél új SAS-jogkivonat-sztringje

Kivételek

ValueError if the sastoken parameter is invalid

ha a hitelesítő adatok érvénytelenek, és nem hozható létre újra kapcsolat.

ha a kapcsolat újbóli létrehozása hibát eredményez.

ha a kapcsolat megszakad a végrehajtás során.

ha az újrahitelesítési kísérlet túllépi az időkorlátot.

ha az ügyfél eredetileg nem SAS-jogkivonattal lett létrehozva.

ha a végrehajtás során váratlan hiba történik.

Attribútumok

connected

Írásvédett tulajdonság, amely jelzi, hogy az átvitel csatlakoztatva van-e.

on_background_exception

Háttérkivétel esetén a kezelőfüggvény vagy a coroutine lesz meghívva.

A függvény vagy a koroutin definíciójának egy pozícióargumentumot kell használnia (a kivételobjektumot)

on_connection_state_change

A kezelőfüggvény vagy a coroutine, amely a kapcsolati állapot változásakor lesz meghívva.

A függvény vagy a koroutin definíciója nem vehet fel pozícióargumentumokat.

on_message_received

A kezelőfüggvény vagy coroutine, amely az üzenet érkezésekor lesz meghívva.

A függvény vagy a koroutin definíciójának egy pozícióargumentumot (az objektumot) kell használnia Message .

on_method_request_received

A kezelőfüggvény vagy a coroutine, amely a metóduskérés fogadásakor lesz meghívva.

Ne felejtse el nyugtázni a metóduskérést a függvényben vagy a coroutine-ban az ügyfél .send_method_response() metódusának használatával.

A függvény vagy a koroutin definíciójának egy pozícióargumentumot (az objektumot) kell használnia MethodRequest .

on_new_sastoken_required

A kezelőfüggvény vagy coroutine, amely akkor lesz meghívva, ha az ügyfél új SAS-jogkivonatot igényel. Ez körülbelül 2 perccel az SAS-jogkivonat lejárata előtt fog megtörténni. Windows-platformokon, ha az élettartam meghaladja a körülbelül 49 napot, a 49 nap után új jogkivonatra lesz szükség, függetlenül attól, hogy mennyi az SAS-élettartam.

Vegye figyelembe, hogy ez a kezelő CSAK akkor szükséges, ha a .create_from_sastoken() metódussal létrehozott ügyfelet használ.

Az új jogkivonat az ügyfél .update_sastoken() metódusának használatával adható meg a függvényben vagy a coroutine-ban.

A függvény vagy a koroutin definíciója nem vehet fel pozícióargumentumokat.

on_twin_desired_properties_patch_received

A kezelőfüggvény vagy a coroutine, amely az ikerpéldány kívánt tulajdonságainak javításakor lesz meghívva.

A függvény vagy a koroutin definíciójának egy pozícióargumentumot kell használnia (az ikerjavítás JSON szótárobjektum formájában)