IoTHubModuleClient Klas
Een synchrone moduleclient die verbinding maakt met een Azure IoT Hub- of Azure IoT Edge-exemplaar.
Initialisatie voor een IoTHubModuleClient.
Deze initialisatiefunctie mag niet rechtstreeks worden aangeroepen. Gebruik in plaats daarvan een van de klassemethode '>>create_from_<<' om te instantiëren
- Overname
-
azure.iot.device.iothub.sync_clients.GenericIoTHubClientIoTHubModuleClientazure.iot.device.iothub.abstract_clients.AbstractIoTHubModuleClientIoTHubModuleClient
Constructor
IoTHubModuleClient(mqtt_pipeline, http_pipeline)Parameters
- mqtt_pipeline
- <xref:azure.iot.device.iothub.pipeline.MQTTPipeline>
De pijplijn die wordt gebruikt om verbinding te maken met het IoTHub-eindpunt.
- http_pipeline
- <xref:azure.iot.device.iothub.pipeline.HTTPPipeline>
De pijplijn die wordt gebruikt om via HTTP verbinding te maken met het IoTHub-eindpunt.
Methoden
| connect |
Hiermee wordt de client verbonden met een Azure IoT Hub- of Azure IoT Edge Hub-exemplaar. De bestemming wordt gekozen op basis van de referenties die zijn doorgegeven via de auth_provider parameter die is opgegeven toen dit object werd geïnitialiseerd. Dit is een synchrone aanroep, wat betekent dat deze functie pas wordt geretourneerd als de verbinding met de service volledig tot stand is gebracht. |
| create_from_connection_string |
Maak een instantie van de client vanaf een IoTHub-apparaat of module connection string. |
| create_from_edge_environment |
Instantieer de client vanuit de IoT Edge-omgeving. Deze methode kan alleen worden uitgevoerd vanuit een IoT Edge-container of in een foutopsporingsomgeving die is geconfigureerd voor Edge-ontwikkeling (bijvoorbeeld Visual Studio, Visual Studio Code) |
| create_from_sastoken |
De client instantiëren vanuit een vooraf gemaakte SAS-tokentekenreeks |
| create_from_x509_certificate |
Een client instantiëren met X509-certificaatverificatie. |
| disconnect |
Verbreek de verbinding met de client met het Azure IoT Hub- of Azure IoT Edge Hub-exemplaar. Het wordt aanbevolen om deze functie aan te roepen wanneer u volledig klaar bent met het clientexemplaar. Dit is een synchrone aanroep, wat betekent dat deze functie pas wordt geretourneerd als de verbinding met de service volledig is gesloten. |
| get_twin |
Haalt de apparaat- of moduledubbel op uit de Azure IoT Hub- of Azure IoT Edge Hub-service. Dit is een synchrone aanroep, wat betekent dat deze functie pas retourneert als de dubbel is opgehaald uit de service. |
| invoke_method |
Roep een methode aan vanaf uw client op een apparaat of moduleclient en ontvang het antwoord op de methode-aanroep. |
| patch_twin_reported_properties |
Werk gerapporteerde eigenschappen bij met de Azure IoT Hub- of Azure IoT Edge Hub-service. Dit is een synchrone aanroep, wat betekent dat deze functie pas wordt geretourneerd als de patch naar de service is verzonden en bevestigd. Als de service een fout retourneert bij de patchbewerking, genereert deze functie de juiste fout. |
| receive_message_on_input |
Een invoerbericht ontvangen dat vanuit een andere module naar een specifieke invoer is verzonden. Afgeschaft sinds versie 2.3.0: u wordt aangeraden de eigenschap .on_message_received te gebruiken om in plaats daarvan een handler in te stellen |
| receive_method_request |
Een methodeaanvraag ontvangen via de Azure IoT Hub of Azure IoT Edge Hub. Afgeschaft sinds versie 2.3.0: u wordt aangeraden de eigenschap .on_method_request_received te gebruiken om in plaats daarvan een handler in te stellen |
| receive_twin_desired_properties_patch |
Ontvang een gewenste eigenschapspatch via de Azure IoT Hub of Azure IoT Edge Hub. Dit is een synchrone aanroep, wat het volgende betekent:
Afgeschaft sinds versie 2.3.0: u wordt aangeraden de eigenschap .on_twin_desired_properties_patch_received te gebruiken om in plaats daarvan een handler in te stellen |
| send_message |
Hiermee wordt een bericht verzonden naar het eindpunt voor standaard gebeurtenissen op het Azure IoT Hub- of Azure IoT Edge Hub-exemplaar. Dit is een synchrone gebeurtenis, wat betekent dat deze functie pas wordt geretourneerd als de gebeurtenis naar de service is verzonden en de service de ontvangst van de gebeurtenis heeft bevestigd. Als de verbinding met de service nog niet eerder is geopend door een aanroep om verbinding te maken, opent deze functie de verbinding voordat de gebeurtenis wordt verzonden. |
| send_message_to_output |
Hiermee wordt een gebeurtenis/bericht naar de opgegeven module-uitvoer verzonden. Dit zijn uitgaande gebeurtenissen en zijn bedoeld als 'uitvoer gebeurtenissen'. Dit is een synchrone gebeurtenis, wat betekent dat deze functie pas wordt geretourneerd als de gebeurtenis naar de service is verzonden en de service de ontvangst van de gebeurtenis heeft bevestigd. Als de verbinding met de service nog niet eerder is geopend door een aanroep om verbinding te maken, opent deze functie de verbinding voordat de gebeurtenis wordt verzonden. |
| send_method_response |
Verzend een antwoord op een methodeaanvraag via de Azure IoT Hub of Azure IoT Edge Hub. Dit is een synchrone gebeurtenis, wat betekent dat deze functie pas wordt geretourneerd als de gebeurtenis naar de service is verzonden en de service de ontvangst van de gebeurtenis heeft bevestigd. Als de verbinding met de service nog niet eerder is geopend door een aanroep om verbinding te maken, opent deze functie de verbinding voordat de gebeurtenis wordt verzonden. |
| shutdown |
Sluit de client af voor een probleemloze afsluiting. Zodra deze methode is aangeroepen, leiden pogingen tot verdere clientaanroepen ertoe dat een ClientError wordt gegenereerd |
| update_sastoken |
Werk het SAS-token van de client bij dat wordt gebruikt voor verificatie en geeft vervolgens opnieuw verificatie aan voor de verbinding. Deze API kan alleen worden gebruikt als de client in eerste instantie is gemaakt met een SAS-token. |
connect
Hiermee wordt de client verbonden met een Azure IoT Hub- of Azure IoT Edge Hub-exemplaar.
De bestemming wordt gekozen op basis van de referenties die zijn doorgegeven via de auth_provider parameter die is opgegeven toen dit object werd geïnitialiseerd.
Dit is een synchrone aanroep, wat betekent dat deze functie pas wordt geretourneerd als de verbinding met de service volledig tot stand is gebracht.
connect()Uitzonderingen
als referenties ongeldig zijn en er geen verbinding tot stand kan worden gebracht.
als het tot stand brengen van een verbinding mislukt.
als de verbinding tijdens de uitvoering is verbroken.
als er een time-out optreedt voor de verbinding.
als er een onverwachte fout optreedt tijdens de uitvoering.
create_from_connection_string
Maak een instantie van de client vanaf een IoTHub-apparaat of module connection string.
create_from_connection_string(connection_string, **kwargs)Parameters
- server_verification_cert
- str
Configuratieoptie. De vertrouwde certificaatketen. Dit is nodig wanneer u verbinding maakt met een eindpunt dat een niet-standaardvertrouwensbasis heeft, zoals een protocolgateway.
- websockets
- bool
Configuratieoptie. De standaardwaarde is Onwaar. Stel in op true als U MQTT via websockets gebruikt.
Configuratieoptie. Coderingssuite(s) voor TLS/SSL, als tekenreeks in 'OpenSSL-coderingslijstindeling' of als een lijst met coderingssuitetekenreeksen.
- product_info
- str
Configuratieoptie. De standaardwaarde is een lege tekenreeks. De tekenreeks bevat willekeurige productgegevens die worden toegevoegd aan de tekenreeks van de gebruikersagent.
- sastoken_ttl
- int
De time to live (in seconden) voor het gemaakte SasToken dat wordt gebruikt voor verificatie. De standaardwaarde is 3600 seconden (1 uur).
- keep_alive
- int
Maximale periode in seconden tussen de communicatie met de broker. Als er geen andere berichten worden uitgewisseld, bepaalt dit de snelheid waarmee de client pingberichten naar de broker verzendt. Indien niet opgegeven, wordt de standaardwaarde van 60 seconden gebruikt.
- auto_connect
- bool
Verbind de client automatisch met IoTHub wanneer een methode wordt aangeroepen waarvoor een verbinding tot stand moet worden gebracht. (Standaard: Waar)
- connection_retry
- bool
Poging om een verbroken verbinding opnieuw tot stand te brengen (standaard: waar)
- connection_retry_interval
- int
Interval, in seconden, tussen pogingen om een verbroken verbinding opnieuw tot stand te brengen (standaard: 10)
- ensure_desired_properties
- bool
Zorg ervoor dat de meest recente patch voor gewenste eigenschappen is ontvangen bij het opnieuw maken van verbindingen (standaard:waar)
Retouren
Een exemplaar van een IoTHub-client die gebruikmaakt van een connection string voor verificatie.
Uitzonderingen
create_from_edge_environment
Instantieer de client vanuit de IoT Edge-omgeving.
Deze methode kan alleen worden uitgevoerd vanuit een IoT Edge-container of in een foutopsporingsomgeving die is geconfigureerd voor Edge-ontwikkeling (bijvoorbeeld Visual Studio, Visual Studio Code)
create_from_edge_environment(**kwargs)Parameters
- websockets
- bool
Configuratieoptie. De standaardwaarde is Onwaar. Stel in op true als U MQTT via websockets gebruikt.
Configuratieoptie. Coderingssuite(s) voor TLS/SSL, als tekenreeks in 'OpenSSL-coderingslijstindeling' of als een lijst met coderingssuitetekenreeksen.
- product_info
- str
Configuratieoptie. De standaardwaarde is een lege tekenreeks. De tekenreeks bevat willekeurige productgegevens die worden toegevoegd aan de tekenreeks van de gebruikersagent.
- sastoken_ttl
- int
De time to live (in seconden) voor het gemaakte SasToken dat wordt gebruikt voor verificatie. De standaardwaarde is 3600 seconden (1 uur)
- keep_alive
- int
Maximale periode in seconden tussen de communicatie met de broker. Als er geen andere berichten worden uitgewisseld, bepaalt dit de snelheid waarmee de client pingberichten naar de broker verzendt. Indien niet opgegeven, wordt de standaardwaarde van 60 seconden gebruikt.
- auto_connect
- bool
Verbind de client automatisch met IoTHub wanneer een methode wordt aangeroepen waarvoor een verbinding tot stand moet worden gebracht. (Standaard: Waar)
- connection_retry
- bool
Poging om een verbroken verbinding opnieuw tot stand te brengen (standaard: waar)
- connection_retry_interval
- int
Interval, in seconden, tussen pogingen om een verbroken verbinding opnieuw tot stand te brengen (standaard: 10)
Retouren
Een exemplaar van een IoTHub-client die de IoT Edge-omgeving gebruikt voor verificatie.
Uitzonderingen
create_from_sastoken
De client instantiëren vanuit een vooraf gemaakte SAS-tokentekenreeks
create_from_sastoken(sastoken, **kwargs)Parameters
- server_verification_cert
- str
Configuratieoptie. De vertrouwde certificaatketen. Dit is nodig wanneer u verbinding maakt met een eindpunt dat een niet-standaardvertrouwensbasis heeft, zoals een protocolgateway.
- gateway_hostname
- str
Configuratieoptie. De hostnaam van de gateway voor het gatewayapparaat.
- websockets
- bool
Configuratieoptie. De standaardwaarde is Onwaar. Stel in op true als U MQTT via websockets gebruikt.
Configuratieoptie. Coderingssuite(s) voor TLS/SSL, als tekenreeks in 'OpenSSL-coderingslijstindeling' of als een lijst met coderingssuitetekenreeksen.
- product_info
- str
Configuratieoptie. De standaardwaarde is een lege tekenreeks. De tekenreeks bevat willekeurige productgegevens die worden toegevoegd aan de tekenreeks van de gebruikersagent.
- keep_alive
- int
Maximale periode in seconden tussen de communicatie met de broker. Als er geen andere berichten worden uitgewisseld, bepaalt dit de snelheid waarmee de client pingberichten naar de broker verzendt. Indien niet opgegeven, wordt de standaardwaarde van 60 seconden gebruikt.
- auto_connect
- bool
Verbind de client automatisch met IoTHub wanneer een methode wordt aangeroepen waarvoor een verbinding tot stand moet worden gebracht. (Standaard: Waar)
- connection_retry
- bool
Poging om een verbroken verbinding opnieuw tot stand te brengen (standaard: waar)
- connection_retry_interval
- int
Interval, in seconden, tussen pogingen om een verbroken verbinding opnieuw tot stand te brengen (standaard: 10)
- ensure_desired_properties
- bool
Zorg ervoor dat de meest recente patch voor gewenste eigenschappen is ontvangen bij het opnieuw maken van verbindingen (standaard:waar)
Uitzonderingen
create_from_x509_certificate
Een client instantiëren met X509-certificaatverificatie.
create_from_x509_certificate(x509, hostname, device_id, module_id, **kwargs)Parameters
- hostname
- str
Host waarop de IotHub wordt uitgevoerd. U kunt deze vinden in de Azure Portal op het tabblad Overzicht als de hostnaam van de tekenreeks.
- x509
- X509
Het volledige x509-certificaatobject. Als u het certificaat wilt gebruiken, moet het inschrijvingsobject een certificaat bevatten (het basiscertificaat of een van de tussenliggende CA-certificaten). Als het certificaat afkomstig is van een CER-bestand, moet het base64-codering hebben.
- module_id
- str
De id die wordt gebruikt om een module op een apparaat op de IoTHub uniek te identificeren.
- server_verification_cert
- str
Configuratieoptie. De vertrouwde certificaatketen. Dit is nodig wanneer u verbinding maakt met een eindpunt dat een niet-standaardvertrouwensbasis heeft, zoals een protocolgateway.
- gateway_hostname
- str
Configuratieoptie. De hostnaam van de gateway voor het gatewayapparaat.
- websockets
- bool
Configuratieoptie. De standaardwaarde is Onwaar. Stel in op true als U MQTT via websockets gebruikt.
Configuratieoptie. Coderingssuite(s) voor TLS/SSL, als tekenreeks in 'OpenSSL-coderingslijstindeling' of als een lijst met coderingssuitetekenreeksen.
- product_info
- str
Configuratieoptie. De standaardwaarde is een lege tekenreeks. De tekenreeks bevat willekeurige productgegevens die worden toegevoegd aan de tekenreeks van de gebruikersagent.
- keep_alive
- int
Maximale periode in seconden tussen de communicatie met de broker. Als er geen andere berichten worden uitgewisseld, bepaalt dit de snelheid waarmee de client pingberichten naar de broker verzendt. Indien niet opgegeven, wordt de standaardwaarde van 60 seconden gebruikt.
- auto_connect
- bool
Verbind de client automatisch met IoTHub wanneer een methode wordt aangeroepen waarvoor een verbinding tot stand moet worden gebracht. (Standaard: Waar)
- connection_retry
- bool
Poging om een verbroken verbinding opnieuw tot stand te brengen (standaard: waar)
- connection_retry_interval
- int
Interval, in seconden, tussen pogingen om een verbroken verbinding opnieuw tot stand te brengen (standaard: 10)
- ensure_desired_properties
- bool
Zorg ervoor dat de meest recente patch voor gewenste eigenschappen is ontvangen bij het opnieuw maken van verbindingen (standaard:waar)
Retouren
Een exemplaar van een IoTHub-client die een X509-certificaat gebruikt voor verificatie.
Uitzonderingen
disconnect
Verbreek de verbinding met de client met het Azure IoT Hub- of Azure IoT Edge Hub-exemplaar.
Het wordt aanbevolen om deze functie aan te roepen wanneer u volledig klaar bent met het clientexemplaar.
Dit is een synchrone aanroep, wat betekent dat deze functie pas wordt geretourneerd als de verbinding met de service volledig is gesloten.
disconnect()Uitzonderingen
als er een onverwachte fout optreedt tijdens de uitvoering.
get_twin
Haalt de apparaat- of moduledubbel op uit de Azure IoT Hub- of Azure IoT Edge Hub-service.
Dit is een synchrone aanroep, wat betekent dat deze functie pas retourneert als de dubbel is opgehaald uit de service.
get_twin()Retouren
Dubbel voltooien als JSON-dicteerfunctie
Retourtype
Uitzonderingen
als referenties ongeldig zijn en er geen verbinding tot stand kan worden gebracht.
als het tot stand brengen van een verbinding mislukt.
als de verbinding tijdens de uitvoering is verbroken.
als er een time-out optreedt voor de verbindingspoging
als de client niet is verbonden (en er geen automatische verbinding is ingeschakeld)
als er een onverwachte fout optreedt tijdens de uitvoering.
invoke_method
Roep een methode aan vanaf uw client op een apparaat of moduleclient en ontvang het antwoord op de methode-aanroep.
invoke_method(method_params, device_id, module_id=None)Parameters
- method_params
- dict
Moet een methodName (str), payload (str), connectTimeoutInSeconds (int), responseTimeoutInSeconds (int) bevatten.
- module_id
- str
Module-id van de doelmodule waarin de methode wordt aangeroepen. (Optioneel)
Retouren
method_result moet een status en een nettolading bevatten
Retourtype
Uitzonderingen
als referenties ongeldig zijn en er geen verbinding tot stand kan worden gebracht.
als het tot stand brengen van een verbinding mislukt.
als de verbinding tijdens de uitvoering is verbroken.
als er een time-out optreedt voor de verbinding.
als er een onverwachte fout optreedt tijdens de uitvoering.
patch_twin_reported_properties
Werk gerapporteerde eigenschappen bij met de Azure IoT Hub- of Azure IoT Edge Hub-service.
Dit is een synchrone aanroep, wat betekent dat deze functie pas wordt geretourneerd als de patch naar de service is verzonden en bevestigd.
Als de service een fout retourneert bij de patchbewerking, genereert deze functie de juiste fout.
patch_twin_reported_properties(reported_properties_patch)Parameters
Uitzonderingen
als referenties ongeldig zijn en er geen verbinding tot stand kan worden gebracht.
als het tot stand brengen van een verbinding mislukt.
als de verbinding tijdens de uitvoering is verbroken.
als er een time-out optreedt voor de verbindingspoging
als de client niet is verbonden (en er geen automatische verbinding is ingeschakeld)
als er een onverwachte fout optreedt tijdens de uitvoering.
receive_message_on_input
Een invoerbericht ontvangen dat vanuit een andere module naar een specifieke invoer is verzonden.
Afgeschaft sinds versie 2.3.0: u wordt aangeraden de eigenschap .on_message_received te gebruiken om in plaats daarvan een handler in te stellen
receive_message_on_input(input_name, block=True, timeout=None)Parameters
- block
- bool
Geeft aan of de bewerking moet worden geblokkeerd totdat een bericht wordt ontvangen.
- timeout
- int
Geef desgewenst een aantal seconden op totdat er een time-out optreedt voor blokkering.
Retouren
Bericht dat is verzonden naar de opgegeven invoer of Geen als er geen methodeaanvraag is ontvangen aan het einde van de blokkeringsperiode.
Uitzonderingen
als referenties ongeldig zijn en er geen verbinding tot stand kan worden gebracht.
als het tot stand brengen van een verbinding mislukt.
als de verbinding tijdens de uitvoering is verbroken.
als er een time-out optreedt voor de verbinding.
als er een onverwachte fout optreedt tijdens de uitvoering.
receive_method_request
Een methodeaanvraag ontvangen via de Azure IoT Hub of Azure IoT Edge Hub.
Afgeschaft sinds versie 2.3.0: u wordt aangeraden de eigenschap .on_method_request_received te gebruiken om in plaats daarvan een handler in te stellen
receive_method_request(method_name=None, block=True, timeout=None)Parameters
- method_name
- str
Geef eventueel de naam op van de methode waarvoor aanvragen moeten worden ontvangen. Als deze parameter niet wordt opgegeven, worden alle methoden die niet al specifiek zijn gericht door een andere aanvraag voor receive_method ontvangen.
- block
- bool
Geeft aan of de bewerking moet worden geblokkeerd totdat een aanvraag is ontvangen.
- timeout
- int
Geef desgewenst een aantal seconden op totdat er een time-out optreedt voor blokkering.
Retouren
MethodRequest-object dat de ontvangen methodeaanvraag vertegenwoordigt, of Geen als er aan het einde van de blokkeringsperiode geen methodeaanvraag is ontvangen.
Uitzonderingen
als referenties ongeldig zijn en er geen verbinding tot stand kan worden gebracht.
als het tot stand brengen van een verbinding mislukt.
als de verbinding tijdens de uitvoering is verbroken.
als er een time-out optreedt voor de verbinding.
als er een onverwachte fout optreedt tijdens de uitvoering.
receive_twin_desired_properties_patch
Ontvang een gewenste eigenschapspatch via de Azure IoT Hub of Azure IoT Edge Hub.
Dit is een synchrone aanroep, wat het volgende betekent:
Als blok=Waar, wordt deze functie geblokkeerd totdat een van de volgende dingen gebeurt:
een gewenste eigenschapspatch wordt ontvangen van de Azure IoT Hub of Azure IoT Edge Hub.
de time-outperiode, indien opgegeven, is verstreken. Als er een time-out optreedt, genereert deze functie een uitzondering voor Postvak IN
Als blok=onwaar, retourneert deze functie alle gewenste eigenschapspatches die mogelijk zijn ontvangen door de pijplijn, maar nog niet zijn geretourneerd naar de toepassing. Als er geen gewenste eigenschapspatches zijn ontvangen door de pijplijn, genereert deze functie een uitzondering voor Postvak IN
Afgeschaft sinds versie 2.3.0: u wordt aangeraden de eigenschap .on_twin_desired_properties_patch_received te gebruiken om in plaats daarvan een handler in te stellen
receive_twin_desired_properties_patch(block=True, timeout=None)Parameters
- block
- bool
Geeft aan of de bewerking moet worden geblokkeerd totdat een aanvraag is ontvangen.
- timeout
- int
Geef desgewenst een aantal seconden op totdat er een time-out optreedt voor blokkering.
Retouren
Patch voor gewenste eigenschappen van dubbel als JSON-dict of Geen als er aan het einde van de blokkeringsperiode geen patch is ontvangen
Retourtype
Uitzonderingen
als referenties ongeldig zijn en er geen verbinding tot stand kan worden gebracht.
als het tot stand brengen van een verbinding mislukt.
als de verbinding tijdens de uitvoering is verbroken.
als er een time-out optreedt voor de verbinding.
als er een onverwachte fout optreedt tijdens de uitvoering.
send_message
Hiermee wordt een bericht verzonden naar het eindpunt voor standaard gebeurtenissen op het Azure IoT Hub- of Azure IoT Edge Hub-exemplaar.
Dit is een synchrone gebeurtenis, wat betekent dat deze functie pas wordt geretourneerd als de gebeurtenis naar de service is verzonden en de service de ontvangst van de gebeurtenis heeft bevestigd.
Als de verbinding met de service nog niet eerder is geopend door een aanroep om verbinding te maken, opent deze functie de verbinding voordat de gebeurtenis wordt verzonden.
send_message(message)Parameters
- message
- Message
Het werkelijke bericht dat moet worden verzonden. Alles wat is doorgegeven dat geen exemplaar van de berichtklasse is, wordt geconverteerd naar het Bericht-object.
Uitzonderingen
als referenties ongeldig zijn en er geen verbinding tot stand kan worden gebracht.
als het tot stand brengen van een verbinding mislukt.
als de verbinding tijdens de uitvoering is verbroken.
als er een time-out optreedt voor de verbindingspoging
als de client niet is verbonden (en er geen automatische verbinding is ingeschakeld)
als er een onverwachte fout optreedt tijdens de uitvoering.
send_message_to_output
Hiermee wordt een gebeurtenis/bericht naar de opgegeven module-uitvoer verzonden.
Dit zijn uitgaande gebeurtenissen en zijn bedoeld als 'uitvoer gebeurtenissen'.
Dit is een synchrone gebeurtenis, wat betekent dat deze functie pas wordt geretourneerd als de gebeurtenis naar de service is verzonden en de service de ontvangst van de gebeurtenis heeft bevestigd.
Als de verbinding met de service nog niet eerder is geopend door een aanroep om verbinding te maken, opent deze functie de verbinding voordat de gebeurtenis wordt verzonden.
send_message_to_output(message, output_name)Parameters
- message
- Message
Bericht dat moet worden verzonden naar de opgegeven uitvoer. Alles wat is doorgegeven dat geen exemplaar van de berichtklasse is, wordt geconverteerd naar het Bericht-object.
Uitzonderingen
als referenties ongeldig zijn en er geen verbinding tot stand kan worden gebracht.
als het tot stand brengen van een verbinding mislukt.
als de verbinding tijdens de uitvoering is verbroken.
als er een time-out optreedt voor de verbindingspoging
als de client niet is verbonden (en er geen automatische verbinding is ingeschakeld)
als er een onverwachte fout optreedt tijdens de uitvoering.
send_method_response
Verzend een antwoord op een methodeaanvraag via de Azure IoT Hub of Azure IoT Edge Hub.
Dit is een synchrone gebeurtenis, wat betekent dat deze functie pas wordt geretourneerd als de gebeurtenis naar de service is verzonden en de service de ontvangst van de gebeurtenis heeft bevestigd.
Als de verbinding met de service nog niet eerder is geopend door een aanroep om verbinding te maken, opent deze functie de verbinding voordat de gebeurtenis wordt verzonden.
send_method_response(method_response)Parameters
Uitzonderingen
als referenties ongeldig zijn en er geen verbinding tot stand kan worden gebracht.
als het tot stand brengen van een verbinding mislukt.
als de verbinding tijdens de uitvoering is verbroken.
als er een time-out optreedt voor de verbindingspoging
als de client niet is verbonden (en er geen automatische verbinding is ingeschakeld)
als er een onverwachte fout optreedt tijdens de uitvoering.
shutdown
Sluit de client af voor een probleemloze afsluiting.
Zodra deze methode is aangeroepen, leiden pogingen tot verdere clientaanroepen ertoe dat een ClientError wordt gegenereerd
shutdown()Uitzonderingen
als er een onverwachte fout optreedt tijdens de uitvoering.
update_sastoken
Werk het SAS-token van de client bij dat wordt gebruikt voor verificatie en geeft vervolgens opnieuw verificatie aan voor de verbinding.
Deze API kan alleen worden gebruikt als de client in eerste instantie is gemaakt met een SAS-token.
update_sastoken(sastoken)Parameters
Uitzonderingen
als referenties ongeldig zijn en een verbinding niet opnieuw tot stand kan worden gebracht.
als het opnieuw tot stand brengen van de verbinding resulteert in een fout.
als de verbinding tijdens de uitvoering is verbroken.
als er een time-out optreedt voor de poging tot opnieuw verificatie.
als de client in eerste instantie niet is gemaakt met een SAS-token.
als er een onverwachte fout optreedt tijdens de uitvoering.
Kenmerken
connected
De eigenschap Alleen-lezen om aan te geven of het transport is verbonden of niet.
on_background_exception
De handler-functie of coroutine wordt aangeroepen wanneer er een achtergronduitzondering optreedt.
De definitie van de functie of coroutinus moet één positioneel argument hebben (het uitzonderingsobject)
on_connection_state_change
De handler-functie of coroutine die wordt aangeroepen wanneer de verbindingsstatus verandert.
De functie- of coroutinusdefinitie mag geen positionele argumenten hebben.
on_message_received
De handlerfunctie of coroutine die wordt aangeroepen wanneer een invoerbericht wordt ontvangen.
De functiedefinitie of coroutinus moet één positioneel argument hebben (het Message object)
on_method_request_received
De handlerfunctie of coroutine die wordt aangeroepen wanneer een methodeaanvraag wordt ontvangen.
Vergeet niet om de methodeaanvraag in uw functie of coroutine te bevestigen via de methode .send_method_response() van de client.
De functie- of coroutinusdefinitie moet één positioneel argument hebben (het MethodRequest object)
on_new_sastoken_required
De handler-functie of coroutine die wordt aangeroepen wanneer de client een nieuw SAS-token vereist. Dit gebeurt ongeveer 2 minuten voordat het SAS-token verloopt. Als de levensduur op Windows-platforms ongeveer 49 dagen overschrijdt, is na deze 49 dagen een nieuw token vereist, ongeacht hoe lang de SAS-levensduur is.
Houd er rekening mee dat deze handler ALLEEN nodig is wanneer u een client gebruikt die is gemaakt via de methode .create_from_sastoken().
Het nieuwe token kan worden opgegeven in uw functie of coroutine via de methode .update_sastoken() van de client.
De functie- of coroutinusdefinitie mag geen positionele argumenten hebben.
on_twin_desired_properties_patch_received
De handlerfunctie of coroutine die wordt aangeroepen wanneer een patch voor de gewenste eigenschappen van een dubbel wordt ontvangen.
De functie- of coroutinusdefinitie moet één positioneel argument hebben (de dubbele patch in de vorm van een JSON-woordenlijstobject)
Azure SDK for Python
Feedback
Binnenkort beschikbaar: In de loop van 2024 zullen we GitHub-problemen geleidelijk uitfaseren als het feedbackmechanisme voor inhoud en deze vervangen door een nieuw feedbacksysteem. Zie voor meer informatie: https://aka.ms/ContentUserFeedback.
Feedback verzenden en weergeven voor