DigitalTwinClient Klasa

Klasa zapewniająca wygodne interfejsy API dla operacji DigitalTwin na podstawie automatycznie generowanych interfejsów API REST usługi IotHub

Inicjator elementu DigitalTwinClient.

Po pomyślnym utworzeniu klasa została uwierzytelniona w usłudze IoTHub i jest gotowa do wywołania interfejsów API składowych w celu komunikowania się z usługą IoTHub.

Dziedziczenie

builtins.object

DigitalTwinClient

Konstruktor

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

Parametry

Nazwa	Opis
connection_string	str Parametry połączenia usługi IoTHub używane do uwierzytelniania połączenia z usługą IoTHub, jeśli używamy uwierzytelniania connection_str. Wartość domyślna: Brak wartość domyślna: None
host	str Adres URL usługi platformy Azure, jeśli używamy uwierzytelniania poświadczeń tokenu. Wartość domyślna: Brak wartość domyślna: None
auth	str Obiekt uwierzytelniania platformy Azure, jeśli używamy uwierzytelniania poświadczeń tokenu. Wartość domyślna: Brak wartość domyślna: None

Metody

from_connection_string	Inicjator classmethod dla klienta usługi DigitalTwinClient. Tworzy klasę DigitalTwinClient na podstawie parametrów połączenia. Po pomyślnym utworzeniu klasa została uwierzytelniona w usłudze IoTHub i jest gotowa do wywołania interfejsów API składowych w celu komunikowania się z usługą IoTHub.
from_token_credential	Inicjator classmethod dla klienta usługi DigitalTwinClient. Tworzy klasę DigitalTwinClient na podstawie adresu URL nazwy hosta i poświadczeń tokenu platformy Azure. Po pomyślnym utworzeniu klasa została uwierzytelniona w usłudze IoTHub i jest gotowa do wywołania interfejsów API składowych w celu komunikowania się z usługą IoTHub.
get_digital_twin	Pobierz cyfrową reprezentację bliźniaczą danego urządzenia. :p aram str digital_twin__id: identyfikator cyfrowej reprezentacji bliźniaczej danego urządzenia.
invoke_command	Wywołaj polecenie na określonym urządzeniu i uzyskaj jego wynik. :p aram str digital_twin__id: identyfikator cyfrowej reprezentacji bliźniaczej danego urządzenia. :p aram str command_name: nazwa polecenia. :p aram strload: argument polecenia. :p aram int connect_timeout_in_seconds: maksymalny interwał czasu w sekundach, że polecenie cyfrowej reprezentacji bliźniaczej będzie czekać na odpowiedź. :p aram int response_timeout_in_seconds: maksymalny interwał czasu w sekundach, że polecenie cyfrowej reprezentacji bliźniaczej będzie czekać na odpowiedź. Wartość musi należeć do zakresu 5–300.
invoke_component_command	Wywołaj polecenie na składniku określonego urządzenia i uzyskaj jego wynik. :p aram str digital_twin__id: identyfikator cyfrowej reprezentacji bliźniaczej danego urządzenia. :p aram str component_path: nazwa składnika. :p aram str command_name: nazwa polecenia. :p aram strload: argument polecenia. :p aram int connect_timeout_in_seconds: maksymalny interwał czasu w sekundach, że polecenie cyfrowej reprezentacji bliźniaczej będzie czekać na odpowiedź. :p aram int response_timeout_in_seconds: maksymalny interwał czasu w sekundach, że polecenie cyfrowej reprezentacji bliźniaczej będzie czekać na odpowiedź. Wartość musi należeć do zakresu 5–300. :type response_timeout_in_seconds: int
update_digital_twin	Zaktualizuj składnik cyfrowej reprezentacji bliźniaczej danego urządzenia przy użyciu obiektu patch. :p aram str digital_twin__id: identyfikator cyfrowej reprezentacji bliźniaczej danego urządzenia. :p aram list[object]: obiekt json-patch w celu zaktualizowania usługi Digital Twin. :p aram str etag: wartość etag (if_match) do użycia dla operacji aktualizacji.

from_connection_string

Inicjator classmethod dla klienta usługi DigitalTwinClient. Tworzy klasę DigitalTwinClient na podstawie parametrów połączenia.

Po pomyślnym utworzeniu klasa została uwierzytelniona w usłudze IoTHub i jest gotowa do wywołania interfejsów API składowych w celu komunikowania się z usługą IoTHub.

from_connection_string(connection_string)

Parametry

Nazwa	Opis
connection_string Wymagane	str Parametry połączenia usługi IoTHub używane do uwierzytelniania połączenia z usługą IoTHub.

Zwraca

Typ	Opis
DigitalTwinClient

from_token_credential

Inicjator classmethod dla klienta usługi DigitalTwinClient. Tworzy klasę DigitalTwinClient na podstawie adresu URL nazwy hosta i poświadczeń tokenu platformy Azure.

Po pomyślnym utworzeniu klasa została uwierzytelniona w usłudze IoTHub i jest gotowa do wywołania interfejsów API składowych w celu komunikowania się z usługą IoTHub.

from_token_credential(url, token_credential)

Parametry

Nazwa	Opis
url Wymagane	str Adres URL usługi platformy Azure (nazwa hosta).
token_credential Wymagane	<xref:azure.core.TokenCredential> Obiekt poświadczeń tokenu platformy Azure

Zwraca

Typ	Opis
DigitalTwinClient

get_digital_twin

Pobierz cyfrową reprezentację bliźniaczą danego urządzenia. :p aram str digital_twin__id: identyfikator cyfrowej reprezentacji bliźniaczej danego urządzenia.

get_digital_twin(digital_twin_id)

Parametry

Nazwa	Opis
digital_twin_id Wymagane

Zwraca

Typ	Opis
	Obiekt zwracany zawierający cyfrową reprezentację bliźniaczą.

Wyjątki

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

invoke_command

Wywołaj polecenie na określonym urządzeniu i uzyskaj jego wynik. :p aram str digital_twin__id: identyfikator cyfrowej reprezentacji bliźniaczej danego urządzenia. :p aram str command_name: nazwa polecenia. :p aram strload: argument polecenia. :p aram int connect_timeout_in_seconds: maksymalny interwał czasu w sekundach, że polecenie cyfrowej reprezentacji bliźniaczej będzie czekać na odpowiedź. :p aram int response_timeout_in_seconds: maksymalny interwał czasu w sekundach, że polecenie cyfrowej reprezentacji bliźniaczej będzie czekać na odpowiedź. Wartość musi należeć do zakresu 5–300.

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

Parametry

Nazwa	Opis
digital_twin_id Wymagane
command_name Wymagane
payload Wymagane
connect_timeout_in_seconds	wartość domyślna: None
response_timeout_in_seconds	wartość domyślna: None

Zwraca

Typ	Opis
	Wynik wywołanego polecenia.

Wyjątki

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

invoke_component_command

Wywołaj polecenie na składniku określonego urządzenia i uzyskaj jego wynik. :p aram str digital_twin__id: identyfikator cyfrowej reprezentacji bliźniaczej danego urządzenia. :p aram str component_path: nazwa składnika. :p aram str command_name: nazwa polecenia. :p aram strload: argument polecenia. :p aram int connect_timeout_in_seconds: maksymalny interwał czasu w sekundach, że polecenie cyfrowej reprezentacji bliźniaczej będzie czekać na odpowiedź. :p aram int response_timeout_in_seconds: maksymalny interwał czasu w sekundach, że polecenie cyfrowej reprezentacji bliźniaczej będzie czekać na odpowiedź. Wartość musi należeć do zakresu 5–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)

Parametry

Nazwa	Opis
digital_twin_id Wymagane
component_path Wymagane
command_name Wymagane
payload Wymagane
connect_timeout_in_seconds	wartość domyślna: None
response_timeout_in_seconds	wartość domyślna: None

Zwraca

Typ	Opis
	Wynik wywołanego polecenia.

Wyjątki

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

update_digital_twin

Zaktualizuj składnik cyfrowej reprezentacji bliźniaczej danego urządzenia przy użyciu obiektu patch. :p aram str digital_twin__id: identyfikator cyfrowej reprezentacji bliźniaczej danego urządzenia. :p aram list[object]: obiekt json-patch w celu zaktualizowania usługi Digital Twin. :p aram str etag: wartość etag (if_match) do użycia dla operacji aktualizacji.

update_digital_twin(digital_twin_id, digital_twin_patch, etag=None)

Parametry

Nazwa	Opis
digital_twin_id Wymagane
digital_twin_patch Wymagane
etag	wartość domyślna: None

Zwraca

Typ	Opis
	Obiekt zwracany zawierający zaktualizowaną usługę Digital Twin.

Wyjątki

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