DigitalTwinClient Classe

Classe per fornire API utili per le operazioni DigitalTwin, in base alle API REST IotHub generate automaticamente

Inizializzatore per DigitalTwinClient.

Dopo aver creato correttamente la classe è stata autenticata con IoTHub ed è pronta per chiamare le API membro per comunicare con IoTHub.

Ereditarietà

builtins.object

DigitalTwinClient

Costruttore

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

Parametri

Nome	Descrizione
connection_string	str Stringa di connessione IoTHub usata per autenticare la connessione con IoTHub se si usa connection_str'autenticazione. Valore predefinito: Nessuno valore predefinito: None
host	str URL del servizio di Azure se si usa l'autenticazione delle credenziali dei token. Valore predefinito: Nessuno valore predefinito: None
auth	str Oggetto di autenticazione di Azure se si usa l'autenticazione delle credenziali dei token. Valore predefinito: Nessuno valore predefinito: None

Metodi

from_connection_string	Inizializzatore classmethod per un client del servizio DigitalTwinClient. Crea la classe DigitalTwinClient dalla stringa di connessione. Dopo aver creato correttamente la classe è stata autenticata con IoTHub ed è pronta per chiamare le API membro per comunicare con IoTHub.
from_token_credential	Inizializzatore classmethod per un client del servizio DigitalTwinClient. Crea la classe DigitalTwinClient dall'URL del nome host e dalle credenziali del token di Azure. Dopo aver creato correttamente la classe è stata autenticata con IoTHub ed è pronta per chiamare le API membro per comunicare con IoTHub.
get_digital_twin	Recuperare il gemello digitale di un determinato dispositivo. :p aram str digital_twin__id: ID del gemello digitale del dispositivo specificato.
invoke_command	Richiamare un comando in un dispositivo specifico e ottenere il risultato. :p aram str digital_twin__id: ID del gemello digitale del dispositivo specificato. :p aram str command_name: nome del comando. :p aram str payload: argomento di un comando. :p aram int connect_timeout_in_seconds: intervallo massimo di tempo, in secondi, in cui il comando del gemello digitale attenderà la risposta. :p aram int response_timeout_in_seconds: intervallo massimo di tempo, in secondi, in cui il comando del gemello digitale attenderà la risposta. Il valore deve essere compreso tra 5 e 300.
invoke_component_command	Richiamare un comando su un componente di un determinato dispositivo e ottenere il risultato. :p aram str digital_twin__id: ID del gemello digitale del dispositivo specificato. :p aram str component_path: nome del componente. :p aram str command_name: nome del comando. :p aram str payload: argomento di un comando. :p aram int connect_timeout_in_seconds: intervallo massimo di tempo, in secondi, in cui il comando del gemello digitale attenderà la risposta. :p aram int response_timeout_in_seconds: intervallo massimo di tempo, in secondi, in cui il comando del gemello digitale attenderà la risposta. Il valore deve essere compreso tra 5 e 300. :type response_timeout_in_seconds: int
update_digital_twin	Aggiornare il componente gemello digitale di un determinato dispositivo usando un oggetto patch. :p aram str digital_twin__id: ID del gemello digitale del dispositivo specificato. :p aram list[object]: oggetto json-patch per aggiornare Il gemello digitale. :p aram str etag: valore etag (if_match) da usare per l'operazione di aggiornamento.

from_connection_string

Inizializzatore classmethod per un client del servizio DigitalTwinClient. Crea la classe DigitalTwinClient dalla stringa di connessione.

Dopo aver creato correttamente la classe è stata autenticata con IoTHub ed è pronta per chiamare le API membro per comunicare con IoTHub.

from_connection_string(connection_string)

Parametri

Nome	Descrizione
connection_string Necessario	str Stringa di connessione IoTHub usata per autenticare la connessione con IoTHub.

Restituisce

Tipo	Descrizione
DigitalTwinClient

from_token_credential

Inizializzatore classmethod per un client del servizio DigitalTwinClient. Crea la classe DigitalTwinClient dall'URL del nome host e dalle credenziali del token di Azure.

Dopo aver creato correttamente la classe è stata autenticata con IoTHub ed è pronta per chiamare le API membro per comunicare con IoTHub.

from_token_credential(url, token_credential)

Parametri

Nome	Descrizione
url Necessario	str URL del servizio di Azure (nome host).
token_credential Necessario	<xref:azure.core.TokenCredential> Oggetto credenziali del token di Azure

Restituisce

Tipo	Descrizione
DigitalTwinClient

get_digital_twin

Recuperare il gemello digitale di un determinato dispositivo. :p aram str digital_twin__id: ID del gemello digitale del dispositivo specificato.

get_digital_twin(digital_twin_id)

Parametri

Nome	Descrizione
digital_twin_id Necessario

Restituisce

Tipo	Descrizione
	Oggetto restituito contenente Il gemello digitale.

Eccezioni

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

invoke_command

Richiamare un comando in un dispositivo specifico e ottenere il risultato. :p aram str digital_twin__id: ID del gemello digitale del dispositivo specificato. :p aram str command_name: nome del comando. :p aram str payload: argomento di un comando. :p aram int connect_timeout_in_seconds: intervallo massimo di tempo, in secondi, in cui il comando del gemello digitale attenderà la risposta. :p aram int response_timeout_in_seconds: intervallo massimo di tempo, in secondi, in cui il comando del gemello digitale attenderà la risposta. Il valore deve essere compreso tra 5 e 300.

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

Parametri

Nome	Descrizione
digital_twin_id Necessario
command_name Necessario
payload Necessario
connect_timeout_in_seconds	valore predefinito: None
response_timeout_in_seconds	valore predefinito: None

Restituisce

Tipo	Descrizione
	Risultato del comando richiamato.

Eccezioni

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

invoke_component_command

Richiamare un comando su un componente di un determinato dispositivo e ottenere il risultato. :p aram str digital_twin__id: ID del gemello digitale del dispositivo specificato. :p aram str component_path: nome del componente. :p aram str command_name: nome del comando. :p aram str payload: argomento di un comando. :p aram int connect_timeout_in_seconds: intervallo massimo di tempo, in secondi, in cui il comando del gemello digitale attenderà la risposta. :p aram int response_timeout_in_seconds: intervallo massimo di tempo, in secondi, in cui il comando del gemello digitale attenderà la risposta. Il valore deve essere compreso tra 5 e 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)

Parametri

Nome	Descrizione
digital_twin_id Necessario
component_path Necessario
command_name Necessario
payload Necessario
connect_timeout_in_seconds	valore predefinito: None
response_timeout_in_seconds	valore predefinito: None

Restituisce

Tipo	Descrizione
	Risultato del comando richiamato.

Eccezioni

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

update_digital_twin

Aggiornare il componente gemello digitale di un determinato dispositivo usando un oggetto patch. :p aram str digital_twin__id: ID del gemello digitale del dispositivo specificato. :p aram list[object]: oggetto json-patch per aggiornare Il gemello digitale. :p aram str etag: valore etag (if_match) da usare per l'operazione di aggiornamento.

update_digital_twin(digital_twin_id, digital_twin_patch, etag=None)

Parametri

Nome	Descrizione
digital_twin_id Necessario
digital_twin_patch Necessario
etag	valore predefinito: None

Restituisce

Tipo	Descrizione
	Oggetto restituito contenente il gemello digitale aggiornato.

Eccezioni

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