DigitalTwinClient Clase

Una clase para proporcionar API útiles para las operaciones de DigitalTwin, en función de las API REST de IotHub generadas automáticamente.

Inicializador para digitalTwinClient.

Después de crear correctamente la clase se ha autenticado con IoTHub y está listo para llamar a las API miembro para comunicarse con IoTHub.

Herencia

builtins.object

DigitalTwinClient

Constructor

DigitalTwinClient(connection_string=None, host=None, auth=None)

Parámetros

Nombre	Description
connection_string	str La cadena de conexión de IoTHub que se usa para autenticar la conexión con IoTHub si se usa connection_str autenticación. Valor predeterminado: ninguno valor predeterminado: None
host	str La dirección URL del servicio de Azure si usamos la autenticación de credenciales de token. Valor predeterminado: ninguno valor predeterminado: None
auth	str El objeto de autenticación de Azure si usamos la autenticación de credenciales de token. Valor predeterminado: ninguno valor predeterminado: None

Métodos

from_connection_string	Inicializador classmethod para un cliente del servicio DigitalTwinClient. Crea la clase DigitalTwinClient a partir de la cadena de conexión. Después de crear correctamente la clase se ha autenticado con IoTHub y está listo para llamar a las API miembro para comunicarse con IoTHub.
from_token_credential	Inicializador classmethod para un cliente del servicio DigitalTwinClient. Crea la clase DigitalTwinClient a partir de la dirección URL del nombre de host y la credencial del token de Azure. Después de crear correctamente la clase se ha autenticado con IoTHub y está listo para llamar a las API miembro para comunicarse con IoTHub.
get_digital_twin	Recupere el gemelo digital de un dispositivo determinado. :p aram str digital_twin__id: el identificador de gemelo digital del dispositivo especificado.
invoke_command	Invoque un comando en un dispositivo determinado y obtenga el resultado de él. :p aram str digital_twin__id: el identificador de gemelo digital del dispositivo especificado. :p aram str command_name: nombre del comando. :p aram str payload: el argumento de un comando. :p aram int connect_timeout_in_seconds: intervalo máximo de tiempo, en segundos, que el comando del gemelo digital esperará a la respuesta. :p aram int response_timeout_in_seconds: intervalo máximo de tiempo, en segundos, que el comando del gemelo digital esperará a la respuesta. El valor debe estar comprendido entre 5 y 300.
invoke_component_command	Invoque un comando en un componente de un dispositivo determinado y obtenga el resultado de él. :p aram str digital_twin__id: el identificador de gemelo digital del dispositivo especificado. :p aram str component_path: nombre del componente. :p aram str command_name: nombre del comando. :p aram str payload: el argumento de un comando. :p aram int connect_timeout_in_seconds: intervalo máximo de tiempo, en segundos, que el comando del gemelo digital esperará a la respuesta. :p aram int response_timeout_in_seconds: intervalo máximo de tiempo, en segundos, que el comando del gemelo digital esperará a la respuesta. El valor debe estar comprendido entre 5 y 300. :type response_timeout_in_seconds: int
update_digital_twin	Actualice el componente de gemelo digital de un dispositivo determinado mediante un objeto de revisión. :p aram str digital_twin__id: el identificador de gemelo digital del dispositivo especificado. :p aram list[object]: objeto json-patch para actualizar el gemelo digital. :p aram str etag: valor de etag (if_match) que se va a usar para la operación de actualización.

from_connection_string

Inicializador classmethod para un cliente del servicio DigitalTwinClient. Crea la clase DigitalTwinClient a partir de la cadena de conexión.

Después de crear correctamente la clase se ha autenticado con IoTHub y está listo para llamar a las API miembro para comunicarse con IoTHub.

from_connection_string(connection_string)

Parámetros

Nombre	Description
connection_string Requerido	str Cadena de conexión de IoTHub que se usa para autenticar la conexión con IoTHub.

Devoluciones

Tipo	Description
DigitalTwinClient

from_token_credential

Inicializador classmethod para un cliente del servicio DigitalTwinClient. Crea la clase DigitalTwinClient a partir de la dirección URL del nombre de host y la credencial del token de Azure.

Después de crear correctamente la clase se ha autenticado con IoTHub y está listo para llamar a las API miembro para comunicarse con IoTHub.

from_token_credential(url, token_credential)

Parámetros

Nombre	Description
url Requerido	str La dirección URL del servicio de Azure (nombre de host).
token_credential Requerido	<xref:azure.core.TokenCredential> El objeto de credencial de token de Azure

Devoluciones

Tipo	Description
DigitalTwinClient

get_digital_twin

Recupere el gemelo digital de un dispositivo determinado. :p aram str digital_twin__id: el identificador de gemelo digital del dispositivo especificado.

get_digital_twin(digital_twin_id)

Parámetros

Nombre	Description
digital_twin_id Requerido

Devoluciones

Tipo	Description
	Objeto devuelto que contiene el gemelo digital.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

invoke_command

Invoque un comando en un dispositivo determinado y obtenga el resultado de él. :p aram str digital_twin__id: el identificador de gemelo digital del dispositivo especificado. :p aram str command_name: nombre del comando. :p aram str payload: el argumento de un comando. :p aram int connect_timeout_in_seconds: intervalo máximo de tiempo, en segundos, que el comando del gemelo digital esperará a la respuesta. :p aram int response_timeout_in_seconds: intervalo máximo de tiempo, en segundos, que el comando del gemelo digital esperará a la respuesta. El valor debe estar comprendido entre 5 y 300.

invoke_command(digital_twin_id, command_name, payload, connect_timeout_in_seconds=None, response_timeout_in_seconds=None)

Parámetros

Nombre	Description
digital_twin_id Requerido
command_name Requerido
payload Requerido
connect_timeout_in_seconds	valor predeterminado: None
response_timeout_in_seconds	valor predeterminado: None

Devoluciones

Tipo	Description
	Resultado del comando invocado.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

invoke_component_command

Invoque un comando en un componente de un dispositivo determinado y obtenga el resultado de él. :p aram str digital_twin__id: el identificador de gemelo digital del dispositivo especificado. :p aram str component_path: nombre del componente. :p aram str command_name: nombre del comando. :p aram str payload: el argumento de un comando. :p aram int connect_timeout_in_seconds: intervalo máximo de tiempo, en segundos, que el comando del gemelo digital esperará a la respuesta. :p aram int response_timeout_in_seconds: intervalo máximo de tiempo, en segundos, que el comando del gemelo digital esperará a la respuesta. El valor debe estar comprendido entre 5 y 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)

Parámetros

Nombre	Description
digital_twin_id Requerido
component_path Requerido
command_name Requerido
payload Requerido
connect_timeout_in_seconds	valor predeterminado: None
response_timeout_in_seconds	valor predeterminado: None

Devoluciones

Tipo	Description
	Resultado del comando invocado.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

update_digital_twin

Actualice el componente de gemelo digital de un dispositivo determinado mediante un objeto de revisión. :p aram str digital_twin__id: el identificador de gemelo digital del dispositivo especificado. :p aram list[object]: objeto json-patch para actualizar el gemelo digital. :p aram str etag: valor de etag (if_match) que se va a usar para la operación de actualización.

update_digital_twin(digital_twin_id, digital_twin_patch, etag=None)

Parámetros

Nombre	Description
digital_twin_id Requerido
digital_twin_patch Requerido
etag	valor predeterminado: None

Devoluciones

Tipo	Description
	Objeto devuelto que contiene el gemelo digital actualizado.

Excepciones

Tipo	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>