DigitalTwinClient Klas

Een klasse voor het bieden van handige API's voor DigitalTwin-bewerkingen, op basis van de automatisch gegenereerde IotHub REST API's

Initialisatie voor een DigitalTwinClient.

Nadat de klasse is gemaakt, is geverifieerd met IoTHub en is deze klaar om de lid-API's aan te roepen om te communiceren met IoTHub.

Overname

builtins.object

DigitalTwinClient

Constructor

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

Parameters

Name	Description
connection_string	str De IoTHub-connection string gebruikt om de verbinding met IoTHub te verifiëren als we connection_str-verificatie gebruiken. Standaardwaarde: Geen standaardwaarde: None
host	str De URL van de Azure-service als we verificatie van tokenreferenties gebruiken. Standaardwaarde: Geen standaardwaarde: None
auth	str Het Azure-verificatieobject als we verificatie van tokenreferenties gebruiken. Standaardwaarde: Geen standaardwaarde: None

Methoden

from_connection_string	Classmethod initializer voor een DigitalTwinClient Service-client. Hiermee maakt u de DigitalTwinClient-klasse op basis van connection string. Nadat de klasse is gemaakt, is geverifieerd met IoTHub en is deze klaar om de lid-API's aan te roepen om te communiceren met IoTHub.
from_token_credential	Classmethod initializer voor een DigitalTwinClient Service-client. Hiermee maakt u de DigitalTwinClient-klasse op basis van hostnaam-URL en Azure-tokenreferentie. Nadat de klasse is gemaakt, is geverifieerd met IoTHub en is deze klaar om de lid-API's aan te roepen om te communiceren met IoTHub.
get_digital_twin	Haal de digital twin van een bepaald apparaat op. :p aram str digital_twin__id: de id van de digitale dubbel van het opgegeven apparaat.
invoke_command	Roep een opdracht aan op een bepaald apparaat en haal het resultaat ervan op. :p aram str digital_twin__id: de id van de digitale dubbel van het opgegeven apparaat. :p aram str command_name: de naam van de opdracht. :p aram str payload: het argument van een opdracht. :p aram int connect_timeout_in_seconds: maximaal tijdsinterval, in seconden, dat de opdracht digitale dubbel wacht op het antwoord. :p aram int response_timeout_in_seconds: maximaal tijdsinterval, in seconden, dat de opdracht digitale dubbel wacht op het antwoord. De waarde moet binnen 5-300 zijn.
invoke_component_command	Roep een opdracht aan op een onderdeel van een bepaald apparaat en haal het resultaat ervan op. :p aram str digital_twin__id: de id van de digitale dubbel van het opgegeven apparaat. :p aram str component_path: de naam van het onderdeel. :p aram str command_name: de naam van de opdracht. :p aram str payload: het argument van een opdracht. :p aram int connect_timeout_in_seconds: maximaal tijdsinterval, in seconden, dat de opdracht digitale dubbel wacht op het antwoord. :p aram int response_timeout_in_seconds: maximaal tijdsinterval, in seconden, dat de opdracht digitale dubbel wacht op het antwoord. De waarde moet binnen 5-300 zijn. :type response_timeout_in_seconds: int
update_digital_twin	Werk het Digital Twin-onderdeel van een bepaald apparaat bij met behulp van een patchobject. :p aram str digital_twin__id: de id van de digitale dubbel van het opgegeven apparaat. :p aram list[object]: het json-patch-object om de Digital Twin bij te werken. :p aram str etag: de etag-waarde (if_match) die moet worden gebruikt voor de updatebewerking.

from_connection_string

Classmethod initializer voor een DigitalTwinClient Service-client. Hiermee maakt u de DigitalTwinClient-klasse op basis van connection string.

Nadat de klasse is gemaakt, is geverifieerd met IoTHub en is deze klaar om de lid-API's aan te roepen om te communiceren met IoTHub.

from_connection_string(connection_string)

Parameters

Name	Description
connection_string Vereist	str De IoTHub-connection string gebruikt om de verbinding met IoTHub te verifiëren.

Retouren

Type	Description
DigitalTwinClient

from_token_credential

Classmethod initializer voor een DigitalTwinClient Service-client. Hiermee maakt u de DigitalTwinClient-klasse op basis van hostnaam-URL en Azure-tokenreferentie.

Nadat de klasse is gemaakt, is geverifieerd met IoTHub en is deze klaar om de lid-API's aan te roepen om te communiceren met IoTHub.

from_token_credential(url, token_credential)

Parameters

Name	Description
url Vereist	str De URL van de Azure-service (hostnaam).
token_credential Vereist	<xref:azure.core.TokenCredential> Het Azure-tokenreferentieobject

Retouren

Type	Description
DigitalTwinClient

get_digital_twin

Haal de digital twin van een bepaald apparaat op. :p aram str digital_twin__id: de id van de digitale dubbel van het opgegeven apparaat.

get_digital_twin(digital_twin_id)

Parameters

Name	Description
digital_twin_id Vereist

Retouren

Type	Description
	Het retourobject dat de digitale dubbel bevat.

Uitzonderingen

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

invoke_command

Roep een opdracht aan op een bepaald apparaat en haal het resultaat ervan op. :p aram str digital_twin__id: de id van de digitale dubbel van het opgegeven apparaat. :p aram str command_name: de naam van de opdracht. :p aram str payload: het argument van een opdracht. :p aram int connect_timeout_in_seconds: maximaal tijdsinterval, in seconden, dat de opdracht digitale dubbel wacht op het antwoord. :p aram int response_timeout_in_seconds: maximaal tijdsinterval, in seconden, dat de opdracht digitale dubbel wacht op het antwoord. De waarde moet binnen 5-300 zijn.

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

Parameters

Name	Description
digital_twin_id Vereist
command_name Vereist
payload Vereist
connect_timeout_in_seconds	standaardwaarde: None
response_timeout_in_seconds	standaardwaarde: None

Retouren

Type	Description
	Het resultaat van de aangeroepen opdracht.

Uitzonderingen

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

invoke_component_command

Roep een opdracht aan op een onderdeel van een bepaald apparaat en haal het resultaat ervan op. :p aram str digital_twin__id: de id van de digitale dubbel van het opgegeven apparaat. :p aram str component_path: de naam van het onderdeel. :p aram str command_name: de naam van de opdracht. :p aram str payload: het argument van een opdracht. :p aram int connect_timeout_in_seconds: maximaal tijdsinterval, in seconden, dat de opdracht digitale dubbel wacht op het antwoord. :p aram int response_timeout_in_seconds: maximaal tijdsinterval, in seconden, dat de opdracht digitale dubbel wacht op het antwoord. De waarde moet binnen 5-300 zijn. :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)

Parameters

Name	Description
digital_twin_id Vereist
component_path Vereist
command_name Vereist
payload Vereist
connect_timeout_in_seconds	standaardwaarde: None
response_timeout_in_seconds	standaardwaarde: None

Retouren

Type	Description
	Het resultaat van de aangeroepen opdracht.

Uitzonderingen

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

update_digital_twin

Werk het Digital Twin-onderdeel van een bepaald apparaat bij met behulp van een patchobject. :p aram str digital_twin__id: de id van de digitale dubbel van het opgegeven apparaat. :p aram list[object]: het json-patch-object om de Digital Twin bij te werken. :p aram str etag: de etag-waarde (if_match) die moet worden gebruikt voor de updatebewerking.

update_digital_twin(digital_twin_id, digital_twin_patch, etag=None)

Parameters

Name	Description
digital_twin_id Vereist
digital_twin_patch Vereist
etag	standaardwaarde: None

Retouren

Type	Description
	Het retourobject dat de bijgewerkte Digital Twin bevat.

Uitzonderingen

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