DigitalTwinClient Classe
Classe pour fournir des API pratiques pour les opérations DigitalTwin, basées sur les API REST IotHub générées automatiquement
Initialiseur pour un DigitalTwinClient.
Après une création réussie, la classe a été authentifiée avec IoTHub et elle est prête à appeler les API membres pour communiquer avec IoTHub.
- Héritage
-
builtins.objectDigitalTwinClient
Constructeur
DigitalTwinClient(connection_string=None, host=None, auth=None)
Paramètres
Nom | Description |
---|---|
connection_string
|
Chaîne de connexion IoTHub utilisée pour authentifier la connexion avec IoTHub si nous utilisons l’authentification connection_str. Valeur par défaut : Aucun valeur par défaut: None
|
host
|
URL du service Azure si nous utilisons l’authentification par jeton. Valeur par défaut : Aucun valeur par défaut: None
|
auth
|
Objet d’authentification Azure si nous utilisons l’authentification par jeton. Valeur par défaut : Aucun valeur par défaut: None
|
Méthodes
from_connection_string |
Initialiseur de classemethod pour un client de service DigitalTwinClient. Crée la classe DigitalTwinClient à partir de la chaîne de connexion. Après une création réussie, la classe a été authentifiée avec IoTHub et elle est prête à appeler les API membres pour communiquer avec IoTHub. |
from_token_credential |
Initialiseur de classemethod pour un client de service DigitalTwinClient. Crée la classe DigitalTwinClient à partir de l’URL du nom d’hôte et des informations d’identification de jeton Azure. Après une création réussie, la classe a été authentifiée avec IoTHub et elle est prête à appeler les API membres pour communiquer avec IoTHub. |
get_digital_twin |
Récupérez le jumeau numérique d’un appareil donné. :p aram str digital_twin__id : ID de jumeau numérique de l’appareil donné. |
invoke_command |
Appelez une commande sur un appareil particulier et obtenez le résultat de celle-ci. :p aram str digital_twin__id : ID de jumeau numérique de l’appareil donné. :p aram str command_name : nom de la commande. :p aram str payload : argument d’une commande. :p aram int connect_timeout_in_seconds : intervalle maximal de temps, en secondes, pendant lequel la commande du jumeau numérique attend la réponse. :p aram int response_timeout_in_seconds : intervalle de temps maximal, en secondes, pendant lequel la commande du jumeau numérique attend la réponse. La valeur doit être comprise entre 5 et 300. |
invoke_component_command |
Appelez une commande sur un composant d’un appareil particulier et obtenez le résultat de celle-ci. :p aram str digital_twin__id : ID de jumeau numérique de l’appareil donné. :p aram str component_path : nom du composant. :p aram str command_name : nom de la commande. :p aram str payload : argument d’une commande. :p aram int connect_timeout_in_seconds : intervalle maximal de temps, en secondes, pendant lequel la commande du jumeau numérique attend la réponse. :p aram int response_timeout_in_seconds : intervalle de temps maximal, en secondes, pendant lequel la commande du jumeau numérique attend la réponse. La valeur doit être comprise entre 5 et 300. :type response_timeout_in_seconds: int |
update_digital_twin |
Mettez à jour le composant jumeau numérique d’un appareil donné à l’aide d’un objet patch. :p aram str digital_twin__id : ID de jumeau numérique de l’appareil donné. :p aram list[object] : objet json-patch pour mettre à jour le jumeau numérique. :p aram str etag : valeur etag (if_match) à utiliser pour l’opération de mise à jour. |
from_connection_string
Initialiseur de classemethod pour un client de service DigitalTwinClient. Crée la classe DigitalTwinClient à partir de la chaîne de connexion.
Après une création réussie, la classe a été authentifiée avec IoTHub et elle est prête à appeler les API membres pour communiquer avec IoTHub.
from_connection_string(connection_string)
Paramètres
Nom | Description |
---|---|
connection_string
Obligatoire
|
Chaîne de connexion IoTHub utilisée pour authentifier la connexion avec IoTHub. |
Retours
Type | Description |
---|---|
from_token_credential
Initialiseur de classemethod pour un client de service DigitalTwinClient. Crée la classe DigitalTwinClient à partir de l’URL du nom d’hôte et des informations d’identification de jeton Azure.
Après une création réussie, la classe a été authentifiée avec IoTHub et elle est prête à appeler les API membres pour communiquer avec IoTHub.
from_token_credential(url, token_credential)
Paramètres
Nom | Description |
---|---|
url
Obligatoire
|
URL du service Azure (nom d’hôte). |
token_credential
Obligatoire
|
<xref:azure.core.TokenCredential>
Objet d’informations d’identification de jeton Azure |
Retours
Type | Description |
---|---|
get_digital_twin
Récupérez le jumeau numérique d’un appareil donné. :p aram str digital_twin__id : ID de jumeau numérique de l’appareil donné.
get_digital_twin(digital_twin_id)
Paramètres
Nom | Description |
---|---|
digital_twin_id
Obligatoire
|
|
Retours
Type | Description |
---|---|
Objet de retour contenant le jumeau numérique. |
Exceptions
Type | Description |
---|---|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
invoke_command
Appelez une commande sur un appareil particulier et obtenez le résultat de celle-ci. :p aram str digital_twin__id : ID de jumeau numérique de l’appareil donné. :p aram str command_name : nom de la commande. :p aram str payload : argument d’une commande. :p aram int connect_timeout_in_seconds : intervalle maximal de temps, en secondes, pendant lequel la commande du jumeau numérique attend la réponse. :p aram int response_timeout_in_seconds : intervalle de temps maximal, en secondes, pendant lequel la commande du jumeau numérique attend la réponse. La valeur doit être comprise entre 5 et 300.
invoke_command(digital_twin_id, command_name, payload, connect_timeout_in_seconds=None, response_timeout_in_seconds=None)
Paramètres
Nom | Description |
---|---|
digital_twin_id
Obligatoire
|
|
command_name
Obligatoire
|
|
payload
Obligatoire
|
|
connect_timeout_in_seconds
|
valeur par défaut: None
|
response_timeout_in_seconds
|
valeur par défaut: None
|
Retours
Type | Description |
---|---|
Résultat de la commande appelée. |
Exceptions
Type | Description |
---|---|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
invoke_component_command
Appelez une commande sur un composant d’un appareil particulier et obtenez le résultat de celle-ci. :p aram str digital_twin__id : ID de jumeau numérique de l’appareil donné. :p aram str component_path : nom du composant. :p aram str command_name : nom de la commande. :p aram str payload : argument d’une commande. :p aram int connect_timeout_in_seconds : intervalle maximal de temps, en secondes, pendant lequel la commande du jumeau numérique attend la réponse. :p aram int response_timeout_in_seconds : intervalle de temps maximal, en secondes, pendant lequel la commande du jumeau numérique attend la réponse. La valeur doit être comprise entre 5 et 300. :type response_timeout_in_seconds: int
invoke_component_command(digital_twin_id, component_path, command_name, payload, connect_timeout_in_seconds=None, response_timeout_in_seconds=None)
Paramètres
Nom | Description |
---|---|
digital_twin_id
Obligatoire
|
|
component_path
Obligatoire
|
|
command_name
Obligatoire
|
|
payload
Obligatoire
|
|
connect_timeout_in_seconds
|
valeur par défaut: None
|
response_timeout_in_seconds
|
valeur par défaut: None
|
Retours
Type | Description |
---|---|
Résultat de la commande appelée. |
Exceptions
Type | Description |
---|---|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_digital_twin
Mettez à jour le composant jumeau numérique d’un appareil donné à l’aide d’un objet patch. :p aram str digital_twin__id : ID de jumeau numérique de l’appareil donné. :p aram list[object] : objet json-patch pour mettre à jour le jumeau numérique. :p aram str etag : valeur etag (if_match) à utiliser pour l’opération de mise à jour.
update_digital_twin(digital_twin_id, digital_twin_patch, etag=None)
Paramètres
Nom | Description |
---|---|
digital_twin_id
Obligatoire
|
|
digital_twin_patch
Obligatoire
|
|
etag
|
valeur par défaut: None
|
Retours
Type | Description |
---|---|
Objet de retour contenant le jumeau numérique mis à jour. |
Exceptions
Type | Description |
---|---|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
Azure SDK for Python
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour