IoTHubModuleClient Třída

Synchronní klient modulu, který se připojuje k instanci Azure IoT Hub nebo Azure IoT Edge.

Inicializátor pro IoTHubModuleClient.

Tento inicializátor by se neměl volat přímo. Místo toho použijte k vytvoření instance jednu z>> metod třídy create_from_<<.

Dědičnost
azure.iot.device.iothub.sync_clients.GenericIoTHubClient
IoTHubModuleClient
azure.iot.device.iothub.abstract_clients.AbstractIoTHubModuleClient
IoTHubModuleClient

Konstruktor

IoTHubModuleClient(mqtt_pipeline, http_pipeline)

Parametry

mqtt_pipeline
<xref:azure.iot.device.iothub.pipeline.MQTTPipeline>
Vyžadováno

Kanál použitý k připojení ke koncovému bodu IoTHubu

http_pipeline
<xref:azure.iot.device.iothub.pipeline.HTTPPipeline>
Vyžadováno

Kanál použitý pro připojení ke koncovému bodu IoTHubu prostřednictvím protokolu HTTP.

Metody

connect

Připojí klienta k instanci služby Azure IoT Hub nebo Azure IoT Edge Hub.

Cíl se volí na základě přihlašovacích údajů předaných prostřednictvím parametru auth_provider, který byl zadaný při inicializaci tohoto objektu.

Jedná se o synchronní volání, což znamená, že tato funkce se nevrátí, dokud nebude připojení ke službě zcela navázané.

create_from_connection_string

Vytvořte instanci klienta ze zařízení IoTHub nebo připojovacího řetězce modulu.

create_from_edge_environment

Vytvořte instanci klienta z prostředí IoT Edge.

Tuto metodu je možné spustit jenom z kontejneru IoT Edge nebo v prostředí ladění nakonfigurovaného pro vývoj v Edgi (např. Visual Studio, Visual Studio Code).

create_from_sastoken

Vytvoření instance klienta z předem vytvořeného řetězce tokenu SAS

create_from_x509_certificate

Vytvořte instanci klienta pomocí ověřování certifikátu X509.

disconnect

Odpojte klienta od instance Azure IoT Hub nebo Azure IoT Edge Hub.

Po úplném dokončení práce s instancí klienta doporučujeme zajistit volání této funkce.

Jedná se o synchronní volání, což znamená, že tato funkce se nevrátí, dokud nebude připojení ke službě zcela ukončeno.

get_twin

Získá dvojče zařízení nebo modulu ze služby Azure IoT Hub nebo Azure IoT Edge Hub.

Jedná se o synchronní volání, což znamená, že tato funkce nevrátí, dokud se dvojče nenačte ze služby.

invoke_method

Vyvolejte metodu z klienta do klienta zařízení nebo modulu a přijměte odpověď na volání metody.

patch_twin_reported_properties

Aktualizujte ohlášené vlastnosti pomocí služby Azure IoT Hub nebo Azure IoT Edge Hub.

Toto je synchronní volání, což znamená, že tato funkce nevrátí, dokud nebude oprava odeslána službě a potvrzena.

Pokud služba vrátí chybu při operaci opravy, vyvolá tato funkce příslušnou chybu.

receive_message_on_input

Přijmout vstupní zprávu, která byla odeslána z jiného modulu na konkrétní vstup.

Zastaralé od verze 2.3.0: K nastavení obslužné rutiny doporučujeme použít vlastnost .on_message_received.

receive_method_request

Prostřednictvím Azure IoT Hub nebo Azure IoT Edge Hubu obdržíte žádost o metodu.

Zastaralé od verze 2.3.0: K nastavení obslužné rutiny doporučujeme použít vlastnost .on_method_request_received.

receive_twin_desired_properties_patch

Získejte opravu požadované vlastnosti prostřednictvím Azure IoT Hub nebo Azure IoT Edge Hubu.

Toto je synchronní volání, což znamená následující:

  1. Pokud block=True, bude tato funkce blokovat, dokud nedojde k jedné z následujících situací:

    • z Azure IoT Hub nebo azure IoT Edge Hubu se obdrží požadovaná oprava vlastnosti.

    • časový limit, je-li zadán, uplynou. Pokud dojde k vypršení časového limitu, tato funkce vyvolá výjimku Doručená poštaEmpty.

  2. Pokud block=False, vrátí tato funkce všechny opravy požadovaných vlastností, které kanál mohl obdržet, ale ještě se nevrátily do aplikace. Pokud kanál nepřijal žádné opravy požadovaných vlastností, tato funkce vyvolá výjimku Doručená poštaEmpty.

Zastaralé od verze 2.3.0: K nastavení obslužné rutiny doporučujeme použít vlastnost .on_twin_desired_properties_patch_received.

send_message

Odešle zprávu do výchozího koncového bodu událostí v instanci Azure IoT Hub nebo Azure IoT Edge Hub.

Jedná se o synchronní událost, což znamená, že tato funkce se nevrátí, dokud nebude událost odeslána službě a služba nepotvrdí přijetí události.

Pokud připojení ke službě nebylo dříve otevřeno voláním connect, tato funkce otevře připojení před odesláním události.

send_message_to_output

Odešle událost nebo zprávu do výstupu daného modulu.

Jedná se o odchozí události, které jsou určené jako "výstupní události".

Jedná se o synchronní událost, což znamená, že tato funkce se nevrátí, dokud nebude událost odeslána službě a služba nepotvrdí přijetí události.

Pokud připojení ke službě nebylo dříve otevřeno voláním connect, tato funkce otevře připojení před odesláním události.

send_method_response

Odeslání odpovědi na požadavek metody prostřednictvím Azure IoT Hub nebo Azure IoT Edge Hubu.

Jedná se o synchronní událost, což znamená, že tato funkce se nevrátí, dokud nebude událost odeslána službě a služba nepotvrdí přijetí události.

Pokud připojení ke službě nebylo dříve otevřeno voláním connect, tato funkce otevře připojení před odesláním události.

shutdown

Vypněte klienta pro řádné ukončení.

Po zavolání této metody budou mít všechny pokusy o další volání klientů za následek vyvolání ClientError.

update_sastoken

Aktualizujte token SAS klienta, který se používá k ověřování, a pak připojení znovu autorizuje.

Toto rozhraní API je možné použít pouze v případě, že byl klient původně vytvořen pomocí tokenu SAS.

connect

Připojí klienta k instanci služby Azure IoT Hub nebo Azure IoT Edge Hub.

Cíl se volí na základě přihlašovacích údajů předaných prostřednictvím parametru auth_provider, který byl zadaný při inicializaci tohoto objektu.

Jedná se o synchronní volání, což znamená, že tato funkce se nevrátí, dokud nebude připojení ke službě zcela navázané.

connect()

Výjimky

pokud jsou přihlašovací údaje neplatné a nelze navázat připojení.

pokud při navazování připojení dojde k selhání.

pokud během provádění dojde ke ztrátě připojení.

pokud vyprší časový limit připojení.

pokud během provádění dojde k neočekávanému selhání.

create_from_connection_string

Vytvořte instanci klienta ze zařízení IoTHub nebo připojovacího řetězce modulu.

create_from_connection_string(connection_string, **kwargs)

Parametry

connection_string
str
Vyžadováno

Připojovací řetězec pro IoTHub, ke kterému se chcete připojit.

server_verification_cert
str
Vyžadováno

Možnost konfigurace. Řetěz důvěryhodných certifikátů. Nezbytné při připojování ke koncovému bodu, který má nestandardní kořen důvěryhodnosti, například bránu protokolu.

websockets
bool
Vyžadováno

Možnost konfigurace. Výchozí hodnota je False. Pokud používáte MQTT přes websockety, nastavte hodnotu true.

cipher
str nebo list(str)
Vyžadováno

Možnost konfigurace. Šifrovací sady pro TLS/SSL jako řetězec ve formátu seznamu šifer OpenSSL nebo jako seznam řetězců šifrovací sady.

product_info
str
Vyžadováno

Možnost konfigurace. Výchozí hodnota je prázdný řetězec. Řetězec obsahuje informace o libovolném produktu, které jsou připojeny k řetězci uživatelského agenta.

proxy_options
ProxyOptions
Vyžadováno

Možnosti pro odesílání provozu přes proxy servery.

sastoken_ttl
int
Vyžadováno

Hodnota TTL (v sekundách) vytvořeného tokenu SasToken použitého k ověřování. Výchozí hodnota je 3600 sekund (1 hodina).

keep_alive
int
Vyžadováno

Maximální doba v sekundách mezi komunikací se zprostředkovatelem. Pokud se nevyměňují žádné další zprávy, určuje se rychlost, s jakou klient bude zprostředkovateli odesílat zprávy ping. Pokud není zadána výchozí hodnota 60 sekund, použije se.

auto_connect
bool
Vyžadováno

Automaticky připojit klienta k IoTHubu při vyvolání metody, která vyžaduje navázání připojení. (Výchozí: True)

connection_retry
bool
Vyžadováno

Pokus o opětovné navázání ukončeného připojení (výchozí hodnota: Pravda)

connection_retry_interval
int
Vyžadováno

Interval v sekundách mezi pokusy o opětovné navázání ukončeného připojení (výchozí hodnota: 10)

ensure_desired_properties
bool
Vyžadováno

Ujistěte se, že při opětovném připojení byla přijata nejnovější oprava požadovaných vlastností (Výchozí:Pravda).

Návraty

Instance klienta IoTHub, který k ověřování používá připojovací řetězec.

Výjimky

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

create_from_edge_environment

Vytvořte instanci klienta z prostředí IoT Edge.

Tuto metodu je možné spustit jenom z kontejneru IoT Edge nebo v prostředí ladění nakonfigurovaného pro vývoj v Edgi (např. Visual Studio, Visual Studio Code).

create_from_edge_environment(**kwargs)

Parametry

websockets
bool
Vyžadováno

Možnost konfigurace. Výchozí hodnota je False. Pokud používáte MQTT přes websockety, nastavte hodnotu true.

cipher
str nebo list(str)
Vyžadováno

Možnost konfigurace. Šifrovací sady pro TLS/SSL jako řetězec ve formátu seznamu šifer OpenSSL nebo jako seznam řetězců šifrovací sady.

product_info
str
Vyžadováno

Možnost konfigurace. Výchozí hodnota je prázdný řetězec. Řetězec obsahuje informace o libovolném produktu, které jsou připojeny k řetězci uživatelského agenta.

proxy_options
ProxyOptions
Vyžadováno

Možnosti pro odesílání provozu přes proxy servery.

sastoken_ttl
int
Vyžadováno

Hodnota TTL (v sekundách) vytvořeného tokenu SasToken použitého k ověřování. Výchozí hodnota je 3600 sekund (1 hodina)

keep_alive
int
Vyžadováno

Maximální doba v sekundách mezi komunikací se zprostředkovatelem. Pokud se nevyměňují žádné další zprávy, určuje se rychlost, s jakou klient bude zprostředkovateli odesílat zprávy ping. Pokud není zadána výchozí hodnota 60 sekund, použije se.

auto_connect
bool
Vyžadováno

Automaticky připojit klienta k IoTHubu při vyvolání metody, která vyžaduje navázání připojení. (Výchozí: True)

connection_retry
bool
Vyžadováno

Pokus o opětovné navázání ukončeného připojení (výchozí hodnota: Pravda)

connection_retry_interval
int
Vyžadováno

Interval v sekundách mezi pokusy o opětovné navázání ukončeného připojení (výchozí hodnota: 10)

Návraty

Instance klienta IoTHub, který k ověřování používá prostředí IoT Edge.

Výjimky

OSError if the IoT Edge container is not configured correctly.
ValueError if debug variables are invalid.
TypeError if given an unsupported parameter.

create_from_sastoken

Vytvoření instance klienta z předem vytvořeného řetězce tokenu SAS

create_from_sastoken(sastoken, **kwargs)

Parametry

sastoken
str
Vyžadováno

Řetězec tokenu SAS

server_verification_cert
str
Vyžadováno

Možnost konfigurace. Řetěz důvěryhodných certifikátů. Nezbytné při připojování ke koncovému bodu, který má nestandardní kořen důvěryhodnosti, například bránu protokolu.

gateway_hostname
str
Vyžadováno

Možnost konfigurace. Název hostitele brány pro zařízení brány.

websockets
bool
Vyžadováno

Možnost konfigurace. Výchozí hodnota je False. Pokud používáte MQTT přes websockety, nastavte hodnotu true.

cipher
str nebo list(str)
Vyžadováno

Možnost konfigurace. Šifrovací sady pro TLS/SSL jako řetězec ve formátu seznamu šifer OpenSSL nebo jako seznam řetězců šifrovací sady.

product_info
str
Vyžadováno

Možnost konfigurace. Výchozí hodnota je prázdný řetězec. Řetězec obsahuje informace o libovolném produktu, které jsou připojeny k řetězci uživatelského agenta.

proxy_options
ProxyOptions
Vyžadováno

Možnosti pro odesílání provozu přes proxy servery.

keep_alive
int
Vyžadováno

Maximální doba v sekundách mezi komunikací se zprostředkovatelem. Pokud se nevyměňují žádné další zprávy, určuje se rychlost, s jakou klient bude zprostředkovateli odesílat zprávy ping. Pokud není zadána výchozí hodnota 60 sekund, použije se.

auto_connect
bool
Vyžadováno

Automaticky připojit klienta k IoTHubu při vyvolání metody, která vyžaduje navázání připojení. (Výchozí: True)

connection_retry
bool
Vyžadováno

Pokus o opětovné navázání ukončeného připojení (výchozí hodnota: Pravda)

connection_retry_interval
int
Vyžadováno

Interval v sekundách mezi pokusy o opětovné navázání ukončeného připojení (výchozí hodnota: 10)

ensure_desired_properties
bool
Vyžadováno

Ujistěte se, že při opětovném připojení byla přijata nejnovější oprava požadovaných vlastností (Výchozí:Pravda).

Výjimky

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

create_from_x509_certificate

Vytvořte instanci klienta pomocí ověřování certifikátu X509.

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

Parametry

hostname
str
Vyžadováno

Hostitel se spuštěným IotHubem Najdete ji v Azure Portal na kartě Přehled jako název hostitele řetězce.

x509
X509
Vyžadováno

Úplný objekt certifikátu x509. Pokud chcete použít certifikát, musí objekt zápisu obsahovat certifikát (buď kořenový certifikát, nebo jeden z certifikátů zprostředkující certifikační autority). Pokud certifikát pochází ze souboru CER, musí být zakódovaný jako base64.

device_id
str
Vyžadováno

ID použité k jednoznačné identifikaci zařízení v IoTHubu

module_id
str
Vyžadováno

ID sloužící k jednoznačné identifikaci modulu na zařízení v IoTHubu.

server_verification_cert
str
Vyžadováno

Možnost konfigurace. Řetěz důvěryhodných certifikátů. Nezbytné při připojování ke koncovému bodu, který má nestandardní kořen důvěryhodnosti, například bránu protokolu.

gateway_hostname
str
Vyžadováno

Možnost konfigurace. Název hostitele brány pro zařízení brány.

websockets
bool
Vyžadováno

Možnost konfigurace. Výchozí hodnota je False. Pokud používáte MQTT přes websockety, nastavte hodnotu true.

cipher
str nebo list(str)
Vyžadováno

Možnost konfigurace. Šifrovací sady pro TLS/SSL jako řetězec ve formátu seznamu šifer OpenSSL nebo jako seznam řetězců šifrovací sady.

product_info
str
Vyžadováno

Možnost konfigurace. Výchozí hodnota je prázdný řetězec. Řetězec obsahuje informace o libovolném produktu, které jsou připojeny k řetězci uživatelského agenta.

proxy_options
ProxyOptions
Vyžadováno

Možnosti pro odesílání provozu přes proxy servery.

keep_alive
int
Vyžadováno

Maximální doba v sekundách mezi komunikací se zprostředkovatelem. Pokud se nevyměňují žádné další zprávy, určuje se rychlost, s jakou klient bude zprostředkovateli odesílat zprávy ping. Pokud není zadána výchozí hodnota 60 sekund, použije se.

auto_connect
bool
Vyžadováno

Automaticky připojit klienta k IoTHubu při vyvolání metody, která vyžaduje navázání připojení. (Výchozí: True)

connection_retry
bool
Vyžadováno

Pokus o opětovné navázání ukončeného připojení (výchozí hodnota: Pravda)

connection_retry_interval
int
Vyžadováno

Interval v sekundách mezi pokusy o opětovné navázání ukončeného připojení (výchozí hodnota: 10)

ensure_desired_properties
bool
Vyžadováno

Ujistěte se, že při opětovném připojení byla přijata nejnovější oprava požadovaných vlastností (Výchozí:Pravda).

Návraty

Instance klienta IoTHub, který k ověřování používá certifikát X509.

Výjimky

TypeError if given an unsupported parameter.

disconnect

Odpojte klienta od instance Azure IoT Hub nebo Azure IoT Edge Hub.

Po úplném dokončení práce s instancí klienta doporučujeme zajistit volání této funkce.

Jedná se o synchronní volání, což znamená, že tato funkce se nevrátí, dokud nebude připojení ke službě zcela ukončeno.

disconnect()

Výjimky

pokud během provádění dojde k neočekávanému selhání.

get_twin

Získá dvojče zařízení nebo modulu ze služby Azure IoT Hub nebo Azure IoT Edge Hub.

Jedná se o synchronní volání, což znamená, že tato funkce nevrátí, dokud se dvojče nenačte ze služby.

get_twin()

Návraty

Kompletní dvojče jako diktování JSON

Návratový typ

Výjimky

pokud jsou přihlašovací údaje neplatné a nelze navázat připojení.

pokud při navazování připojení dojde k selhání.

pokud během provádění dojde ke ztrátě připojení.

pokud vyprší časový limit pokusu o připojení

pokud klient není připojený (a není povolené žádné automatické připojení),

pokud během provádění dojde k neočekávanému selhání.

invoke_method

Vyvolejte metodu z klienta do klienta zařízení nebo modulu a přijměte odpověď na volání metody.

invoke_method(method_params, device_id, module_id=None)

Parametry

method_params
dict
Vyžadováno

Měly by obsahovat methodName (str), payload (str), connectTimeoutInSeconds (int), responseTimeoutInSeconds (int).

device_id
str
Vyžadováno

ID zařízení cílového zařízení, ve kterém se metoda vyvolá.

module_id
str
výchozí hodnota: None

ID modulu cílového modulu, ve kterém bude metoda vyvolána. (Nepovinné)

Návraty

method_result by měla obsahovat stav a datovou část.

Návratový typ

Výjimky

pokud jsou přihlašovací údaje neplatné a nelze navázat připojení.

pokud při navazování připojení dojde k selhání.

pokud během provádění dojde ke ztrátě připojení.

pokud vyprší časový limit připojení.

pokud během provádění dojde k neočekávanému selhání.

patch_twin_reported_properties

Aktualizujte ohlášené vlastnosti pomocí služby Azure IoT Hub nebo Azure IoT Edge Hub.

Toto je synchronní volání, což znamená, že tato funkce nevrátí, dokud nebude oprava odeslána službě a potvrzena.

Pokud služba vrátí chybu při operaci opravy, vyvolá tato funkce příslušnou chybu.

patch_twin_reported_properties(reported_properties_patch)

Parametry

reported_properties_patch
dict
Vyžadováno

Oprava ohlášených vlastností dvojčete jako diktování JSON

Výjimky

pokud jsou přihlašovací údaje neplatné a nelze navázat připojení.

pokud při navazování připojení dojde k selhání.

pokud během provádění dojde ke ztrátě připojení.

pokud vyprší časový limit pokusu o připojení

pokud klient není připojený (a není povolené žádné automatické připojení),

pokud během provádění dojde k neočekávanému selhání.

receive_message_on_input

Přijmout vstupní zprávu, která byla odeslána z jiného modulu na konkrétní vstup.

Zastaralé od verze 2.3.0: K nastavení obslužné rutiny doporučujeme použít vlastnost .on_message_received.

receive_message_on_input(input_name, block=True, timeout=None)

Parametry

input_name
str
Vyžadováno

Název vstupu, na který se má zpráva dostat.

block
bool
Vyžadováno

Určuje, jestli má operace blokovat, dokud není přijata zpráva.

timeout
int
Vyžadováno

Volitelně můžete zadat počet sekund, než vyprší časový limit blokování.

Návraty

Zpráva, která byla odeslána na zadaný vstup, nebo Žádná, pokud do konce období blokování nebyl přijat žádný požadavek metody.

Výjimky

pokud jsou přihlašovací údaje neplatné a nelze navázat připojení.

pokud při navazování připojení dojde k selhání.

pokud během provádění dojde ke ztrátě připojení.

pokud vyprší časový limit připojení.

pokud během provádění dojde k neočekávanému selhání.

receive_method_request

Prostřednictvím Azure IoT Hub nebo Azure IoT Edge Hubu obdržíte žádost o metodu.

Zastaralé od verze 2.3.0: K nastavení obslužné rutiny doporučujeme použít vlastnost .on_method_request_received.

receive_method_request(method_name=None, block=True, timeout=None)

Parametry

method_name
str
výchozí hodnota: None

Volitelně zadejte název metody, pro kterou se mají požadavky přijímat. Pokud tento parametr není zadaný, budou přijaty všechny metody, které ještě nejsou specificky zacíleny jiným požadavkem na receive_method.

block
bool
výchozí hodnota: True

Určuje, jestli se má operace blokovat, dokud se žádost neobdrží.

timeout
int
výchozí hodnota: None

Volitelně můžete zadat počet sekund, než vyprší časový limit blokování.

Návraty

MethodRequest Objekt představující přijatý požadavek metody nebo None, pokud do konce období blokování nebyl přijat žádný požadavek metody.

Výjimky

pokud jsou přihlašovací údaje neplatné a nelze navázat připojení.

pokud při navazování připojení dojde k selhání.

pokud během provádění dojde ke ztrátě připojení.

pokud vyprší časový limit připojení.

pokud během provádění dojde k neočekávanému selhání.

receive_twin_desired_properties_patch

Získejte opravu požadované vlastnosti prostřednictvím Azure IoT Hub nebo Azure IoT Edge Hubu.

Toto je synchronní volání, což znamená následující:

  1. Pokud block=True, bude tato funkce blokovat, dokud nedojde k jedné z následujících situací:

    • z Azure IoT Hub nebo azure IoT Edge Hubu se obdrží požadovaná oprava vlastnosti.

    • časový limit, je-li zadán, uplynou. Pokud dojde k vypršení časového limitu, tato funkce vyvolá výjimku Doručená poštaEmpty.

  2. Pokud block=False, vrátí tato funkce všechny opravy požadovaných vlastností, které kanál mohl obdržet, ale ještě se nevrátily do aplikace. Pokud kanál nepřijal žádné opravy požadovaných vlastností, tato funkce vyvolá výjimku Doručená poštaEmpty.

Zastaralé od verze 2.3.0: K nastavení obslužné rutiny doporučujeme použít vlastnost .on_twin_desired_properties_patch_received.

receive_twin_desired_properties_patch(block=True, timeout=None)

Parametry

block
bool
výchozí hodnota: True

Určuje, jestli se má operace blokovat, dokud se žádost neobdrží.

timeout
int
výchozí hodnota: None

Volitelně můžete zadat počet sekund, než vyprší časový limit blokování.

Návraty

Oprava požadovaných vlastností dvojčete jako diktování JSON nebo Žádná, pokud do konce období blokování nebyla přijata žádná oprava

Návratový typ

dict,

Výjimky

pokud jsou přihlašovací údaje neplatné a nelze navázat připojení.

pokud při navazování připojení dojde k selhání.

pokud během provádění dojde ke ztrátě připojení.

pokud vyprší časový limit připojení.

pokud během provádění dojde k neočekávanému selhání.

send_message

Odešle zprávu do výchozího koncového bodu událostí v instanci Azure IoT Hub nebo Azure IoT Edge Hub.

Jedná se o synchronní událost, což znamená, že tato funkce se nevrátí, dokud nebude událost odeslána službě a služba nepotvrdí přijetí události.

Pokud připojení ke službě nebylo dříve otevřeno voláním connect, tato funkce otevře připojení před odesláním události.

send_message(message)

Parametry

message
Message
Vyžadováno

Skutečná zpráva, která se má odeslat. Vše, co bylo předáno, které není instancí Třídy Message bude převedeno na message objekt.

Výjimky

pokud jsou přihlašovací údaje neplatné a nelze navázat připojení.

pokud při navazování připojení dojde k selhání.

pokud během provádění dojde ke ztrátě připojení.

pokud vyprší časový limit pokusu o připojení

pokud klient není připojený (a není povolené žádné automatické připojení),

pokud během provádění dojde k neočekávanému selhání.

ValueError if the message fails size validation.

send_message_to_output

Odešle událost nebo zprávu do výstupu daného modulu.

Jedná se o odchozí události, které jsou určené jako "výstupní události".

Jedná se o synchronní událost, což znamená, že tato funkce se nevrátí, dokud nebude událost odeslána službě a služba nepotvrdí přijetí události.

Pokud připojení ke službě nebylo dříve otevřeno voláním connect, tato funkce otevře připojení před odesláním události.

send_message_to_output(message, output_name)

Parametry

message
Message
Vyžadováno

Zpráva, která se má odeslat do daného výstupu. Vše, co bylo předáno, které není instancí Třídy Message bude převedeno na message objekt.

output_name
str
Vyžadováno

Název výstupu, do který se má událost odeslat.

Výjimky

pokud jsou přihlašovací údaje neplatné a nelze navázat připojení.

pokud při navazování připojení dojde k selhání.

pokud během provádění dojde ke ztrátě připojení.

pokud vyprší časový limit pokusu o připojení

pokud klient není připojený (a není povolené žádné automatické připojení),

pokud během provádění dojde k neočekávanému selhání.

ValueError if the message fails size validation.

send_method_response

Odeslání odpovědi na požadavek metody prostřednictvím Azure IoT Hub nebo Azure IoT Edge Hubu.

Jedná se o synchronní událost, což znamená, že tato funkce se nevrátí, dokud nebude událost odeslána službě a služba nepotvrdí přijetí události.

Pokud připojení ke službě nebylo dříve otevřeno voláním connect, tato funkce otevře připojení před odesláním události.

send_method_response(method_response)

Parametry

method_response
MethodResponse
Vyžadováno

MethodResponse k odeslání.

Výjimky

pokud jsou přihlašovací údaje neplatné a nelze navázat připojení.

pokud při navazování připojení dojde k selhání.

pokud během provádění dojde ke ztrátě připojení.

pokud vyprší časový limit pokusu o připojení

pokud klient není připojený (a není povolené žádné automatické připojení),

pokud během provádění dojde k neočekávanému selhání.

shutdown

Vypněte klienta pro řádné ukončení.

Po zavolání této metody budou mít všechny pokusy o další volání klientů za následek vyvolání ClientError.

shutdown()

Výjimky

pokud během provádění dojde k neočekávanému selhání.

update_sastoken

Aktualizujte token SAS klienta, který se používá k ověřování, a pak připojení znovu autorizuje.

Toto rozhraní API je možné použít pouze v případě, že byl klient původně vytvořen pomocí tokenu SAS.

update_sastoken(sastoken)

Parametry

sastoken
str
Vyžadováno

Nový řetězec tokenu SAS, který má klient použít

Výjimky

ValueError if the sastoken parameter is invalid

pokud jsou přihlašovací údaje neplatné a nelze znovu navázat připojení.

pokud opětovné navazování připojení vede k selhání.

pokud během provádění dojde ke ztrátě připojení.

pokud vyprší časový limit pokusu o opětovnou autorizaci.

pokud se klient původně nevytvořil s tokenem SAS.

pokud během provádění dojde k neočekávanému selhání.

Atributy

connected

Vlastnost jen pro čtení, která označuje, jestli je přenos připojený nebo ne.

on_background_exception

Funkce obslužné rutiny nebo korutina bude volána, pokud dojde k výjimce na pozadí.

Definice funkce nebo korutiny by měla mít jeden poziční argument (objekt výjimky).

on_connection_state_change

Funkce obslužné rutiny nebo korutina, která bude volána při změně stavu připojení.

Definice funkce nebo korutiny by neměla používat žádné poziční argumenty.

on_message_received

Funkce obslužné rutiny nebo korutina, která bude volána při přijetí vstupní zprávy.

Definice funkce nebo korutina by měly mít jeden poziční argument ( Message objekt).

on_method_request_received

Funkce obslužné rutiny nebo korutina, která bude volána při přijetí požadavku metody.

Nezapomeňte potvrdit požadavek metody ve vaší funkci nebo potvrdit pomocí metody .send_method_response() klienta.

Definice funkce nebo korutiny by měla mít jeden poziční argument ( MethodRequest objekt).

on_new_sastoken_required

Funkce obslužné rutiny nebo korutina, která se bude volat, když klient vyžaduje nový token SAS. K tomu dojde přibližně 2 minuty před vypršením platnosti tokenu SAS. Na platformách Windows platí, že pokud životnost překročí přibližně 49 dnů, bude se po těchto 49 dnech vyžadovat nový token bez ohledu na to, jak dlouhá je životnost SAS.

Všimněte si, že tato obslužná rutina je nutná POUZE při použití klienta vytvořeného pomocí metody .create_from_sastoken().

Nový token je možné poskytnout ve vaší funkci nebo korutinovat pomocí metody .update_sastoken() klienta.

Definice funkce nebo korutiny by neměla používat žádné poziční argumenty.

on_twin_desired_properties_patch_received

Funkce obslužné rutiny nebo korutina, která bude volána při přijetí opravy požadovaných vlastností dvojčete.

Definice funkce nebo korutiny by měla obsahovat jeden poziční argument (oprava dvojčete ve formě objektu slovníku JSON).