IoTHubDeviceClient Klas
Een synchrone apparaatclient die verbinding maakt met een Azure IoT Hub-exemplaar.
Initialisatie voor een IoTHubDeviceClient.
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.GenericIoTHubClientIoTHubDeviceClientazure.iot.device.iothub.abstract_clients.AbstractIoTHubDeviceClientIoTHubDeviceClient
Constructor
IoTHubDeviceClient(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
Methoden
| connect |
Hiermee wordt de client verbonden met een exemplaar van Azure IoT Hub of Azure IoT Edge Hub. De bestemming wordt gekozen op basis van de referenties die zijn doorgegeven via de parameter auth_provider 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_sastoken |
De client instantiëren vanuit een vooraf gemaakte SAS-tokentekenreeks |
| create_from_symmetric_key |
Instantieer een client met behulp van symmetrische sleutelverificatie. |
| 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 clientexemplaren. Dit is een synchrone aanroep, wat betekent dat deze functie pas wordt geretourneerd als de verbinding met de service volledig is gesloten. |
| get_storage_info_for_blob |
Verzendt een POST-aanvraag via HTTP naar een IoTHub-eindpunt dat informatie retourneert voor uploaden via het Azure Storage-account dat is gekoppeld aan de IoTHub waarmee uw apparaat is verbonden. |
| get_twin |
Hiermee haalt u 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 wordt geretourneerd als de dubbel is opgehaald uit de service. |
| notify_blob_upload_status |
Wanneer het uploaden is voltooid, verzendt het apparaat een POST-aanvraag naar het IoT Hub-eindpunt met informatie over de status van een upload naar blobpoging. Dit wordt door IoT Hub gebruikt om luisterende clients op de hoogte te stellen. |
| patch_twin_reported_properties |
Gerapporteerde eigenschappen bijwerken met de service Azure IoT Hub of Azure IoT Edge Hub. 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 op de patchbewerking retourneert, genereert deze functie de juiste fout. |
| receive_message |
Ontvang een bericht dat is verzonden vanaf de Azure IoT Hub. 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 in plaats daarvan de eigenschap .on_method_request_received te gebruiken om 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_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 exemplaar van Azure IoT Hub of Azure IoT Edge Hub.
De bestemming wordt gekozen op basis van de referenties die zijn doorgegeven via de parameter auth_provider 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 bij het maken van verbinding met een eindpunt met een niet-standaardvertrouwensbasis, zoals een protocolgateway.
- websockets
- bool
Configuratieoptie. De standaardwaarde is False. Stel in op true als U MQTT gebruikt via websockets.
Configuratieoptie. Coderingssuite(s) voor TLS/SSL, als een 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 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_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 bij het maken van verbinding met een eindpunt met een niet-standaardvertrouwensbasis, zoals een protocolgateway.
- gateway_hostname
- str
Configuratieoptie. De hostnaam van de gateway voor het gatewayapparaat.
- websockets
- bool
Configuratieoptie. De standaardwaarde is False. Stel in op true als U MQTT gebruikt via websockets.
Configuratieoptie. Coderingssuite(s) voor TLS/SSL, als een 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 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_symmetric_key
Instantieer een client met behulp van symmetrische sleutelverificatie.
create_from_symmetric_key(symmetric_key, hostname, device_id, **kwargs)Parameters
- symmetric_key
De symmetrische sleutel.
- hostname
- str
Host waarop de IotHub wordt uitgevoerd. Kunt u vinden in de Azure Portal op het tabblad Overzicht als de hostnaam van de tekenreeks.
- device_id
De apparaat-id
- server_verification_cert
- str
Configuratieoptie. De vertrouwde certificaatketen. Dit is nodig bij het maken van verbinding met een eindpunt met een niet-standaardvertrouwensbasis, zoals een protocolgateway.
- gateway_hostname
- str
Configuratieoptie. De hostnaam van de gateway voor het gatewayapparaat.
- websockets
- bool
Configuratieoptie. De standaardwaarde is False. Stel in op true als U MQTT gebruikt via websockets.
Configuratieoptie. Coderingssuite(s) voor TLS/SSL, als een 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 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 symmetrische sleutel voor verificatie.
Uitzonderingen
create_from_x509_certificate
Een client instantiëren met X509-certificaatverificatie.
create_from_x509_certificate(x509, hostname, device_id, **kwargs)Parameters
- hostname
- str
Host waarop de IotHub wordt uitgevoerd. Kunt u 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 worden gecodeerd met base64.
- server_verification_cert
- str
Configuratieoptie. De vertrouwde certificaatketen. Dit is nodig bij het maken van verbinding met een eindpunt met een niet-standaardvertrouwensbasis, zoals een protocolgateway.
- gateway_hostname
- str
Configuratieoptie. De hostnaam van de gateway voor het gatewayapparaat.
- websockets
- bool
Configuratieoptie. De standaardwaarde is False. Stel in op true als U MQTT gebruikt via websockets.
Configuratieoptie. Coderingssuite(s) voor TLS/SSL, als een 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 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 X509-certificaat 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 clientexemplaren.
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_storage_info_for_blob
Verzendt een POST-aanvraag via HTTP naar een IoTHub-eindpunt dat informatie retourneert voor uploaden via het Azure Storage-account dat is gekoppeld aan de IoTHub waarmee uw apparaat is verbonden.
get_storage_info_for_blob(blob_name)Parameters
- blob_name
- str
De naam in tekenreeksindeling van de blob die wordt geüpload met behulp van de opslag-API. Deze naam wordt gebruikt om de juiste referenties voor Storage te genereren en moet overeenkomen met wat wordt gebruikt met de Azure Storage SDK om de blob-upload uit te voeren.
Retouren
Een JSON-achtig (woordenlijst)-object van IoT Hub dat relevante informatie bevat, waaronder: correlationId, hostName, containerName, blobName, sasToken.
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.
get_twin
Hiermee haalt u 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 wordt geretourneerd als de dubbel is opgehaald uit de service.
get_twin()Retouren
Dubbel voltooien als een 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.
notify_blob_upload_status
Wanneer het uploaden is voltooid, verzendt het apparaat een POST-aanvraag naar het IoT Hub-eindpunt met informatie over de status van een upload naar blobpoging. Dit wordt door IoT Hub gebruikt om luisterende clients op de hoogte te stellen.
notify_blob_upload_status(correlation_id, is_success, status_code, status_description)Parameters
- status_code
- int
Een numerieke statuscode die de status is voor het uploaden van het bestand naar de opslag.
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
Gerapporteerde eigenschappen bijwerken met de service Azure IoT Hub of Azure IoT Edge Hub.
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 op de patchbewerking retourneert, genereert deze functie de juiste fout.
patch_twin_reported_properties(reported_properties_patch)Parameters
- reported_properties_patch
- dict
Patch voor gerapporteerde eigenschappen van dubbel als JSON-dict
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
Ontvang een bericht dat is verzonden vanaf de Azure IoT Hub.
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(block=True, timeout=None)Parameters
- block
- bool
Geeft aan of de bewerking moet worden geblokkeerd totdat een bericht is ontvangen.
- timeout
- int
Geef eventueel een aantal seconden op totdat er een time-out optreedt voor blokkering.
Retouren
Bericht dat is verzonden vanaf de Azure IoT Hub of Geen als er aan het einde van de blokkeringsperiode geen methodeaanvraag 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.
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 in plaats daarvan de eigenschap .on_method_request_received te gebruiken om 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 op 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 eventueel 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 eventueel een aantal seconden op totdat er een time-out optreedt voor blokkering.
Retouren
Patch Desired Properties 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_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
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 definitie van de functie of coroutinus mag geen positionele argumenten hebben.
on_message_received
De handler-functie of coroutine die wordt aangeroepen wanneer een bericht wordt ontvangen.
De definitie van de functie of coroutinus moet één positioneel argument (het Message object) nemen
on_method_request_received
De handler-functie 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 definitie van de functie of coroutinus moet één positioneel argument (het MethodRequest object) nemen
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 op Windows-platforms de levensduur ongeveer 49 dagen overschrijdt, is na die 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 definitie van de functie of coroutinus mag geen positionele argumenten hebben.
on_twin_desired_properties_patch_received
De handler-functie of coroutine die wordt aangeroepen wanneer een patch voor de gewenste eigenschappen van een dubbel wordt ontvangen.
De definitie van de functie of coroutinus moet één positioneel argument hebben (de dubbelpatch in de vorm van een JSON-woordenlijstobject)
Azure SDK for Python