DigitalTwinClient Klasse

Eine Klasse zum Bereitstellen von Komfort-APIs für DigitalTwin-Vorgänge, basierend auf den automatisch generierten IotHub-REST-APIs

Initialisierer für einen DigitalTwinClient.

Nach einer erfolgreichen Erstellung wurde die Klasse bei IoTHub authentifiziert und kann die Member-APIs für die Kommunikation mit IoTHub aufrufen.

Vererbung

builtins.object

DigitalTwinClient

Konstruktor

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

Parameter

Name	Beschreibung
connection_string	str Die IoTHub-Verbindungszeichenfolge, die zum Authentifizieren der Verbindung mit IoTHub verwendet wird, wenn wir connection_str Authentifizierung verwenden. Standardwert: Keiner Standardwert: None
host	str Die Azure-Dienst-URL, wenn wir die Tokenanmeldeinformationsauthentifizierung verwenden. Standardwert: Keiner Standardwert: None
auth	str Das Azure-Authentifizierungsobjekt, wenn wir die Authentifizierung mit Tokenanmeldeinformationen verwenden. Standardwert: Keiner Standardwert: None

Methoden

from_connection_string	Classmethod-Initialisierer für einen DigitalTwinClient Service-Client. Erstellt die DigitalTwinClient-Klasse aus der Verbindungszeichenfolge. Nach einer erfolgreichen Erstellung wurde die Klasse bei IoTHub authentifiziert und kann die Member-APIs für die Kommunikation mit IoTHub aufrufen.
from_token_credential	Classmethod-Initialisierer für einen DigitalTwinClient Service-Client. Erstellt die DigitalTwinClient-Klasse aus der Hostnamen-URL und Azure-Tokenanmeldeinformationen. Nach einer erfolgreichen Erstellung wurde die Klasse bei IoTHub authentifiziert und kann die Member-APIs für die Kommunikation mit IoTHub aufrufen.
get_digital_twin	Rufen Sie den digitalen Zwilling eines bestimmten Geräts ab. :p aram str digital_twin__id: Die Id des digitalen Zwillings des angegebenen Geräts.
invoke_command	Rufen Sie einen Befehl auf einem bestimmten Gerät auf, und rufen Sie das Ergebnis ab. :p aram str digital_twin__id: Die Id des digitalen Zwillings des angegebenen Geräts. :p aram str command_name: Der Name des Befehls. :p aram str payload: Das Argument eines Befehls. :p aram int connect_timeout_in_seconds: Maximales Zeitintervall in Sekunden, in dem der Digitale Zwillingsbefehl auf die Antwort wartet. :p aram int response_timeout_in_seconds: Maximales Zeitintervall in Sekunden, in dem der Digitale Zwillingsbefehl auf die Antwort wartet. Der Wert muss zwischen 5 und 300 sein.
invoke_component_command	Rufen Sie einen Befehl für eine Komponente eines bestimmten Geräts auf, und rufen Sie das Ergebnis ab. :p aram str digital_twin__id: Die Id des digitalen Zwillings des angegebenen Geräts. :p aram str component_path: Der Name der Komponente. :p aram str command_name: Der Name des Befehls. :p aram str payload: Das Argument eines Befehls. :p aram int connect_timeout_in_seconds: Maximales Zeitintervall in Sekunden, in dem der Digitale Zwillingsbefehl auf die Antwort wartet. :p aram int response_timeout_in_seconds: Maximales Zeitintervall in Sekunden, in dem der Digitale Zwillingsbefehl auf die Antwort wartet. Der Wert muss zwischen 5 und 300 sein. :type response_timeout_in_seconds: int
update_digital_twin	Aktualisieren Sie die Digital Twin-Komponente eines bestimmten Geräts mithilfe eines Patchobjekts. :p aram str digital_twin__id: Die Id des digitalen Zwillings des angegebenen Geräts. :p aram list[object]: Das json-patch-Objekt zum Aktualisieren des digitalen Zwillings. :p aram str etag: Der etag-Wert (if_match), der für den Updatevorgang verwendet werden soll.

from_connection_string

Classmethod-Initialisierer für einen DigitalTwinClient Service-Client. Erstellt die DigitalTwinClient-Klasse aus der Verbindungszeichenfolge.

Nach einer erfolgreichen Erstellung wurde die Klasse bei IoTHub authentifiziert und kann die Member-APIs für die Kommunikation mit IoTHub aufrufen.

from_connection_string(connection_string)

Parameter

Name	Beschreibung
connection_string Erforderlich	str Die IoTHub-Verbindungszeichenfolge, die zum Authentifizieren der Verbindung mit IoTHub verwendet wird.

Gibt zurück

Typ	Beschreibung
DigitalTwinClient

from_token_credential

Classmethod-Initialisierer für einen DigitalTwinClient Service-Client. Erstellt die DigitalTwinClient-Klasse aus der Hostnamen-URL und Azure-Tokenanmeldeinformationen.

Nach einer erfolgreichen Erstellung wurde die Klasse bei IoTHub authentifiziert und kann die Member-APIs für die Kommunikation mit IoTHub aufrufen.

from_token_credential(url, token_credential)

Parameter

Name	Beschreibung
url Erforderlich	str Die Azure-Dienst-URL (Hostname).
token_credential Erforderlich	<xref:azure.core.TokenCredential> Das Azure-Tokenanmeldeinformationsobjekt

Gibt zurück

Typ	Beschreibung
DigitalTwinClient

get_digital_twin

Rufen Sie den digitalen Zwilling eines bestimmten Geräts ab. :p aram str digital_twin__id: Die Id des digitalen Zwillings des angegebenen Geräts.

get_digital_twin(digital_twin_id)

Parameter

Name	Beschreibung
digital_twin_id Erforderlich

Gibt zurück

Typ	Beschreibung
	Das Rückgabeobjekt, das den digitalen Zwilling enthält.

Ausnahmen

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

invoke_command

Rufen Sie einen Befehl auf einem bestimmten Gerät auf, und rufen Sie das Ergebnis ab. :p aram str digital_twin__id: Die Id des digitalen Zwillings des angegebenen Geräts. :p aram str command_name: Der Name des Befehls. :p aram str payload: Das Argument eines Befehls. :p aram int connect_timeout_in_seconds: Maximales Zeitintervall in Sekunden, in dem der Digitale Zwillingsbefehl auf die Antwort wartet. :p aram int response_timeout_in_seconds: Maximales Zeitintervall in Sekunden, in dem der Digitale Zwillingsbefehl auf die Antwort wartet. Der Wert muss zwischen 5 und 300 sein.

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

Parameter

Name	Beschreibung
digital_twin_id Erforderlich
command_name Erforderlich
payload Erforderlich
connect_timeout_in_seconds	Standardwert: None
response_timeout_in_seconds	Standardwert: None

Gibt zurück

Typ	Beschreibung
	Das Ergebnis des aufgerufenen Befehls.

Ausnahmen

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

invoke_component_command

Rufen Sie einen Befehl für eine Komponente eines bestimmten Geräts auf, und rufen Sie das Ergebnis ab. :p aram str digital_twin__id: Die Id des digitalen Zwillings des angegebenen Geräts. :p aram str component_path: Der Name der Komponente. :p aram str command_name: Der Name des Befehls. :p aram str payload: Das Argument eines Befehls. :p aram int connect_timeout_in_seconds: Maximales Zeitintervall in Sekunden, in dem der Digitale Zwillingsbefehl auf die Antwort wartet. :p aram int response_timeout_in_seconds: Maximales Zeitintervall in Sekunden, in dem der Digitale Zwillingsbefehl auf die Antwort wartet. Der Wert muss zwischen 5 und 300 sein. :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)

Parameter

Name	Beschreibung
digital_twin_id Erforderlich
component_path Erforderlich
command_name Erforderlich
payload Erforderlich
connect_timeout_in_seconds	Standardwert: None
response_timeout_in_seconds	Standardwert: None

Gibt zurück

Typ	Beschreibung
	Das Ergebnis des aufgerufenen Befehls.

Ausnahmen

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

update_digital_twin

Aktualisieren Sie die Digital Twin-Komponente eines bestimmten Geräts mithilfe eines Patchobjekts. :p aram str digital_twin__id: Die Id des digitalen Zwillings des angegebenen Geräts. :p aram list[object]: Das json-patch-Objekt zum Aktualisieren des digitalen Zwillings. :p aram str etag: Der etag-Wert (if_match), der für den Updatevorgang verwendet werden soll.

update_digital_twin(digital_twin_id, digital_twin_patch, etag=None)

Parameter

Name	Beschreibung
digital_twin_id Erforderlich
digital_twin_patch Erforderlich
etag	Standardwert: None

Gibt zurück

Typ	Beschreibung
	Das Rückgabeobjekt, das den aktualisierten digitalen Zwilling enthält.

Ausnahmen

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