Sdílet prostřednictvím

DigitalTwinClient Třída

  • Reference

Třída poskytující pohodlná rozhraní API pro operace DigitalTwin, která jsou založená na automaticky generovaných rozhraních IOTHub REST API

Inicializátor pro DigitalTwinClient.

Po úspěšném vytvoření se třída ověří pomocí IoTHubu a je připravená volat rozhraní API členů pro komunikaci s IoTHubem.

Dědičnost
builtins.object
DigitalTwinClient

Konstruktor

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

Parametry

Name Description
connection_string
str

Připojovací řetězec IoTHubu použitý k ověření připojení k IoTHubu, pokud používáme ověřování connection_str. Výchozí hodnota: Žádná

výchozí hodnota: None
host
str

Adresa URL služby Azure, pokud používáme ověřování přihlašovacích údajů tokenu. Výchozí hodnota: Žádná

výchozí hodnota: None
auth
str

Ověřovací objekt Azure, pokud používáme ověřování přihlašovacích údajů tokenu. Výchozí hodnota: Žádná

výchozí hodnota: None

Metody

from_connection_string

Inicializátor classmethod pro klienta služby DigitalTwinClient. Vytvoří třídu DigitalTwinClient z připojovacího řetězce.

Po úspěšném vytvoření se třída ověří pomocí IoTHubu a je připravená volat rozhraní API členů pro komunikaci s IoTHubem.
from_token_credential

Inicializátor classmethod pro klienta služby DigitalTwinClient. Vytvoří třídu DigitalTwinClient z adresy URL názvu hostitele a přihlašovacích údajů tokenu Azure.

Po úspěšném vytvoření se třída ověří pomocí IoTHubu a je připravená volat rozhraní API členů pro komunikaci s IoTHubem.
get_digital_twin

Načtěte digitální dvojče daného zařízení. :p aram str digital_twin__id: ID digitálního dvojčete daného zařízení.
invoke_command

Vyvolání příkazu na konkrétním zařízení a získání jeho výsledku :p aram str digital_twin__id: ID digitálního dvojčete daného zařízení. :p aram str command_name: Název příkazu. :p aram str payload: Argument příkazu. :p aram int connect_timeout_in_seconds: Maximální časový interval v sekundách, který bude příkaz digitálního dvojčete čekat na odpověď. :p aram int response_timeout_in_seconds: Maximální časový interval v sekundách, který bude příkaz digitálního dvojčete čekat na odpověď. Hodnota musí být v rozmezí 5–300.
invoke_component_command

Vyvolání příkazu na komponentě konkrétního zařízení a získání jeho výsledku :p aram str digital_twin__id: ID digitálního dvojčete daného zařízení. :p aram str component_path: Název komponenty. :p aram str command_name: Název příkazu. :p aram str payload: Argument příkazu. :p aram int connect_timeout_in_seconds: Maximální časový interval v sekundách, který bude příkaz digitálního dvojčete čekat na odpověď. :p aram int response_timeout_in_seconds: Maximální časový interval v sekundách, který bude příkaz digitálního dvojčete čekat na odpověď. Hodnota musí být v rozmezí 5–300. :type response_timeout_in_seconds: int
update_digital_twin

Aktualizujte komponentu Digital Twin daného zařízení pomocí objektu opravy. :p aram str digital_twin__id: ID digitálního dvojčete daného zařízení. :p aram list[object]: Objekt json-patch pro aktualizaci služby Digital Twin. :p aram str etag: Hodnota značky (if_match), která se má použít pro operaci aktualizace.

from_connection_string

Inicializátor classmethod pro klienta služby DigitalTwinClient. Vytvoří třídu DigitalTwinClient z připojovacího řetězce.

Po úspěšném vytvoření se třída ověří pomocí IoTHubu a je připravená volat rozhraní API členů pro komunikaci s IoTHubem.

from_connection_string(connection_string)

Parametry

Name Description
connection_string
Vyžadováno
str

Připojovací řetězec IoTHubu, který slouží k ověření připojení k IoTHubu.

Návraty

Typ Description
DigitalTwinClient

from_token_credential

Inicializátor classmethod pro klienta služby DigitalTwinClient. Vytvoří třídu DigitalTwinClient z adresy URL názvu hostitele a přihlašovacích údajů tokenu Azure.

Po úspěšném vytvoření se třída ověří pomocí IoTHubu a je připravená volat rozhraní API členů pro komunikaci s IoTHubem.

from_token_credential(url, token_credential)

Parametry

Name Description
url
Vyžadováno
str

Adresa URL služby Azure (název hostitele).
token_credential
Vyžadováno
<xref:azure.core.TokenCredential>

Objekt přihlašovacích údajů tokenu Azure

Návraty

Typ Description
DigitalTwinClient

get_digital_twin

Načtěte digitální dvojče daného zařízení. :p aram str digital_twin__id: ID digitálního dvojčete daného zařízení.

get_digital_twin(digital_twin_id)

Parametry

Name Description
digital_twin_id
Vyžadováno

Návraty

Typ Description

Návratový objekt obsahující digital twin.

Výjimky

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

invoke_command

Vyvolání příkazu na konkrétním zařízení a získání jeho výsledku :p aram str digital_twin__id: ID digitálního dvojčete daného zařízení. :p aram str command_name: Název příkazu. :p aram str payload: Argument příkazu. :p aram int connect_timeout_in_seconds: Maximální časový interval v sekundách, který bude příkaz digitálního dvojčete čekat na odpověď. :p aram int response_timeout_in_seconds: Maximální časový interval v sekundách, který bude příkaz digitálního dvojčete čekat na odpověď. Hodnota musí být v rozmezí 5–300.

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

Parametry

Name Description
digital_twin_id
Vyžadováno
command_name
Vyžadováno
payload
Vyžadováno
connect_timeout_in_seconds
výchozí hodnota: None
response_timeout_in_seconds
výchozí hodnota: None

Návraty

Typ Description

Výsledek vyvolaného příkazu.

Výjimky

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

invoke_component_command

Vyvolání příkazu na komponentě konkrétního zařízení a získání jeho výsledku :p aram str digital_twin__id: ID digitálního dvojčete daného zařízení. :p aram str component_path: Název komponenty. :p aram str command_name: Název příkazu. :p aram str payload: Argument příkazu. :p aram int connect_timeout_in_seconds: Maximální časový interval v sekundách, který bude příkaz digitálního dvojčete čekat na odpověď. :p aram int response_timeout_in_seconds: Maximální časový interval v sekundách, který bude příkaz digitálního dvojčete čekat na odpověď. Hodnota musí být v rozmezí 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

Name Description
digital_twin_id
Vyžadováno
component_path
Vyžadováno
command_name
Vyžadováno
payload
Vyžadováno
connect_timeout_in_seconds
výchozí hodnota: None
response_timeout_in_seconds
výchozí hodnota: None

Návraty

Typ Description

Výsledek vyvolaného příkazu.

Výjimky

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

update_digital_twin

Aktualizujte komponentu Digital Twin daného zařízení pomocí objektu opravy. :p aram str digital_twin__id: ID digitálního dvojčete daného zařízení. :p aram list[object]: Objekt json-patch pro aktualizaci služby Digital Twin. :p aram str etag: Hodnota značky (if_match), která se má použít pro operaci aktualizace.

update_digital_twin(digital_twin_id, digital_twin_patch, etag=None)

Parametry

Name Description
digital_twin_id
Vyžadováno
digital_twin_patch
Vyžadováno
etag
výchozí hodnota: None

Návraty

Typ Description

Návratový objekt obsahující aktualizované digitální dvojče.

Výjimky

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