DigitalTwinClient Classe

Uma classe para fornecer APIs de conveniência para operações DigitalTwin, com base nas APIs REST do IotHub geradas automaticamente

Inicializador para um DigitalTwinClient.

Após uma criação bem-sucedida, a classe foi autenticada com o IoTHub e está pronta para chamar as APIs membro para se comunicar com o IoTHub.

Herança

builtins.object

DigitalTwinClient

Construtor

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

Parâmetros

Nome	Description
connection_string	str A cadeia de conexão do IoTHub usada para autenticar a conexão com o IoTHub se estivermos usando connection_str autenticação. Valor padrão: nenhum valor padrão: None
host	str A URL do serviço do Azure se estivermos usando a autenticação de credencial de token. Valor padrão: nenhum valor padrão: None
auth	str O objeto de autenticação do Azure se estivermos usando a autenticação de credencial de token. Valor padrão: nenhum valor padrão: None

Métodos

from_connection_string	Inicializador classmethod para um cliente do Serviço DigitalTwinClient. Cria a classe DigitalTwinClient da cadeia de conexão. Após uma criação bem-sucedida, a classe foi autenticada com o IoTHub e está pronta para chamar as APIs membro para se comunicar com o IoTHub.
from_token_credential	Inicializador classmethod para um cliente do Serviço DigitalTwinClient. Cria a classe DigitalTwinClient com base na URL do nome do host e na credencial de token do Azure. Após uma criação bem-sucedida, a classe foi autenticada com o IoTHub e está pronta para chamar as APIs membro para se comunicar com o IoTHub.
get_digital_twin	Recupere o Gêmeo Digital de um determinado dispositivo. :p aram str digital_twin__id: a ID do gêmeo digital do dispositivo especificado.
invoke_command	Invoque um comando em um dispositivo específico e obtenha o resultado dele. :p aram str digital_twin__id: a ID do gêmeo digital do dispositivo especificado. :p aram str command_name: o nome do comando. :p aram str payload: o argumento de um comando. :p aram int connect_timeout_in_seconds: intervalo máximo de tempo, em segundos, que o comando gêmeo digital aguardará a resposta. :p aram int response_timeout_in_seconds: intervalo máximo de tempo, em segundos, que o comando gêmeo digital aguardará a resposta. O valor deve estar dentro de 5 a 300.
invoke_component_command	Invoque um comando em um componente de um dispositivo específico e obtenha o resultado dele. :p aram str digital_twin__id: a ID do gêmeo digital do dispositivo especificado. :p aram str component_path: o nome do componente. :p aram str command_name: o nome do comando. :p aram str payload: o argumento de um comando. :p aram int connect_timeout_in_seconds: intervalo máximo de tempo, em segundos, que o comando gêmeo digital aguardará a resposta. :p aram int response_timeout_in_seconds: intervalo máximo de tempo, em segundos, que o comando gêmeo digital aguardará a resposta. O valor deve estar dentro de 5 a 300. :type response_timeout_in_seconds: int
update_digital_twin	Atualize o componente gêmeo digital de um determinado dispositivo usando um objeto patch. :p aram str digital_twin__id: a ID do gêmeo digital do dispositivo especificado. :p aram list[object]: o objeto json-patch para atualizar o Gêmeo Digital. :p aram str etag: o valor de etag (if_match) a ser usado para a operação de atualização.

from_connection_string

Inicializador classmethod para um cliente do Serviço DigitalTwinClient. Cria a classe DigitalTwinClient da cadeia de conexão.

Após uma criação bem-sucedida, a classe foi autenticada com o IoTHub e está pronta para chamar as APIs membro para se comunicar com o IoTHub.

from_connection_string(connection_string)

Parâmetros

Nome	Description
connection_string Obrigatório	str A cadeia de conexão do IoTHub usada para autenticar a conexão com o IoTHub.

Retornos

Tipo	Description
DigitalTwinClient

from_token_credential

Inicializador classmethod para um cliente do Serviço DigitalTwinClient. Cria a classe DigitalTwinClient com base na URL do nome do host e na credencial de token do Azure.

Após uma criação bem-sucedida, a classe foi autenticada com o IoTHub e está pronta para chamar as APIs membro para se comunicar com o IoTHub.

from_token_credential(url, token_credential)

Parâmetros

Nome	Description
url Obrigatório	str A URL do serviço do Azure (nome do host).
token_credential Obrigatório	<xref:azure.core.TokenCredential> O objeto de credencial de token do Azure

Retornos

Tipo	Description
DigitalTwinClient

get_digital_twin

Recupere o Gêmeo Digital de um determinado dispositivo. :p aram str digital_twin__id: a ID do gêmeo digital do dispositivo especificado.

get_digital_twin(digital_twin_id)

Parâmetros

Nome	Description
digital_twin_id Obrigatório

Retornos

Tipo	Description
	O objeto de retorno que contém o Gêmeo Digital.

Exceções

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

invoke_command

Invoque um comando em um dispositivo específico e obtenha o resultado dele. :p aram str digital_twin__id: a ID do gêmeo digital do dispositivo especificado. :p aram str command_name: o nome do comando. :p aram str payload: o argumento de um comando. :p aram int connect_timeout_in_seconds: intervalo máximo de tempo, em segundos, que o comando gêmeo digital aguardará a resposta. :p aram int response_timeout_in_seconds: intervalo máximo de tempo, em segundos, que o comando gêmeo digital aguardará a resposta. O valor deve estar dentro de 5 a 300.

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

Parâmetros

Nome	Description
digital_twin_id Obrigatório
command_name Obrigatório
payload Obrigatório
connect_timeout_in_seconds	valor padrão: None
response_timeout_in_seconds	valor padrão: None

Retornos

Tipo	Description
	O resultado do comando invocado.

Exceções

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

invoke_component_command

Invoque um comando em um componente de um dispositivo específico e obtenha o resultado dele. :p aram str digital_twin__id: a ID do gêmeo digital do dispositivo especificado. :p aram str component_path: o nome do componente. :p aram str command_name: o nome do comando. :p aram str payload: o argumento de um comando. :p aram int connect_timeout_in_seconds: intervalo máximo de tempo, em segundos, que o comando gêmeo digital aguardará a resposta. :p aram int response_timeout_in_seconds: intervalo máximo de tempo, em segundos, que o comando gêmeo digital aguardará a resposta. O valor deve estar dentro de 5 a 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)

Parâmetros

Nome	Description
digital_twin_id Obrigatório
component_path Obrigatório
command_name Obrigatório
payload Obrigatório
connect_timeout_in_seconds	valor padrão: None
response_timeout_in_seconds	valor padrão: None

Retornos

Tipo	Description
	O resultado do comando invocado.

Exceções

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

update_digital_twin

Atualize o componente gêmeo digital de um determinado dispositivo usando um objeto patch. :p aram str digital_twin__id: a ID do gêmeo digital do dispositivo especificado. :p aram list[object]: o objeto json-patch para atualizar o Gêmeo Digital. :p aram str etag: o valor de etag (if_match) a ser usado para a operação de atualização.

update_digital_twin(digital_twin_id, digital_twin_patch, etag=None)

Parâmetros

Nome	Description
digital_twin_id Obrigatório
digital_twin_patch Obrigatório
etag	valor padrão: None

Retornos

Tipo	Description
	O objeto de retorno que contém o Gêmeo Digital atualizado.

Exceções

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