Partager via


IoTHubModuleClient Classe

Client de module synchrone qui se connecte à un IoT Edge instance Azure IoT Hub ou Azure.

Initialiseur pour un IoTHubModuleClient.

Cet initialiseur ne doit pas être appelé directement. Au lieu de cela, utilisez l’une des méthode de la classe «>> create_from_<< » pour instancier

Héritage
azure.iot.device.iothub.sync_clients.GenericIoTHubClient
IoTHubModuleClient
azure.iot.device.iothub.abstract_clients.AbstractIoTHubModuleClient
IoTHubModuleClient

Constructeur

IoTHubModuleClient(mqtt_pipeline, http_pipeline)

Paramètres

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

Pipeline utilisé pour se connecter au point de terminaison IoTHub.

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

Pipeline utilisé pour se connecter au point de terminaison IoTHub via HTTP.

Méthodes

connect

Connecte le client à un instance Azure IoT Hub ou Azure IoT Edge Hub.

La destination est choisie en fonction des informations d’identification transmises via le paramètre auth_provider fourni lors de l’initialisation de cet objet.

Il s’agit d’un appel synchrone, ce qui signifie que cette fonction ne sera pas retournée tant que la connexion au service n’aura pas été complètement établie.

create_from_connection_string

Instanciez le client à partir d’un appareil IoTHub ou d’une chaîne de connexion de module.

create_from_edge_environment

Instanciez le client à partir de l’environnement IoT Edge.

Cette méthode ne peut être exécutée qu’à partir d’un conteneur IoT Edge ou dans un environnement de débogage configuré pour le développement Edge (par exemple, Visual Studio, Visual Studio Code)

create_from_sastoken

Instancier le client à partir d’une chaîne de jeton SAS créée au préalable

create_from_x509_certificate

Instancier un client à l’aide de l’authentification par certificat X509.

disconnect

Déconnectez le client du instance Azure IoT Hub ou Azure IoT Edge Hub.

Il est recommandé d’appeler cette fonction lorsque vous avez terminé avec le instance client.

Il s’agit d’un appel synchrone, ce qui signifie que cette fonction ne retourne pas tant que la connexion au service n’a pas été complètement fermée.

get_twin

Obtient le jumeau d’appareil ou de module à partir du service Azure IoT Hub ou Azure IoT Edge Hub.

Il s’agit d’un appel synchrone, ce qui signifie que cette fonction ne retourne pas tant que le jumeau n’a pas été récupéré à partir du service.

invoke_method

Appelez une méthode de votre client sur un client d’appareil ou de module et recevez la réponse à l’appel de méthode.

patch_twin_reported_properties

Mettez à jour les propriétés signalées avec le service Azure IoT Hub ou Azure IoT Edge Hub.

Il s’agit d’un appel synchrone, ce qui signifie que cette fonction ne retourne pas tant que le correctif n’a pas été envoyé au service et reconnu.

Si le service retourne une erreur sur l’opération de correctif, cette fonction génère l’erreur appropriée.

receive_message_on_input

Recevoir un message d’entrée qui a été envoyé à partir d’un autre module à une entrée spécifique.

Déconseillé depuis la version 2.3.0 : nous vous recommandons d’utiliser la propriété .on_message_received pour définir un gestionnaire à la place

receive_method_request

Recevez une demande de méthode via le Azure IoT Hub ou Azure IoT Edge Hub.

Déconseillé depuis la version 2.3.0 : nous vous recommandons d’utiliser la propriété .on_method_request_received pour définir un gestionnaire à la place

receive_twin_desired_properties_patch

Recevez un correctif de propriété souhaité via le Azure IoT Hub ou Azure IoT Edge Hub.

Il s’agit d’un appel synchrone, ce qui signifie ce qui suit :

  1. Si block=True, cette fonction se bloque jusqu’à ce que l’une des opérations suivantes se produise :

    • un correctif de propriété souhaité est reçu du Azure IoT Hub ou d’Azure IoT Edge Hub.

    • le délai d’expiration, s’il est fourni, s’écoule. Si un délai d’expiration se produit, cette fonction déclenche une exception InboxEmpty

  2. Si block=False, cette fonction retourne tous les correctifs de propriété souhaités qui ont peut-être été reçus par le pipeline, mais qui ne sont pas encore retournés à l’application. Si aucun correctif de propriété souhaité n’a été reçu par le pipeline, cette fonction déclenche une exception InboxEmpty

Déconseillé depuis la version 2.3.0 : nous vous recommandons d’utiliser la propriété .on_twin_desired_properties_patch_received pour définir un gestionnaire à la place

send_message

Envoie un message au point de terminaison d’événements par défaut sur le instance Azure IoT Hub ou Azure IoT Edge Hub.

Il s’agit d’un événement synchrone, ce qui signifie que cette fonction ne retourne pas tant que l’événement n’a pas été envoyé au service et que le service a accusé réception de l’événement.

Si la connexion au service n’a pas encore été ouverte par un appel à la connexion, cette fonction ouvre la connexion avant d’envoyer l’événement.

send_message_to_output

Envoie un événement/message à la sortie du module donné.

Il s’agit d’événements sortants qui sont censés être des « événements de sortie ».

Il s’agit d’un événement synchrone, ce qui signifie que cette fonction ne retourne pas tant que l’événement n’a pas été envoyé au service et que le service a accusé réception de l’événement.

Si la connexion au service n’a pas encore été ouverte par un appel à la connexion, cette fonction ouvre la connexion avant d’envoyer l’événement.

send_method_response

Envoyez une réponse à une demande de méthode via le Azure IoT Hub ou Azure IoT Edge Hub.

Il s’agit d’un événement synchrone, ce qui signifie que cette fonction ne retourne pas tant que l’événement n’a pas été envoyé au service et que le service a accusé réception de l’événement.

Si la connexion au service n’a pas encore été ouverte par un appel à la connexion, cette fonction ouvre la connexion avant d’envoyer l’événement.

shutdown

Arrêtez le client pour une sortie normale.

Une fois cette méthode appelée, toutes les tentatives d’appels clients supplémentaires entraînent le levée d’une erreur ClientError.

update_sastoken

Mettez à jour le jeton SAS du client utilisé pour l’authentification, puis réautorise la connexion.

Cette API ne peut être utilisée que si le client a été initialement créé avec un jeton SAS.

connect

Connecte le client à un instance Azure IoT Hub ou Azure IoT Edge Hub.

La destination est choisie en fonction des informations d’identification transmises via le paramètre auth_provider fourni lors de l’initialisation de cet objet.

Il s’agit d’un appel synchrone, ce qui signifie que cette fonction ne sera pas retournée tant que la connexion au service n’aura pas été complètement établie.

connect()

Exceptions

si les informations d’identification ne sont pas valides et qu’une connexion ne peut pas être établie.

si l’établissement d’une connexion entraîne un échec.

si la connexion est perdue pendant l’exécution.

si la connexion expire.

en cas d’échec inattendu pendant l’exécution.

create_from_connection_string

Instanciez le client à partir d’un appareil IoTHub ou d’une chaîne de connexion de module.

create_from_connection_string(connection_string, **kwargs)

Paramètres

connection_string
str
Obligatoire

Chaîne de connexion pour l’IoTHub auquel vous souhaitez vous connecter.

server_verification_cert
str
Obligatoire

Option de configuration. Chaîne de certificats approuvé. Nécessaire lors de l’utilisation de la connexion à un point de terminaison qui a une racine d’approbation non standard, telle qu’une passerelle de protocole.

websockets
bool
Obligatoire

Option de configuration. La valeur par défaut est FALSE. Définissez sur true si vous utilisez MQTT sur des websockets.

cipher
str ou list(str)
Obligatoire

Option de configuration. Suite(s) de chiffrement pour TLS/SSL, sous forme de chaîne au « format de liste de chiffrement OpenSSL » ou de liste de chaînes de suite de chiffrement.

product_info
str
Obligatoire

Option de configuration. La valeur par défaut est une chaîne vide. La chaîne contient des informations de produit arbitraires qui sont ajoutées à la chaîne de l’agent utilisateur.

proxy_options
ProxyOptions
Obligatoire

Options d’envoi de trafic via des serveurs proxy.

sastoken_ttl
int
Obligatoire

Durée de vie (en secondes) du SasToken créé utilisé pour l’authentification. La valeur par défaut est 3 600 secondes (1 heure).

keep_alive
int
Obligatoire

Période maximale en secondes entre les communications avec le répartiteur. Si aucun autre message n’est échangé, cela contrôle la vitesse à laquelle le client envoie des messages ping au répartiteur. S’il n’est pas fourni, la valeur par défaut de 60 secondes est utilisée.

auto_connect
bool
Obligatoire

Connectez automatiquement le client à IoTHub lorsqu’une méthode est appelée, ce qui nécessite l’établissement d’une connexion. (Valeur par défaut : True)

connection_retry
bool
Obligatoire

Tentative de rétablir une connexion supprimée (valeur par défaut : True)

connection_retry_interval
int
Obligatoire

Intervalle, en secondes, entre les tentatives de rétablir une connexion supprimée (valeur par défaut : 10)

ensure_desired_properties
bool
Obligatoire

Vérifiez que le correctif de propriétés souhaité le plus récent a été reçu lors des nouvelles connexions (Valeur par défaut :True)

Retours

Instance d’un client IoTHub qui utilise une chaîne de connexion pour l’authentification.

Exceptions

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

create_from_edge_environment

Instanciez le client à partir de l’environnement IoT Edge.

Cette méthode ne peut être exécutée qu’à partir d’un conteneur IoT Edge ou dans un environnement de débogage configuré pour le développement Edge (par exemple, Visual Studio, Visual Studio Code)

create_from_edge_environment(**kwargs)

Paramètres

websockets
bool
Obligatoire

Option de configuration. La valeur par défaut est FALSE. Définissez sur true si vous utilisez MQTT sur des websockets.

cipher
str ou list(str)
Obligatoire

Option de configuration. Suite(s) de chiffrement pour TLS/SSL, sous forme de chaîne au « format de liste de chiffrement OpenSSL » ou de liste de chaînes de suite de chiffrement.

product_info
str
Obligatoire

Option de configuration. La valeur par défaut est une chaîne vide. La chaîne contient des informations de produit arbitraires qui sont ajoutées à la chaîne de l’agent utilisateur.

proxy_options
ProxyOptions
Obligatoire

Options d’envoi de trafic via des serveurs proxy.

sastoken_ttl
int
Obligatoire

Durée de vie (en secondes) du SasToken créé utilisé pour l’authentification. La valeur par défaut est de 3600 secondes (1 heure)

keep_alive
int
Obligatoire

Période maximale en secondes entre les communications avec le répartiteur. Si aucun autre message n’est échangé, cela contrôle la vitesse à laquelle le client envoie des messages ping au répartiteur. S’il n’est pas fourni, la valeur par défaut de 60 secondes est utilisée.

auto_connect
bool
Obligatoire

Connectez automatiquement le client à IoTHub lorsqu’une méthode est appelée, ce qui nécessite l’établissement d’une connexion. (Valeur par défaut : True)

connection_retry
bool
Obligatoire

Tentative de rétablir une connexion supprimée (valeur par défaut : True)

connection_retry_interval
int
Obligatoire

Intervalle, en secondes, entre les tentatives de rétablir une connexion supprimée (valeur par défaut : 10)

Retours

Instance d’un client IoTHub qui utilise l’environnement IoT Edge pour l’authentification.

Exceptions

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

Instancier le client à partir d’une chaîne de jeton SAS créée au préalable

create_from_sastoken(sastoken, **kwargs)

Paramètres

sastoken
str
Obligatoire

Chaîne de jeton SAS

server_verification_cert
str
Obligatoire

Option de configuration. Chaîne de certificats approuvé. Nécessaire lors de l’utilisation de la connexion à un point de terminaison qui a une racine d’approbation non standard, telle qu’une passerelle de protocole.

gateway_hostname
str
Obligatoire

Option de configuration. Nom d’hôte de la passerelle pour l’appareil de passerelle.

websockets
bool
Obligatoire

Option de configuration. La valeur par défaut est FALSE. Définissez sur true si vous utilisez MQTT sur des websockets.

cipher
str ou list(str)
Obligatoire

Option de configuration. Suite de chiffrement pour TLS/SSL, sous forme de chaîne au « format de liste de chiffrement OpenSSL » ou de liste de chaînes de suite de chiffrement.

product_info
str
Obligatoire

Option de configuration. La valeur par défaut est une chaîne vide. La chaîne contient des informations de produit arbitraires qui sont ajoutées à la chaîne de l’agent utilisateur.

proxy_options
ProxyOptions
Obligatoire

Options d’envoi du trafic via des serveurs proxy.

keep_alive
int
Obligatoire

Période maximale en secondes entre les communications avec le répartiteur. Si aucun autre message n’est échangé, cela contrôle la vitesse à laquelle le client envoie des messages ping au répartiteur. S’il n’est pas fourni, la valeur par défaut de 60 secondes est utilisée.

auto_connect
bool
Obligatoire

Connectez automatiquement le client à IoTHub lorsqu’une méthode est appelée, ce qui nécessite l’établissement d’une connexion. (Valeur par défaut : True)

connection_retry
bool
Obligatoire

Tentative de rétablir une connexion supprimée (valeur par défaut : True)

connection_retry_interval
int
Obligatoire

Intervalle, en secondes, entre les tentatives de rétablir une connexion supprimée (valeur par défaut : 10)

ensure_desired_properties
bool
Obligatoire

Vérifiez que le correctif des propriétés souhaitées le plus récent a été reçu lors des nouvelles connexions (Par défaut : True)

Exceptions

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

create_from_x509_certificate

Instancier un client à l’aide de l’authentification par certificat X509.

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

Paramètres

hostname
str
Obligatoire

Hôte exécutant IotHub. Vous trouverez le Portail Azure sous l’onglet Vue d’ensemble en tant que nom d’hôte de chaîne.

x509
X509
Obligatoire

Objet de certificat x509 complet. Pour utiliser le certificat, l’objet d’inscription doit contenir un certificat (le certificat racine ou l’un des certificats d’autorité de certification intermédiaires). Si le certificat provient d’un fichier CER, il doit être encodé en base64.

device_id
str
Obligatoire

ID utilisé pour identifier de manière unique un appareil dans l’IoTHub

module_id
str
Obligatoire

ID utilisé pour identifier de manière unique un module sur un appareil sur l’IoTHub.

server_verification_cert
str
Obligatoire

Option de configuration. Chaîne de certificats approuvée. Nécessaire lors de l’utilisation de la connexion à un point de terminaison qui a une racine d’approbation non standard, telle qu’une passerelle de protocole.

gateway_hostname
str
Obligatoire

Option de configuration. Nom d’hôte de la passerelle pour l’appareil de passerelle.

websockets
bool
Obligatoire

Option de configuration. La valeur par défaut est FALSE. Définissez sur true si vous utilisez MQTT sur des websockets.

cipher
str ou list(str)
Obligatoire

Option de configuration. Suite de chiffrement pour TLS/SSL, sous forme de chaîne au « format de liste de chiffrement OpenSSL » ou de liste de chaînes de suite de chiffrement.

product_info
str
Obligatoire

Option de configuration. La valeur par défaut est une chaîne vide. La chaîne contient des informations de produit arbitraires qui sont ajoutées à la chaîne de l’agent utilisateur.

proxy_options
ProxyOptions
Obligatoire

Options d’envoi du trafic via des serveurs proxy.

keep_alive
int
Obligatoire

Période maximale en secondes entre les communications avec le répartiteur. Si aucun autre message n’est échangé, cela contrôle la vitesse à laquelle le client envoie des messages ping au répartiteur. S’il n’est pas fourni, la valeur par défaut de 60 secondes est utilisée.

auto_connect
bool
Obligatoire

Connectez automatiquement le client à IoTHub lorsqu’une méthode est appelée, ce qui nécessite l’établissement d’une connexion. (Valeur par défaut : True)

connection_retry
bool
Obligatoire

Tentative de rétablir une connexion supprimée (valeur par défaut : True)

connection_retry_interval
int
Obligatoire

Intervalle, en secondes, entre les tentatives de rétablir une connexion supprimée (valeur par défaut : 10)

ensure_desired_properties
bool
Obligatoire

Vérifiez que le correctif des propriétés souhaitées le plus récent a été reçu lors des nouvelles connexions (Par défaut : True)

Retours

Une instance d’un client IoTHub qui utilise un certificat X509 pour l’authentification.

Exceptions

TypeError if given an unsupported parameter.

disconnect

Déconnectez le client du instance Azure IoT Hub ou Azure IoT Edge Hub.

Il est recommandé d’appeler cette fonction lorsque vous avez terminé avec le instance client.

Il s’agit d’un appel synchrone, ce qui signifie que cette fonction ne retourne pas tant que la connexion au service n’a pas été complètement fermée.

disconnect()

Exceptions

en cas de défaillance inattendue lors de l’exécution.

get_twin

Obtient le jumeau d’appareil ou de module à partir du service Azure IoT Hub ou Azure IoT Edge Hub.

Il s’agit d’un appel synchrone, ce qui signifie que cette fonction ne retourne pas tant que le jumeau n’a pas été récupéré à partir du service.

get_twin()

Retours

Terminer le jumeau en tant que dictée JSON

Type de retour

Exceptions

si les informations d’identification ne sont pas valides et qu’une connexion ne peut pas être établie.

si l’établissement d’une connexion entraîne un échec.

si la connexion est perdue pendant l’exécution.

si la tentative de connexion expire

si le client n’est pas connecté (et qu’aucune connexion automatique n’est activée)

en cas de défaillance inattendue lors de l’exécution.

invoke_method

Appelez une méthode de votre client sur un client d’appareil ou de module et recevez la réponse à l’appel de méthode.

invoke_method(method_params, device_id, module_id=None)

Paramètres

method_params
dict
Obligatoire

Doit contenir un methodName (str), une charge utile (str), connectTimeoutInSeconds (int), responseTimeoutInSeconds (int).

device_id
str
Obligatoire

ID d’appareil de l’appareil cible où la méthode sera appelée.

module_id
str
valeur par défaut: None

ID de module du module cible dans lequel la méthode sera appelée. (facultatif)

Retours

method_result doit contenir un status et une charge utile

Type de retour

Exceptions

si les informations d’identification ne sont pas valides et qu’une connexion ne peut pas être établie.

si l’établissement d’une connexion entraîne un échec.

si la connexion est perdue pendant l’exécution.

si la connexion expire.

en cas d’échec inattendu pendant l’exécution.

patch_twin_reported_properties

Mettez à jour les propriétés signalées avec le service Azure IoT Hub ou Azure IoT Edge Hub.

Il s’agit d’un appel synchrone, ce qui signifie que cette fonction ne retourne pas tant que le correctif n’a pas été envoyé au service et reconnu.

Si le service retourne une erreur sur l’opération de correctif, cette fonction génère l’erreur appropriée.

patch_twin_reported_properties(reported_properties_patch)

Paramètres

reported_properties_patch
dict
Obligatoire

Correctif des propriétés signalées de jumeau sous forme de dictée JSON

Exceptions

si les informations d’identification ne sont pas valides et qu’une connexion ne peut pas être établie.

si l’établissement d’une connexion entraîne un échec.

si la connexion est perdue pendant l’exécution.

si la tentative de connexion expire

si le client n’est pas connecté (et qu’aucune connexion automatique n’est activée)

en cas de défaillance inattendue lors de l’exécution.

receive_message_on_input

Recevoir un message d’entrée qui a été envoyé à partir d’un autre module à une entrée spécifique.

Déconseillé depuis la version 2.3.0 : nous vous recommandons d’utiliser la propriété .on_message_received pour définir un gestionnaire à la place

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

Paramètres

input_name
str
Obligatoire

Nom d’entrée sur lequel recevoir un message.

block
bool
Obligatoire

Indique si l’opération doit se bloquer jusqu’à ce qu’un message soit reçu.

timeout
int
Obligatoire

Indiquez éventuellement un nombre de secondes jusqu’à ce que le blocage expire.

Retours

Message envoyé à l’entrée spécifiée, ou Aucun si aucune demande de méthode n’a été reçue à la fin de la période de blocage.

Exceptions

si les informations d’identification ne sont pas valides et qu’une connexion ne peut pas être établie.

si l’établissement d’une connexion entraîne un échec.

si la connexion est perdue pendant l’exécution.

si la connexion expire.

en cas d’échec inattendu pendant l’exécution.

receive_method_request

Recevez une demande de méthode via le Azure IoT Hub ou Azure IoT Edge Hub.

Déconseillé depuis la version 2.3.0 : nous vous recommandons d’utiliser la propriété .on_method_request_received pour définir un gestionnaire à la place

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

Paramètres

method_name
str
valeur par défaut: None

Indiquez éventuellement le nom de la méthode pour laquelle recevoir des demandes. Si ce paramètre n’est pas fourni, toutes les méthodes qui ne sont pas encore spécifiquement ciblées par une autre demande de receive_method sont reçues.

block
bool
valeur par défaut: True

Indique si l’opération doit se bloquer jusqu’à ce qu’une demande soit reçue.

timeout
int
valeur par défaut: None

Indiquez éventuellement un nombre de secondes jusqu’à ce que le blocage expire.

Retours

Objet MethodRequest représentant la demande de méthode reçue, ou Aucun si aucune demande de méthode n’a été reçue à la fin de la période de blocage.

Exceptions

si les informations d’identification ne sont pas valides et qu’une connexion ne peut pas être établie.

si l’établissement d’une connexion entraîne un échec.

si la connexion est perdue pendant l’exécution.

si la connexion expire.

en cas d’échec inattendu pendant l’exécution.

receive_twin_desired_properties_patch

Recevez un correctif de propriété souhaité via le Azure IoT Hub ou Azure IoT Edge Hub.

Il s’agit d’un appel synchrone, ce qui signifie ce qui suit :

  1. Si block=True, cette fonction se bloque jusqu’à ce que l’une des opérations suivantes se produise :

    • un correctif de propriété souhaité est reçu du Azure IoT Hub ou d’Azure IoT Edge Hub.

    • le délai d’expiration, s’il est fourni, s’écoule. Si un délai d’expiration se produit, cette fonction déclenche une exception InboxEmpty

  2. Si block=False, cette fonction retourne tous les correctifs de propriété souhaités qui ont peut-être été reçus par le pipeline, mais qui ne sont pas encore retournés à l’application. Si aucun correctif de propriété souhaité n’a été reçu par le pipeline, cette fonction déclenche une exception InboxEmpty

Déconseillé depuis la version 2.3.0 : nous vous recommandons d’utiliser la propriété .on_twin_desired_properties_patch_received pour définir un gestionnaire à la place

receive_twin_desired_properties_patch(block=True, timeout=None)

Paramètres

block
bool
valeur par défaut: True

Indique si l’opération doit se bloquer jusqu’à ce qu’une demande soit reçue.

timeout
int
valeur par défaut: None

Indiquez éventuellement un nombre de secondes jusqu’à ce que le blocage expire.

Retours

Correctif des propriétés souhaitées du jumeau sous forme de dictée JSON, ou Aucun si aucun correctif n’a été reçu à la fin de la période de blocage

Type de retour

dict,

Exceptions

si les informations d’identification ne sont pas valides et qu’une connexion ne peut pas être établie.

si l’établissement d’une connexion entraîne un échec.

si la connexion est perdue pendant l’exécution.

si la connexion expire.

en cas d’échec inattendu pendant l’exécution.

send_message

Envoie un message au point de terminaison d’événements par défaut sur le instance Azure IoT Hub ou Azure IoT Edge Hub.

Il s’agit d’un événement synchrone, ce qui signifie que cette fonction ne retourne pas tant que l’événement n’a pas été envoyé au service et que le service a accusé réception de l’événement.

Si la connexion au service n’a pas encore été ouverte par un appel à la connexion, cette fonction ouvre la connexion avant d’envoyer l’événement.

send_message(message)

Paramètres

message
Message
Obligatoire

Message réel à envoyer. Tout ce qui est passé qui n’est pas une instance de la classe Message est converti en objet Message.

Exceptions

si les informations d’identification ne sont pas valides et qu’une connexion ne peut pas être établie.

si l’établissement d’une connexion entraîne un échec.

si la connexion est perdue pendant l’exécution.

si la tentative de connexion expire

si le client n’est pas connecté (et qu’aucune connexion automatique n’est activée)

en cas de défaillance inattendue lors de l’exécution.

ValueError if the message fails size validation.

send_message_to_output

Envoie un événement/message à la sortie du module donné.

Il s’agit d’événements sortants qui sont censés être des « événements de sortie ».

Il s’agit d’un événement synchrone, ce qui signifie que cette fonction ne retourne pas tant que l’événement n’a pas été envoyé au service et que le service a accusé réception de l’événement.

Si la connexion au service n’a pas encore été ouverte par un appel à la connexion, cette fonction ouvre la connexion avant d’envoyer l’événement.

send_message_to_output(message, output_name)

Paramètres

message
Message
Obligatoire

Message à envoyer à la sortie donnée. Tout ce qui est passé qui n’est pas une instance de la classe Message est converti en objet Message.

output_name
str
Obligatoire

Nom de la sortie à laquelle envoyer l’événement.

Exceptions

si les informations d’identification ne sont pas valides et qu’une connexion ne peut pas être établie.

si l’établissement d’une connexion entraîne un échec.

si la connexion est perdue pendant l’exécution.

si la tentative de connexion expire

si le client n’est pas connecté (et qu’aucune connexion automatique n’est activée)

en cas de défaillance inattendue lors de l’exécution.

ValueError if the message fails size validation.

send_method_response

Envoyez une réponse à une demande de méthode via le Azure IoT Hub ou Azure IoT Edge Hub.

Il s’agit d’un événement synchrone, ce qui signifie que cette fonction ne retourne pas tant que l’événement n’a pas été envoyé au service et que le service a accusé réception de l’événement.

Si la connexion au service n’a pas encore été ouverte par un appel à la connexion, cette fonction ouvre la connexion avant d’envoyer l’événement.

send_method_response(method_response)

Paramètres

method_response
MethodResponse
Obligatoire

MethodResponse à envoyer.

Exceptions

si les informations d’identification ne sont pas valides et qu’une connexion ne peut pas être établie.

si l’établissement d’une connexion entraîne un échec.

si la connexion est perdue pendant l’exécution.

si la tentative de connexion expire

si le client n’est pas connecté (et qu’aucune connexion automatique n’est activée)

en cas de défaillance inattendue lors de l’exécution.

shutdown

Arrêtez le client pour une sortie normale.

Une fois cette méthode appelée, toutes les tentatives d’appels clients supplémentaires entraînent le levée d’une erreur ClientError.

shutdown()

Exceptions

en cas de défaillance inattendue lors de l’exécution.

update_sastoken

Mettez à jour le jeton SAS du client utilisé pour l’authentification, puis réautorise la connexion.

Cette API ne peut être utilisée que si le client a été initialement créé avec un jeton SAS.

update_sastoken(sastoken)

Paramètres

sastoken
str
Obligatoire

Nouvelle chaîne de jeton SAS pour le client à utiliser

Exceptions

ValueError if the sastoken parameter is invalid

si les informations d’identification ne sont pas valides et qu’une connexion ne peut pas être rétablie.

si un rétablissement de la connexion entraîne un échec.

si la connexion est perdue pendant l’exécution.

si la tentative de réautorisation expire.

si le client n’a pas été créé initialement avec un jeton SAS.

en cas de défaillance inattendue lors de l’exécution.

Attributs

connected

Propriété en lecture seule pour indiquer si le transport est connecté ou non.

on_background_exception

La fonction de gestionnaire ou coroutine est appelée lorsqu’une exception en arrière-plan se produit.

La fonction ou la définition de coroutine doit prendre un argument positionnel (l’objet exception)

on_connection_state_change

Fonction de gestionnaire ou coroutine qui sera appelée lorsque l’état de connexion change.

La fonction ou la définition de coroutine ne doit prendre aucun argument positionnel.

on_message_received

Fonction de gestionnaire ou coroutine qui sera appelée lors de la réception d’un message d’entrée.

La définition de fonction ou coroutine doit prendre un argument positionnel (l’objet Message )

on_method_request_received

Fonction de gestionnaire ou coroutine qui sera appelée lors de la réception d’une demande de méthode.

N’oubliez pas d’accepter la demande de méthode dans votre fonction ou coroutine via l’utilisation de la méthode .send_method_response() du client.

La fonction ou la définition de coroutine doit prendre un argument positionnel (l’objet MethodRequest )

on_new_sastoken_required

Fonction de gestionnaire ou coroutine qui sera appelée lorsque le client a besoin d’un nouveau jeton SAP. Cela se produit environ 2 minutes avant l’expiration du jeton SAP. Sur les plateformes Windows, si la durée de vie dépasse environ 49 jours, un nouveau jeton est requis après ces 49 jours, quelle que soit la durée de vie de la SAP.

Notez que ce gestionnaire est uniquement nécessaire lors de l’utilisation d’un client créé via la méthode .create_from_sastoken().

Le nouveau jeton peut être fourni dans votre fonction ou coroutine via l’utilisation de la méthode .update_sastoken() du client.

La fonction ou la définition de coroutine ne doit prendre aucun argument positionnel.

on_twin_desired_properties_patch_received

Fonction de gestionnaire ou coroutine qui sera appelée lorsqu’un correctif des propriétés souhaitées de jumeau est reçu.

La fonction ou la définition de coroutine doit prendre un argument positionnel (le correctif de jumeau sous la forme d’un objet de dictionnaire JSON)