Dela via


IoTHubModuleClient Klass

En synkron modulklient som ansluter till en Azure IoT Hub- eller Azure IoT Edge-instans.

Initializer för en IoTHubModuleClient.

Den här initieraren ska inte anropas direkt. Använd i stället en av klassmethoderna ">>create_from_<<" för att instansiera

Arv
azure.iot.device.iothub.sync_clients.GenericIoTHubClient
IoTHubModuleClient
azure.iot.device.iothub.abstract_clients.AbstractIoTHubModuleClient
IoTHubModuleClient

Konstruktor

IoTHubModuleClient(mqtt_pipeline, http_pipeline)

Parametrar

mqtt_pipeline
<xref:azure.iot.device.iothub.pipeline.MQTTPipeline>
Obligatorisk

Pipelinen som används för att ansluta till IoTHub-slutpunkten.

http_pipeline
<xref:azure.iot.device.iothub.pipeline.HTTPPipeline>
Obligatorisk

Pipelinen som används för att ansluta till IoTHub-slutpunkten via HTTP.

Metoder

connect

Ansluter klienten till en Azure IoT Hub- eller Azure IoT Edge Hub-instans.

Målet väljs baserat på de autentiseringsuppgifter som skickades via parametern auth_provider som angavs när objektet initierades.

Det här är ett synkront anrop, vilket innebär att den här funktionen inte returneras förrän anslutningen till tjänsten har upprättats helt.

create_from_connection_string

Instansiera klienten från en IoTHub-enhet eller modulanslutningssträng.

create_from_edge_environment

Instansiera klienten från den IoT Edge miljön.

Den här metoden kan bara köras inifrån en IoT Edge container eller i en felsökningsmiljö som konfigurerats för Edge-utveckling (t.ex. Visual Studio, Visual Studio Code)

create_from_sastoken

Instansiera klienten från en i förväg skapad SAS-tokensträng

create_from_x509_certificate

Instansiera en klient med X509-certifikatautentisering.

disconnect

Koppla bort klienten från Azure IoT Hub- eller Azure IoT Edge Hub-instansen.

Vi rekommenderar att du anropar den här funktionen när du är helt klar med klientinstansen.

Det här är ett synkront anrop, vilket innebär att den här funktionen inte returneras förrän anslutningen till tjänsten har stängts helt.

get_twin

Hämtar enhets- eller modultvillingen från tjänsten Azure IoT Hub eller Azure IoT Edge Hub.

Det här är ett synkront anrop, vilket innebär att den här funktionen inte returneras förrän tvillingen har hämtats från tjänsten.

invoke_method

Anropa en metod från klienten till en enhets- eller modulklient och ta emot svaret på metodanropet.

patch_twin_reported_properties

Uppdatera rapporterade egenskaper med tjänsten Azure IoT Hub eller Azure IoT Edge Hub.

Det här är ett synkront anrop, vilket innebär att den här funktionen inte returneras förrän korrigeringen har skickats till tjänsten och bekräftats.

Om tjänsten returnerar ett fel i korrigeringsåtgärden genererar den här funktionen rätt fel.

receive_message_on_input

Ta emot ett indatameddelande som har skickats från en annan modul till en specifik indata.

Inaktuell sedan version 2.3.0: Vi rekommenderar att du använder egenskapen .on_message_received för att ange en hanterare i stället

receive_method_request

Ta emot en metodbegäran via Azure IoT Hub eller Azure IoT Edge Hub.

Inaktuell sedan version 2.3.0: Vi rekommenderar att du använder egenskapen .on_method_request_received för att ange en hanterare i stället

receive_twin_desired_properties_patch

Få en önskad egenskapskorrigering via Azure IoT Hub eller Azure IoT Edge Hub.

Det här är ett synkront anrop, vilket innebär följande:

  1. Om block=True blockeras den här funktionen tills något av följande händer:

    • en önskad egenskapskorrigering tas emot från Azure IoT Hub eller Azure IoT Edge Hub.

    • tidsgränsen, om så anges, förflutit. Om en timeout inträffar utlöser den här funktionen ett InboxEmpty-undantag

  2. Om block=False returnerar den här funktionen önskade egenskapskorrigeringar som kan ha tagits emot av pipelinen, men som ännu inte har returnerats till programmet. Om inga önskade egenskapskorrigeringar har tagits emot av pipelinen genererar den här funktionen ett InboxEmpty-undantag

Inaktuell sedan version 2.3.0: Vi rekommenderar att du använder egenskapen .on_twin_desired_properties_patch_received för att ange en hanterare i stället

send_message

Skickar ett meddelande till standardhändelseslutpunkten på Azure IoT Hub- eller Azure IoT Edge Hub-instansen.

Det här är en synkron händelse, vilket innebär att den här funktionen inte returneras förrän händelsen har skickats till tjänsten och tjänsten har bekräftat mottagandet av händelsen.

Om anslutningen till tjänsten inte tidigare har öppnats av ett anrop för att ansluta öppnar den här funktionen anslutningen innan händelsen skickas.

send_message_to_output

Skickar en händelse/ett meddelande till den angivna modulens utdata.

Det här är utgående händelser och är avsedda att vara "utdatahändelser".

Det här är en synkron händelse, vilket innebär att den här funktionen inte returneras förrän händelsen har skickats till tjänsten och tjänsten har bekräftat mottagandet av händelsen.

Om anslutningen till tjänsten inte tidigare har öppnats av ett anrop för att ansluta öppnar den här funktionen anslutningen innan händelsen skickas.

send_method_response

Skicka ett svar på en metodbegäran via Azure IoT Hub eller Azure IoT Edge Hub.

Det här är en synkron händelse, vilket innebär att den här funktionen inte returneras förrän händelsen har skickats till tjänsten och tjänsten har bekräftat mottagandet av händelsen.

Om anslutningen till tjänsten inte tidigare har öppnats av ett anrop för att ansluta öppnar den här funktionen anslutningen innan händelsen skickas.

shutdown

Stäng av klienten för korrekt avslut.

När den här metoden anropas resulterar alla försök till ytterligare klientanrop i att en ClientError aktiveras

update_sastoken

Uppdatera klientens SAS-token som används för autentisering och auktoriserar sedan anslutningen igen.

Det här API:et kan endast användas om klienten ursprungligen skapades med en SAS-token.

connect

Ansluter klienten till en Azure IoT Hub- eller Azure IoT Edge Hub-instans.

Målet väljs baserat på de autentiseringsuppgifter som skickades via parametern auth_provider som angavs när objektet initierades.

Det här är ett synkront anrop, vilket innebär att den här funktionen inte returneras förrän anslutningen till tjänsten har upprättats helt.

connect()

Undantag

om autentiseringsuppgifterna är ogiltiga och det inte går att upprätta en anslutning.

om en upprättande av en anslutning resulterar i fel.

om anslutningen går förlorad under körningen.

om anslutningen överskrider tidsgränsen.

om det uppstår ett oväntat fel under körningen.

create_from_connection_string

Instansiera klienten från en IoTHub-enhet eller modulanslutningssträng.

create_from_connection_string(connection_string, **kwargs)

Parametrar

connection_string
str
Obligatorisk

Anslutningssträngen för den IoTHub som du vill ansluta till.

server_verification_cert
str
Obligatorisk

Konfigurationsalternativ. Den betrodda certifikatkedjan. Krävs vid anslutning till en slutpunkt som har en förtroenderot som inte är standard, till exempel en protokollgateway.

websockets
bool
Obligatorisk

Konfigurationsalternativ. Standardvärdet är Falskt. Ange till true om du använder MQTT över websockets.

cipher
str eller list(str)
Obligatorisk

Konfigurationsalternativ. Chiffersviter för TLS/SSL, som en sträng i "OpenSSL-chifferlistformat" eller som en lista över chiffersvitsträngar.

product_info
str
Obligatorisk

Konfigurationsalternativ. Standardvärdet är tom sträng. Strängen innehåller godtycklig produktinformation som läggs till i användaragentsträngen.

proxy_options
ProxyOptions
Obligatorisk

Alternativ för att skicka trafik via proxyservrar.

sastoken_ttl
int
Obligatorisk

Time to live (i sekunder) för den skapade SasToken som används för autentisering. Standardvärdet är 3 600 sekunder (1 timme).

keep_alive
int
Obligatorisk

Maximal period i sekunder mellan kommunikation med den asynkrona meddelandekön. Om inga andra meddelanden utbyts styr detta den hastighet med vilken klienten skickar ping-meddelanden till den asynkrona meddelandekön. Om det inte anges används standardvärdet 60 sek.

auto_connect
bool
Obligatorisk

Anslut klienten automatiskt till IoTHub när en metod anropas som kräver att en anslutning upprättas. (Standard: Sant)

connection_retry
bool
Obligatorisk

Försök att återupprätta en avbruten anslutning (standard: Sant)

connection_retry_interval
int
Obligatorisk

Intervall i sekunder mellan försök att återupprätta en avbruten anslutning (standard: 10)

ensure_desired_properties
bool
Obligatorisk

Se till att korrigeringen för de senaste önskade egenskaperna har tagits emot vid återanslutningar (Standard:Sant)

Returer

En instans av en IoTHub-klient som använder en anslutningssträng för autentisering.

Undantag

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

create_from_edge_environment

Instansiera klienten från den IoT Edge miljön.

Den här metoden kan bara köras inifrån en IoT Edge container eller i en felsökningsmiljö som konfigurerats för Edge-utveckling (t.ex. Visual Studio, Visual Studio Code)

create_from_edge_environment(**kwargs)

Parametrar

websockets
bool
Obligatorisk

Konfigurationsalternativ. Standardvärdet är Falskt. Ange till true om du använder MQTT över websockets.

cipher
str eller list(str)
Obligatorisk

Konfigurationsalternativ. Chiffersviter för TLS/SSL, som en sträng i "OpenSSL-chifferlistformat" eller som en lista över chiffersvitsträngar.

product_info
str
Obligatorisk

Konfigurationsalternativ. Standardvärdet är tom sträng. Strängen innehåller godtycklig produktinformation som läggs till i användaragentsträngen.

proxy_options
ProxyOptions
Obligatorisk

Alternativ för att skicka trafik via proxyservrar.

sastoken_ttl
int
Obligatorisk

Time to live (i sekunder) för den skapade SasToken som används för autentisering. Standardvärdet är 3 600 sekunder (1 timme)

keep_alive
int
Obligatorisk

Maximal period i sekunder mellan kommunikation med den asynkrona meddelandekön. Om inga andra meddelanden utbyts styr detta den hastighet med vilken klienten skickar ping-meddelanden till den asynkrona meddelandekön. Om det inte anges används standardvärdet 60 sek.

auto_connect
bool
Obligatorisk

Anslut klienten automatiskt till IoTHub när en metod anropas som kräver att en anslutning upprättas. (Standard: Sant)

connection_retry
bool
Obligatorisk

Försök att återupprätta en avbruten anslutning (standard: Sant)

connection_retry_interval
int
Obligatorisk

Intervall i sekunder mellan försök att återupprätta en avbruten anslutning (standard: 10)

Returer

En instans av en IoTHub-klient som använder IoT Edge-miljön för autentisering.

Undantag

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

Instansiera klienten från en i förväg skapad SAS-tokensträng

create_from_sastoken(sastoken, **kwargs)

Parametrar

sastoken
str
Obligatorisk

SAS-tokensträngen

server_verification_cert
str
Obligatorisk

Konfigurationsalternativ. Den betrodda certifikatkedjan. Krävs vid anslutning till en slutpunkt som har en förtroenderot som inte är standard, till exempel en protokollgateway.

gateway_hostname
str
Obligatorisk

Konfigurationsalternativ. Gateway-värdnamnet för gatewayenheten.

websockets
bool
Obligatorisk

Konfigurationsalternativ. Standardvärdet är Falskt. Ange till true om du använder MQTT över websockets.

cipher
str eller list(str)
Obligatorisk

Konfigurationsalternativ. Chiffersviter för TLS/SSL, som en sträng i "OpenSSL-chifferlistformat" eller som en lista över chiffersvitsträngar.

product_info
str
Obligatorisk

Konfigurationsalternativ. Standardvärdet är tom sträng. Strängen innehåller godtycklig produktinformation som läggs till i användaragentsträngen.

proxy_options
ProxyOptions
Obligatorisk

Alternativ för att skicka trafik via proxyservrar.

keep_alive
int
Obligatorisk

Maximal period i sekunder mellan kommunikation med den asynkrona meddelandekön. Om inga andra meddelanden utbyts styr detta den hastighet med vilken klienten skickar ping-meddelanden till den asynkrona meddelandekön. Om det inte anges används standardvärdet 60 sek.

auto_connect
bool
Obligatorisk

Anslut klienten automatiskt till IoTHub när en metod anropas som kräver att en anslutning upprättas. (Standard: Sant)

connection_retry
bool
Obligatorisk

Försök att återupprätta en avbruten anslutning (standard: Sant)

connection_retry_interval
int
Obligatorisk

Intervall i sekunder mellan försök att återupprätta en avbruten anslutning (standard: 10)

ensure_desired_properties
bool
Obligatorisk

Se till att korrigeringen för de senaste önskade egenskaperna har tagits emot vid återanslutningar (Standard:Sant)

Undantag

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

create_from_x509_certificate

Instansiera en klient med X509-certifikatautentisering.

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

Parametrar

hostname
str
Obligatorisk

Värd som kör IotHub. Du hittar i Azure Portal på fliken Översikt som strängens värdnamn.

x509
X509
Obligatorisk

Det fullständiga x509-certifikatobjektet. Om du vill använda certifikatet måste registreringsobjektet innehålla certifikat (antingen rotcertifikatet eller något av de mellanliggande CA-certifikaten). Om certifikatet kommer från en CER-fil måste det vara base64-kodat.

device_id
str
Obligatorisk

Det ID som används för att unikt identifiera en enhet i IoTHub

module_id
str
Obligatorisk

Det ID som används för att unikt identifiera en modul på en enhet på IoTHub.

server_verification_cert
str
Obligatorisk

Konfigurationsalternativ. Den betrodda certifikatkedjan. Krävs vid anslutning till en slutpunkt som har en förtroenderot som inte är standard, till exempel en protokollgateway.

gateway_hostname
str
Obligatorisk

Konfigurationsalternativ. Gateway-värdnamnet för gatewayenheten.

websockets
bool
Obligatorisk

Konfigurationsalternativ. Standardvärdet är Falskt. Ange till true om du använder MQTT över websockets.

cipher
str eller list(str)
Obligatorisk

Konfigurationsalternativ. Chiffersviter för TLS/SSL, som en sträng i "OpenSSL-chifferlistformat" eller som en lista över chiffersvitsträngar.

product_info
str
Obligatorisk

Konfigurationsalternativ. Standardvärdet är tom sträng. Strängen innehåller godtycklig produktinformation som läggs till i användaragentsträngen.

proxy_options
ProxyOptions
Obligatorisk

Alternativ för att skicka trafik via proxyservrar.

keep_alive
int
Obligatorisk

Maximal period i sekunder mellan kommunikation med den asynkrona meddelandekön. Om inga andra meddelanden utbyts styr detta den hastighet med vilken klienten skickar ping-meddelanden till den asynkrona meddelandekön. Om det inte anges används standardvärdet 60 sek.

auto_connect
bool
Obligatorisk

Anslut klienten automatiskt till IoTHub när en metod anropas som kräver att en anslutning upprättas. (Standard: Sant)

connection_retry
bool
Obligatorisk

Försök att återupprätta en avbruten anslutning (standard: Sant)

connection_retry_interval
int
Obligatorisk

Intervall i sekunder mellan försök att återupprätta en avbruten anslutning (standard: 10)

ensure_desired_properties
bool
Obligatorisk

Se till att korrigeringen för de senaste önskade egenskaperna har tagits emot vid återanslutningar (Standard:Sant)

Returer

En instans av en IoTHub-klient som använder ett X509-certifikat för autentisering.

Undantag

TypeError if given an unsupported parameter.

disconnect

Koppla bort klienten från Azure IoT Hub- eller Azure IoT Edge Hub-instansen.

Vi rekommenderar att du anropar den här funktionen när du är helt klar med klientinstansen.

Det här är ett synkront anrop, vilket innebär att den här funktionen inte returneras förrän anslutningen till tjänsten har stängts helt.

disconnect()

Undantag

om det uppstår ett oväntat fel under körningen.

get_twin

Hämtar enhets- eller modultvillingen från tjänsten Azure IoT Hub eller Azure IoT Edge Hub.

Det här är ett synkront anrop, vilket innebär att den här funktionen inte returneras förrän tvillingen har hämtats från tjänsten.

get_twin()

Returer

Fullständig tvilling som JSON-diktering

Returtyp

Undantag

om autentiseringsuppgifterna är ogiltiga och det inte går att upprätta en anslutning.

om en upprättande av en anslutning resulterar i fel.

om anslutningen går förlorad under körningen.

om anslutningsförsöket överskrider tidsgränsen

om klienten inte är ansluten (och det inte finns någon automatisk anslutning aktiverad)

om det uppstår ett oväntat fel under körningen.

invoke_method

Anropa en metod från klienten till en enhets- eller modulklient och ta emot svaret på metodanropet.

invoke_method(method_params, device_id, module_id=None)

Parametrar

method_params
dict
Obligatorisk

Ska innehålla en methodName (str), nyttolast (str), connectTimeoutInSeconds (int), responseTimeoutInSeconds (int).

device_id
str
Obligatorisk

Enhets-ID för målenheten där metoden ska anropas.

module_id
str
standardvärde: None

Modul-ID för målmodulen där metoden ska anropas. (Valfritt)

Returer

method_result ska innehålla en status och en nyttolast

Returtyp

Undantag

om autentiseringsuppgifterna är ogiltiga och det inte går att upprätta en anslutning.

om en upprättande av en anslutning resulterar i fel.

om anslutningen går förlorad under körningen.

om anslutningen överskrider tidsgränsen.

om det uppstår ett oväntat fel under körningen.

patch_twin_reported_properties

Uppdatera rapporterade egenskaper med tjänsten Azure IoT Hub eller Azure IoT Edge Hub.

Det här är ett synkront anrop, vilket innebär att den här funktionen inte returneras förrän korrigeringen har skickats till tjänsten och bekräftats.

Om tjänsten returnerar ett fel i korrigeringsåtgärden genererar den här funktionen rätt fel.

patch_twin_reported_properties(reported_properties_patch)

Parametrar

reported_properties_patch
dict
Obligatorisk

Korrigering av tvillingrapporterade egenskaper som en JSON-diktering

Undantag

om autentiseringsuppgifterna är ogiltiga och det inte går att upprätta en anslutning.

om en upprättande av en anslutning resulterar i fel.

om anslutningen går förlorad under körningen.

om anslutningsförsöket överskrider tidsgränsen

om klienten inte är ansluten (och det inte finns någon automatisk anslutning aktiverad)

om det uppstår ett oväntat fel under körningen.

receive_message_on_input

Ta emot ett indatameddelande som har skickats från en annan modul till en specifik indata.

Inaktuell sedan version 2.3.0: Vi rekommenderar att du använder egenskapen .on_message_received för att ange en hanterare i stället

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

Parametrar

input_name
str
Obligatorisk

Det indatanamn som ett meddelande ska visas på.

block
bool
Obligatorisk

Anger om åtgärden ska blockeras tills ett meddelande tas emot.

timeout
int
Obligatorisk

Du kan också ange ett antal sekunder tills tidsgränsen uppnås för blockeringen.

Returer

Meddelande som skickades till angivna indata eller Ingen om ingen metodbegäran har tagits emot i slutet av blockeringsperioden.

Undantag

om autentiseringsuppgifterna är ogiltiga och det inte går att upprätta en anslutning.

om en upprättande av en anslutning resulterar i fel.

om anslutningen går förlorad under körningen.

om anslutningen överskrider tidsgränsen.

om det uppstår ett oväntat fel under körningen.

receive_method_request

Ta emot en metodbegäran via Azure IoT Hub eller Azure IoT Edge Hub.

Inaktuell sedan version 2.3.0: Vi rekommenderar att du använder egenskapen .on_method_request_received för att ange en hanterare i stället

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

Parametrar

method_name
str
standardvärde: None

Du kan också ange namnet på metoden som du vill ta emot begäranden för. Om den här parametern inte anges tas alla metoder som inte redan är specifikt inriktade på en annan begäran till receive_method emot.

block
bool
standardvärde: True

Anger om åtgärden ska blockeras tills en begäran tas emot.

timeout
int
standardvärde: None

Du kan också ange ett antal sekunder tills tidsgränsen uppnås för blockeringen.

Returer

MethodRequest-objekt som representerar den mottagna metodbegäran eller Ingen om ingen metodbegäran har tagits emot i slutet av blockeringsperioden.

Undantag

om autentiseringsuppgifterna är ogiltiga och det inte går att upprätta en anslutning.

om en upprättande av en anslutning resulterar i fel.

om anslutningen går förlorad under körningen.

om anslutningen överskrider tidsgränsen.

om det uppstår ett oväntat fel under körningen.

receive_twin_desired_properties_patch

Få en önskad egenskapskorrigering via Azure IoT Hub eller Azure IoT Edge Hub.

Det här är ett synkront anrop, vilket innebär följande:

  1. Om block=True blockeras den här funktionen tills något av följande händer:

    • en önskad egenskapskorrigering tas emot från Azure IoT Hub eller Azure IoT Edge Hub.

    • tidsgränsen, om så anges, förflutit. Om en timeout inträffar utlöser den här funktionen ett InboxEmpty-undantag

  2. Om block=False returnerar den här funktionen önskade egenskapskorrigeringar som kan ha tagits emot av pipelinen, men som ännu inte har returnerats till programmet. Om inga önskade egenskapskorrigeringar har tagits emot av pipelinen genererar den här funktionen ett InboxEmpty-undantag

Inaktuell sedan version 2.3.0: Vi rekommenderar att du använder egenskapen .on_twin_desired_properties_patch_received för att ange en hanterare i stället

receive_twin_desired_properties_patch(block=True, timeout=None)

Parametrar

block
bool
standardvärde: True

Anger om åtgärden ska blockeras tills en begäran tas emot.

timeout
int
standardvärde: None

Du kan också ange ett antal sekunder tills tidsgränsen uppnås för blockeringen.

Returer

Korrigering av önskade egenskaper för tvilling som en JSON-diktering eller Ingen om ingen korrigering har tagits emot i slutet av blockeringsperioden

Returtyp

dict,

Undantag

om autentiseringsuppgifterna är ogiltiga och det inte går att upprätta en anslutning.

om en upprättande av en anslutning resulterar i fel.

om anslutningen går förlorad under körningen.

om anslutningen överskrider tidsgränsen.

om det uppstår ett oväntat fel under körningen.

send_message

Skickar ett meddelande till standardhändelseslutpunkten på Azure IoT Hub- eller Azure IoT Edge Hub-instansen.

Det här är en synkron händelse, vilket innebär att den här funktionen inte returneras förrän händelsen har skickats till tjänsten och tjänsten har bekräftat mottagandet av händelsen.

Om anslutningen till tjänsten inte tidigare har öppnats av ett anrop för att ansluta öppnar den här funktionen anslutningen innan händelsen skickas.

send_message(message)

Parametrar

message
Message
Obligatorisk

Det faktiska meddelandet som ska skickas. Allt som skickas som inte är en instans av klassen Message konverteras till Message-objektet.

Undantag

om autentiseringsuppgifterna är ogiltiga och det inte går att upprätta en anslutning.

om en upprättande av en anslutning resulterar i fel.

om anslutningen går förlorad under körningen.

om anslutningsförsöket överskrider tidsgränsen

om klienten inte är ansluten (och det inte finns någon automatisk anslutning aktiverad)

om det uppstår ett oväntat fel under körningen.

ValueError if the message fails size validation.

send_message_to_output

Skickar en händelse/ett meddelande till den angivna modulens utdata.

Det här är utgående händelser och är avsedda att vara "utdatahändelser".

Det här är en synkron händelse, vilket innebär att den här funktionen inte returneras förrän händelsen har skickats till tjänsten och tjänsten har bekräftat mottagandet av händelsen.

Om anslutningen till tjänsten inte tidigare har öppnats av ett anrop för att ansluta öppnar den här funktionen anslutningen innan händelsen skickas.

send_message_to_output(message, output_name)

Parametrar

message
Message
Obligatorisk

Meddelande som ska skickas till angivna utdata. Allt som skickas som inte är en instans av klassen Message konverteras till Message-objektet.

output_name
str
Obligatorisk

Namnet på de utdata som händelsen ska skickas till.

Undantag

om autentiseringsuppgifterna är ogiltiga och det inte går att upprätta en anslutning.

om en upprättande av en anslutning resulterar i fel.

om anslutningen går förlorad under körningen.

om anslutningsförsöket överskrider tidsgränsen

om klienten inte är ansluten (och det inte finns någon automatisk anslutning aktiverad)

om det uppstår ett oväntat fel under körningen.

ValueError if the message fails size validation.

send_method_response

Skicka ett svar på en metodbegäran via Azure IoT Hub eller Azure IoT Edge Hub.

Det här är en synkron händelse, vilket innebär att den här funktionen inte returneras förrän händelsen har skickats till tjänsten och tjänsten har bekräftat mottagandet av händelsen.

Om anslutningen till tjänsten inte tidigare har öppnats av ett anrop för att ansluta öppnar den här funktionen anslutningen innan händelsen skickas.

send_method_response(method_response)

Parametrar

method_response
MethodResponse
Obligatorisk

MethodResponse som ska skickas.

Undantag

om autentiseringsuppgifterna är ogiltiga och det inte går att upprätta en anslutning.

om en upprättande av en anslutning resulterar i fel.

om anslutningen går förlorad under körningen.

om anslutningsförsöket överskrider tidsgränsen

om klienten inte är ansluten (och det inte finns någon automatisk anslutning aktiverad)

om det uppstår ett oväntat fel under körningen.

shutdown

Stäng av klienten för korrekt avslut.

När den här metoden anropas resulterar alla försök till ytterligare klientanrop i att en ClientError aktiveras

shutdown()

Undantag

om det uppstår ett oväntat fel under körningen.

update_sastoken

Uppdatera klientens SAS-token som används för autentisering och auktoriserar sedan anslutningen igen.

Det här API:et kan endast användas om klienten ursprungligen skapades med en SAS-token.

update_sastoken(sastoken)

Parametrar

sastoken
str
Obligatorisk

Den nya SAS-tokensträngen som klienten ska använda

Undantag

ValueError if the sastoken parameter is invalid

om autentiseringsuppgifterna är ogiltiga och det inte går att återupprätta en anslutning.

om en återupprättande av anslutningen resulterar i fel.

om anslutningen går förlorad under körningen.

om tidsgränsen uppnås för omauktoriseringsförsöket.

om klienten inte skapades ursprungligen med en SAS-token.

om det uppstår ett oväntat fel under körningen.

Attribut

connected

Skrivskyddad egenskap som anger om transporten är ansluten eller inte.

on_background_exception

Hanteringsfunktionen eller coroutine anropas när ett bakgrundsundantag inträffar.

Definitionen av funktionen eller coroutine bör ha ett positionsargument (undantagsobjektet)

on_connection_state_change

Hanteringsfunktionen eller coroutine som anropas när anslutningstillståndet ändras.

Definitionen av funktionen eller coroutine bör inte ha några positionsargument.

on_message_received

Hanteringsfunktionen eller coroutine som anropas när ett indatameddelande tas emot.

Funktionsdefinitionen eller coroutine bör ha ett positionsargument (objektet Message )

on_method_request_received

Hanteringsfunktionen eller coroutine som anropas när en metodbegäran tas emot.

Kom ihåg att bekräfta metodbegäran i din funktion eller coroutine med hjälp av klientens metod .send_method_response().

Definitionen av funktionen eller coroutine bör ha ett positionsargument (objektet MethodRequest )

on_new_sastoken_required

Hanteringsfunktionen eller coroutine som anropas när klienten kräver en ny SAS-token. Detta inträffar ungefär 2 minuter innan SAS-token upphör att gälla. Om livslängden överskrider cirka 49 dagar på Windows-plattformar krävs en ny token efter dessa 49 dagar oavsett hur lång SAS-livslängden är.

Observera att den här hanteraren ENDAST behövs när du använder en klient som skapats via metoden .create_from_sastoken().

Den nya token kan anges i din funktion eller coroutine via hjälp av klientens metod .update_sastoken().

Definitionen av funktionen eller coroutine bör inte ha några positionsargument.

on_twin_desired_properties_patch_received

Hanteringsfunktionen eller coroutine som anropas när en uppdatering av önskade egenskaper för tvilling tas emot.

Definitionen av funktionen eller coroutine bör ha ett positionsargument (tvillingkorrigeringen i form av ett JSON-ordlisteobjekt)