IoTHubModuleClient Osztály
Szinkron modulügyfél, amely egy Azure IoT Hub vagy Azure IoT Edge-példányhoz csatlakozik.
IoTHubModuleClient 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.sync_clients.GenericIoTHubClientIoTHubModuleClientazure.iot.device.iothub.abstract_clients.AbstractIoTHubModuleClientIoTHubModuleClient
Konstruktor
IoTHubModuleClient(mqtt_pipeline, http_pipeline)Paraméterek
- mqtt_pipeline
- <xref:azure.iot.device.iothub.pipeline.MQTTPipeline>
Az IoTHub-végponthoz való csatlakozáshoz használt folyamat.
- http_pipeline
- <xref:azure.iot.device.iothub.pipeline.HTTPPipeline>
Az IoTHub-végponthoz HTTP-en keresztüli csatlakozáshoz használt folyamat.
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. Ez egy szinkron hívás, ami azt jelenti, hogy ez a függvény addig nem tér vissza, amíg a szolgáltatáshoz való kapcsolat teljesen létre nem jön. |
| create_from_connection_string |
Példányosíthatja az ügyfelet egy IoTHub-eszközről vagy modulból kapcsolati sztring. |
| create_from_edge_environment |
Az ügyfél példányosítása a IoT Edge környezetből. Ez a módszer csak egy IoT Edge tárolóból vagy edge-fejlesztéshez konfigurált hibakeresési környezetben futtatható (pl. Visual Studio, Visual Studio Code) |
| create_from_sastoken |
Az ügyfél példányosítása egy előre létrehozott SAS-jogkivonat-sztringből |
| 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 függvényt, ha teljesen elkészült az ügyfélpéldánysal. Ez egy szinkron hívás, ami azt jelenti, hogy ez a függvény csak akkor tér vissza, ha a szolgáltatáshoz való kapcsolat teljesen lezárult. |
| get_twin |
Lekéri az ikereszközt vagy modult a Azure IoT Hub vagy az Azure IoT Edge Hub szolgáltatásból. Ez egy szinkron hívás, ami azt jelenti, hogy ez a függvény csak akkor tér vissza, ha az ikerpéldányt le nem kérik a szolgáltatásból. |
| invoke_method |
Metódus meghívása az ügyfélről egy eszköz- vagy modulügyfélre, és a metódushívásra adott válasz fogadása. |
| patch_twin_reported_properties |
Frissítse a jelentett tulajdonságokat a Azure IoT Hub vagy az Azure IoT Edge Hub szolgáltatással. Ez egy szinkron hívás, ami azt jelenti, hogy ez a függvény addig nem tér vissza, amíg a javítást el nem küldi a szolgáltatásnak, és nem nyugtázza. 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_on_input |
Egy másik modulból egy adott bemenetre küldött bemeneti üzenet fogadása. 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. 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. Ez egy szinkron hívás, ami a következőket jelenti:
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. Ez egy szinkron esemény, ami azt jelenti, hogy ez a függvény addig nem tér vissza, amíg az eseményt el nem küldik a szolgáltatásnak, és a szolgáltatás nem nyugtázta az esemény fogadását. 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_message_to_output |
Eseményt/üzenetet küld a megadott modulkimenetnek. Ezek kimenő események, és "kimeneti eseményeknek" szánták őket. Ez egy szinkron esemény, ami azt jelenti, hogy ez a függvény addig nem tér vissza, amíg az eseményt el nem küldik a szolgáltatásnak, és a szolgáltatás nem nyugtázta az esemény fogadását. 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. Ez egy szinkron esemény, ami azt jelenti, hogy ez a függvény addig nem tér vissza, amíg az eseményt el nem küldik a szolgáltatásnak, és a szolgáltatás nem nyugtázta az esemény fogadását. 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.
Ez egy szinkron hívás, ami azt jelenti, hogy ez a függvény addig nem tér vissza, amíg a szolgáltatáshoz való kapcsolat teljesen létre nem jön.
connect()Kivételek
ha a hitelesítő adatok érvénytelenek, és nem hozható létre kapcsolat.
ha egy kapcsolat létrehozása sikertelenséget 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
- server_verification_cert
- str
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
Konfigurációs lehetőség. Az alapértelmezett érték Hamis. Állítsa igaz értékre, ha az MQTT-t websocketeken keresztül használja.
Konfigurációs lehetőség. Titkosítási csomag(ok) TLS-hez/SSL-hez, "OpenSSL titkosítási listaformátumban" vagy titkosítócsomag-sztringek listájaként.
- product_info
- str
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
A proxykiszolgálókon keresztüli forgalom küldésének lehetőségei.
- sastoken_ttl
- int
A hitelesítéshez használt létrehozott SasToken élettartama (másodpercben). Az alapértelmezett érték 3600 másodperc (1 óra).
- keep_alive
- int
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 a 60 másodperces alapértelmezett értéket, akkor a rendszer az alapértelmezett értéket használja.
- auto_connect
- bool
Automatikusan csatlakoztassa az ügyfelet az IoTHubhoz egy metódus meghívásakor, amely megköveteli a kapcsolat létrehozását. (Alapértelmezett: Igaz)
- connection_retry_interval
- int
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
Győződjön meg arról, hogy a legutóbbi kívánt tulajdonságjavítás érkezett az újracsatlakozásokkor (Alapértelmezett:Igaz)
Válaszok
Egy IoTHub-ügyfél egy példánya, amely kapcsolati sztring használ a hitelesítéshez.
Kivételek
create_from_edge_environment
Az ügyfél példányosítása a IoT Edge környezetből.
Ez a módszer csak egy IoT Edge tárolóból vagy edge-fejlesztéshez konfigurált hibakeresési környezetben futtatható (pl. Visual Studio, Visual Studio Code)
create_from_edge_environment(**kwargs)Paraméterek
- websockets
- bool
Konfigurációs lehetőség. Az alapértelmezett érték Hamis. Állítsa igaz értékre, ha az MQTT-t websocketeken keresztül használja.
Konfigurációs lehetőség. Titkosítási csomag(ok) TLS-hez/SSL-hez, "OpenSSL titkosítási listaformátumban" vagy titkosítócsomag-sztringek listájaként.
- product_info
- str
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
A proxykiszolgálókon keresztüli forgalom küldésének lehetőségei.
- sastoken_ttl
- int
A hitelesítéshez használt létrehozott SasToken élettartama (másodpercben). Az alapértelmezett érték 3600 másodperc (1 óra)
- keep_alive
- int
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 a 60 másodperces alapértelmezett értéket, akkor a rendszer az alapértelmezett értéket használja.
- auto_connect
- bool
Automatikusan csatlakoztassa az ügyfelet az IoTHubhoz egy metódus meghívásakor, amely megköveteli a kapcsolat létrehozását. (Alapértelmezett: Igaz)
- connection_retry_interval
- int
Megszakadt kapcsolat újbóli létesítésére tett kísérletek közötti időköz másodpercben (alapértelmezett: 10)
Válaszok
Egy IoTHub-ügyfél egy példánya, amely a IoT Edge környezetet használja a hitelesítéshez.
Kivételek
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
- server_verification_cert
- str
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
Konfigurációs lehetőség. Az alapértelmezett érték Hamis. Állítsa igaz értékre, ha az MQTT-t websocketeken keresztül használja.
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
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
A forgalom proxykiszolgálókon keresztüli küldésének lehetőségei.
- keep_alive
- int
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
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_interval
- int
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
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
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, module_id, **kwargs)Paraméterek
- hostname
- str
Az IotHubot futtató gazdagép. A sztring állomásneve az Áttekintés lap Azure Portal található.
- x509
- X509
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.
- module_id
- str
Az IoTHubon található eszköz egy moduljának egyedi azonosítására használt azonosító.
- server_verification_cert
- str
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
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.
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
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
A forgalom proxykiszolgálókon keresztüli küldésének lehetőségei.
- keep_alive
- int
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
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_interval
- int
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
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
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 függvényt, ha teljesen elkészült az ügyfélpéldánysal.
Ez egy szinkron hívás, ami azt jelenti, hogy ez a függvény csak akkor tér vissza, ha a szolgáltatáshoz való kapcsolat teljesen lezárult.
disconnect()Kivételek
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.
Ez egy szinkron hívás, ami azt jelenti, hogy ez a függvény csak akkor tér vissza, ha az ikerpéldányt le nem kérik a szolgáltatásból.
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.
invoke_method
Metódus meghívása az ügyfélről egy eszköz- vagy modulügyfélre, és a metódushívásra adott válasz fogadása.
invoke_method(method_params, device_id, module_id=None)Paraméterek
- method_params
- dict
Tartalmaznia kell egy methodName (str), payload (str), connectTimeoutInSeconds (int), responseTimeoutInSeconds (int) metódust.
- module_id
- str
Annak a célmodulnak a modulazonosítója, amelyben a metódus meghívásra kerül. (Nem kötelező)
Válaszok
method_result tartalmaznia kell egy állapotot és egy hasznos adatokat
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 sikertelenséget 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.
Ez egy szinkron hívás, ami azt jelenti, hogy ez a függvény addig nem tér vissza, amíg a javítást el nem küldi a szolgáltatásnak, és nem nyugtázza.
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.
patch_twin_reported_properties(reported_properties_patch)Paraméterek
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_on_input
Egy másik modulból egy adott bemenetre küldött bemeneti üzenet fogadása.
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_on_input(input_name, block=True, timeout=None)Paraméterek
- block
- bool
Azt jelzi, hogy a műveletnek blokkolnia kell-e, amíg egy üzenet meg nem érkezik.
- timeout
- int
Igény szerint adjon meg néhány másodpercet, amíg a blokkolás túllépi az időkorlátot.
Válaszok
A megadott bemenetnek küldött üzenet, vagy Nincs, ha a blokkolási időszak végéig nem érkezett metóduskérés.
Kivételek
ha a hitelesítő adatok érvénytelenek, és nem hozható létre kapcsolat.
ha egy kapcsolat létrehozása sikertelenséget 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.
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, block=True, timeout=None)Paraméterek
- method_name
- str
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, a rendszer minden olyan metódust fogad, amelyet még nem céloz meg egy másik kérés receive_method.
- block
- bool
Azt jelzi, hogy a műveletnek blokkolnia kell-e a kérés fogadásáig.
- timeout
- int
Igény szerint adjon meg néhány másodpercet, amíg a blokkolás túllépi az időkorlátot.
Válaszok
A fogadott metóduskérést jelölő MethodRequest objektum, vagy Nincs, ha a blokkolási időszak végéig nem érkezett metóduskérés.
Kivételek
ha a hitelesítő adatok érvénytelenek, és nem hozható létre kapcsolat.
ha egy kapcsolat létrehozása sikertelenséget 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.
Ez egy szinkron hívás, ami a következőket jelenti:
Ha block=True, ez a függvény blokkolni fog, amíg az alábbiak valamelyike nem történik meg:
a kívánt tulajdonságjavítás a Azure IoT Hub vagy az Azure IoT Edge Hubtól érkezik.
az időtúllépési időszak , ha van ilyen, el is telik. Ha időtúllépés történik, ez a függvény inboxEmpty kivételt eredményez
Ha block=False, ez a függvény minden olyan kívánt tulajdonságjavítást visszaad, amelyet a folyamat fogadott, de még nem adott vissza az alkalmazásnak. Ha a folyamat nem kapott kívánt tulajdonságjavításokat, ez a függvény inboxEmpty kivételt eredményez
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(block=True, timeout=None)Paraméterek
- block
- bool
Azt jelzi, hogy a műveletnek blokkolnia kell-e a kérés fogadásáig.
- timeout
- int
Igény szerint adjon meg néhány másodpercet, amíg a blokkolás túllépi az időkorlátot.
Válaszok
Ikerpéldány kívánt tulajdonságainak javítása JSON-diktálóként vagy Nincs, ha a blokkolási időszak végéig nem érkezett javítás
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 sikertelenséget 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.
Ez egy szinkron esemény, ami azt jelenti, hogy ez a függvény addig nem tér vissza, amíg az eseményt el nem küldik a szolgáltatásnak, és a szolgáltatás nem nyugtázta az esemény fogadását.
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_message(message)Paraméterek
- message
- Message
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.
send_message_to_output
Eseményt/üzenetet küld a megadott modulkimenetnek.
Ezek kimenő események, és "kimeneti eseményeknek" szánták őket.
Ez egy szinkron esemény, ami azt jelenti, hogy ez a függvény addig nem tér vissza, amíg az eseményt el nem küldik a szolgáltatásnak, és a szolgáltatás nem nyugtázta az esemény fogadását.
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_message_to_output(message, output_name)Paraméterek
- message
- Message
Az adott kimenetre kü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.
send_method_response
Válasz küldése metóduskérésre az Azure IoT Hub vagy az Azure IoT Edge Hubon keresztül.
Ez egy szinkron esemény, ami azt jelenti, hogy ez a függvény addig nem tér vissza, amíg az eseményt el nem küldik a szolgáltatásnak, és a szolgáltatás nem nyugtázta az esemény fogadását.
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(method_response)Paraméterek
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.
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.
update_sastoken(sastoken)Paraméterek
Kivételek
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 vagy sem.
on_background_exception
Háttérkivétel esetén a rendszer meghívja a kezelőfüggvényt vagy a koroutint.
A függvény vagy a koroutin definíciójának egy pozícióargumentumot (a kivételobjektumot) kell használnia.
on_connection_state_change
A kezelőfüggvény vagy koroutin, amelyet a rendszer meghív a kapcsolati állapot megváltozásakor.
A függvény vagy a koroutin definíciójának nem szabad pozícióargumentumokat megadnia.
on_message_received
A kezelőfüggvény vagy a coroutine, amelyet egy bemeneti üzenet érkezésekor hívunk meg.
A függvénydefiníciónak vagy koroutinnak egy pozícióargumentumot (az objektumot) kell használnia Message
on_method_request_received
A metóduskérelem fogadásakor meghívandó kezelőfüggvény vagy koroutin.
Ne felejtse el nyugtázni a metóduskérést a függvényben vagy a koroutinban 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élnek új SAS-jogkivonatra van szüksége. 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 elteltével ú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álja.
Az új jogkivonat az ügyfél .update_sastoken() metódusának használatával adható meg a függvényben vagy a koroutinban.
A függvény vagy a koroutin definíciójának nem szabad pozícióargumentumokat megadnia.
on_twin_desired_properties_patch_received
A kezelőfüggvény vagy koroutin, amelyet az ikertulajdonság-javítás érkezésekor hívunk meg.
A függvény vagy a koroutin definíciójának egy pozícióargumentumot kell használnia (az ikerjavítás egy JSON szótárobjektum formájában)
Azure SDK for Python
Visszajelzés
Hamarosan elérhető: 2024-ben fokozatosan kivezetjük a GitHub-problémákat a tartalom visszajelzési mechanizmusaként, és lecseréljük egy új visszajelzési rendszerre. További információ: https://aka.ms/ContentUserFeedback.
Visszajelzés küldése és megtekintése a következőhöz: