DigitalTwinClient Osztály

Az automatikusan létrehozott IotHub REST API-kon alapuló, a DigitalTwin-műveletekhez használható kényelmi API-kat biztosító osztály

DigitalTwinClient inicializálója.

A sikeres létrehozás után az osztály hitelesítése megtörtént az IoTHubon, és készen áll arra, hogy meghívja a tag API-kat az IoTHubbal való kommunikációhoz.

Öröklődés

builtins.object

DigitalTwinClient

Konstruktor

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

Paraméterek

Name	Description
connection_string	str Az IoTHub kapcsolati sztring az IoTHubtal való kapcsolat hitelesítésére, ha connection_str hitelesítést használunk. Alapértelmezett érték: Nincs alapértelmezett érték: None
host	str Az Azure-szolgáltatás URL-címe, ha token hitelesítő adatokat használunk. Alapértelmezett érték: Nincs alapértelmezett érték: None
auth	str Az Azure-hitelesítési objektum, ha token hitelesítő adatokat használunk. Alapértelmezett érték: Nincs alapértelmezett érték: None

Metódusok

from_connection_string	Classmethod initializer a DigitalTwinClient Service-ügyfélhez. DigitalTwinClient osztályt hoz létre a kapcsolati sztring. A sikeres létrehozás után az osztály hitelesítése megtörtént az IoTHubon, és készen áll arra, hogy meghívja a tag API-kat az IoTHubbal való kommunikációhoz.
from_token_credential	Classmethod initializer a DigitalTwinClient Service-ügyfélhez. DigitalTwinClient-osztályt hoz létre a gazdagépnév URL-címéből és az Azure token hitelesítő adataiból. A sikeres létrehozás után az osztály hitelesítése megtörtént az IoTHubon, és készen áll arra, hogy meghívja a tag API-kat az IoTHubbal való kommunikációhoz.
get_digital_twin	Kérje le egy adott eszköz Digitális ikerpéldányát. :p aram str digital_twin__id: Az adott eszköz digitális ikerpéldány-azonosítója.
invoke_command	Meghívhat egy parancsot egy adott eszközön, és lekérheti annak eredményét. :p aram str digital_twin__id: Az adott eszköz digitális ikerpéldány-azonosítója. :p aram str command_name: A parancs neve. :p aram str payload: Egy parancs argumentuma. :p aram int connect_timeout_in_seconds: A digitális ikerpéldány-parancs által a válaszra váró idő maximális időtartama másodpercben. :p aram int response_timeout_in_seconds: A digitális ikerpéldány-parancs által a válaszra váró idő maximális időtartama másodpercben. Az értéknek 5-300-on belül kell lennie.
invoke_component_command	Parancs meghívása egy adott eszköz egyik összetevőjén, és annak eredménye. :p aram str digital_twin__id: Az adott eszköz digitális ikerpéldány-azonosítója. :p aram str component_path: Az összetevő neve. :p aram str command_name: A parancs neve. :p aram str payload: Egy parancs argumentuma. :p aram int connect_timeout_in_seconds: A digitális ikerpéldány-parancs által a válaszra váró idő maximális időtartama másodpercben. :p aram int response_timeout_in_seconds: A digitális ikerpéldány-parancs által a válaszra váró idő maximális időtartama másodpercben. Az értéknek 5-300-on belül kell lennie. :type response_timeout_in_seconds: int
update_digital_twin	Frissítse egy adott eszköz Digital Twin Összetevőjét egy javítási objektummal. :p aram str digital_twin__id: Az adott eszköz digitális ikerpéldány-azonosítója. :p aram list[object]: A Digital Twin frissítéséhez használt json-patch objektum. :p aram str etag: A frissítési művelethez használandó etag (if_match) érték.

from_connection_string

Classmethod initializer a DigitalTwinClient Service-ügyfélhez. DigitalTwinClient osztályt hoz létre a kapcsolati sztring.

A sikeres létrehozás után az osztály hitelesítése megtörtént az IoTHubon, és készen áll arra, hogy meghívja a tag API-kat az IoTHubbal való kommunikációhoz.

from_connection_string(connection_string)

Paraméterek

Name	Description
connection_string Kötelező	str Az IoTHubtal való kapcsolat hitelesítéséhez használt IoTHub kapcsolati sztring.

Válaszok

Típus	Description
DigitalTwinClient

from_token_credential

Classmethod initializer a DigitalTwinClient Service-ügyfélhez. DigitalTwinClient-osztályt hoz létre a gazdagépnév URL-címéből és az Azure token hitelesítő adataiból.

A sikeres létrehozás után az osztály hitelesítése megtörtént az IoTHubon, és készen áll arra, hogy meghívja a tag API-kat az IoTHubbal való kommunikációhoz.

from_token_credential(url, token_credential)

Paraméterek

Name	Description
url Kötelező	str Az Azure-szolgáltatás URL-címe (állomásnév).
token_credential Kötelező	<xref:azure.core.TokenCredential> Az Azure-jogkivonat hitelesítőadat-objektuma

Válaszok

Típus	Description
DigitalTwinClient

get_digital_twin

Kérje le egy adott eszköz Digitális ikerpéldányát. :p aram str digital_twin__id: Az adott eszköz digitális ikerpéldány-azonosítója.

get_digital_twin(digital_twin_id)

Paraméterek

Name	Description
digital_twin_id Kötelező

Válaszok

Típus	Description
	A Digital Twint tartalmazó visszatérési objektum.

Kivételek

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

invoke_command

Meghívhat egy parancsot egy adott eszközön, és lekérheti annak eredményét. :p aram str digital_twin__id: Az adott eszköz digitális ikerpéldány-azonosítója. :p aram str command_name: A parancs neve. :p aram str payload: Egy parancs argumentuma. :p aram int connect_timeout_in_seconds: A digitális ikerpéldány-parancs által a válaszra váró idő maximális időtartama másodpercben. :p aram int response_timeout_in_seconds: A digitális ikerpéldány-parancs által a válaszra váró idő maximális időtartama másodpercben. Az értéknek 5-300-on belül kell lennie.

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

Paraméterek

Name	Description
digital_twin_id Kötelező
command_name Kötelező
payload Kötelező
connect_timeout_in_seconds	alapértelmezett érték: None
response_timeout_in_seconds	alapértelmezett érték: None

Válaszok

Típus	Description
	A meghívott parancs eredménye.

Kivételek

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

invoke_component_command

Parancs meghívása egy adott eszköz egyik összetevőjén, és annak eredménye. :p aram str digital_twin__id: Az adott eszköz digitális ikerpéldány-azonosítója. :p aram str component_path: Az összetevő neve. :p aram str command_name: A parancs neve. :p aram str payload: Egy parancs argumentuma. :p aram int connect_timeout_in_seconds: A digitális ikerpéldány-parancs által a válaszra váró idő maximális időtartama másodpercben. :p aram int response_timeout_in_seconds: A digitális ikerpéldány-parancs által a válaszra váró idő maximális időtartama másodpercben. Az értéknek 5-300-on belül kell lennie. :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éterek

Name	Description
digital_twin_id Kötelező
component_path Kötelező
command_name Kötelező
payload Kötelező
connect_timeout_in_seconds	alapértelmezett érték: None
response_timeout_in_seconds	alapértelmezett érték: None

Válaszok

Típus	Description
	A meghívott parancs eredménye.

Kivételek

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

update_digital_twin

Frissítse egy adott eszköz Digital Twin Összetevőjét egy javítási objektummal. :p aram str digital_twin__id: Az adott eszköz digitális ikerpéldány-azonosítója. :p aram list[object]: A Digital Twin frissítéséhez használt json-patch objektum. :p aram str etag: A frissítési művelethez használandó etag (if_match) érték.

update_digital_twin(digital_twin_id, digital_twin_patch, etag=None)

Paraméterek

Name	Description
digital_twin_id Kötelező
digital_twin_patch Kötelező
etag	alapértelmezett érték: None

Válaszok

Típus	Description
	A frissített Digital Twin-t tartalmazó visszatérési objektum.

Kivételek

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