Partilhar via


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 membros para comunicar com o IoTHub.

Herança
builtins.object
DigitalTwinClient

Construtor

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

Parâmetros

Name Description
connection_string
str

A cadeia de ligação do IoTHub utilizada para autenticar a ligação com o IoTHub se estivermos a utilizar connection_str autenticação. Valor predefinido: Nenhum

valor predefinido: None
host
str

O URL do serviço do Azure se estivermos a utilizar a autenticação de credenciais de token. Valor predefinido: Nenhum

valor predefinido: None
auth
str

O objeto de autenticação do Azure se estivermos a utilizar a autenticação de credenciais de token. Valor predefinido: Nenhum

valor predefinido: None

Métodos

from_connection_string

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

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

from_token_credential

Inicializador classmethod para um cliente do Serviço DigitalTwinClient. Cria a classe DigitalTwinClient a partir do URL do nome do anfitrião e da credencial do token do Azure.

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

get_digital_twin

Obtenha o Duplo Digital de um determinado dispositivo. :p aram str digital_twin__id: O ID duplo digital do dispositivo especificado.

invoke_command

Invoque um comando num determinado dispositivo e obtenha o resultado do mesmo. :p aram str digital_twin__id: O ID duplo 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 do duplo digital aguardará a resposta. :p aram int response_timeout_in_seconds: Intervalo máximo de tempo, em segundos, que o comando do duplo digital aguardará pela resposta. O valor tem de estar entre 5 e 300.

invoke_component_command

Invoque um comando num componente de um determinado dispositivo e obtenha o resultado do mesmo. :p aram str digital_twin__id: O ID duplo 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 do duplo digital aguardará a resposta. :p aram int response_timeout_in_seconds: Intervalo máximo de tempo, em segundos, que o comando do duplo digital aguardará pela resposta. O valor tem de estar entre 5 e 300. :type response_timeout_in_seconds: int

update_digital_twin

Atualize o Componente Duplo Digital de um determinado dispositivo com um objeto de patch. :p aram str digital_twin__id: O ID duplo digital do dispositivo especificado. :p aram list[object]: O objeto json-patch para atualizar o Digital Twin. :p aram str etag: o valor de etag (if_match) a utilizar para a operação de atualização.

from_connection_string

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

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

from_connection_string(connection_string)

Parâmetros

Name Description
connection_string
Necessário
str

A cadeia de ligação do IoTHub utilizada para autenticar a ligação com o IoTHub.

Devoluções

Tipo Description

from_token_credential

Inicializador classmethod para um cliente do Serviço DigitalTwinClient. Cria a classe DigitalTwinClient a partir do URL do nome do anfitrião e da credencial do token do Azure.

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

from_token_credential(url, token_credential)

Parâmetros

Name Description
url
Necessário
str

O URL do serviço do Azure (nome do anfitrião).

token_credential
Necessário
<xref:azure.core.TokenCredential>

O objeto de credencial do token do Azure

Devoluções

Tipo Description

get_digital_twin

Obtenha o Duplo Digital de um determinado dispositivo. :p aram str digital_twin__id: O ID duplo digital do dispositivo especificado.

get_digital_twin(digital_twin_id)

Parâmetros

Name Description
digital_twin_id
Necessário

Devoluções

Tipo Description

O objeto de retorno que contém o Digital Twin.

Exceções

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

invoke_command

Invoque um comando num determinado dispositivo e obtenha o resultado do mesmo. :p aram str digital_twin__id: O ID duplo 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 do duplo digital aguardará a resposta. :p aram int response_timeout_in_seconds: Intervalo máximo de tempo, em segundos, que o comando do duplo digital aguardará pela resposta. O valor tem de estar entre 5 e 300.

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

Parâmetros

Name Description
digital_twin_id
Necessário
command_name
Necessário
payload
Necessário
connect_timeout_in_seconds
valor predefinido: None
response_timeout_in_seconds
valor predefinido: None

Devoluções

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 num componente de um determinado dispositivo e obtenha o resultado do mesmo. :p aram str digital_twin__id: O ID duplo 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 do duplo digital aguardará a resposta. :p aram int response_timeout_in_seconds: Intervalo máximo de tempo, em segundos, que o comando do duplo digital aguardará pela resposta. O valor tem de estar entre 5 e 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

Name Description
digital_twin_id
Necessário
component_path
Necessário
command_name
Necessário
payload
Necessário
connect_timeout_in_seconds
valor predefinido: None
response_timeout_in_seconds
valor predefinido: None

Devoluções

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 Duplo Digital de um determinado dispositivo com um objeto de patch. :p aram str digital_twin__id: O ID duplo digital do dispositivo especificado. :p aram list[object]: O objeto json-patch para atualizar o Digital Twin. :p aram str etag: o valor de etag (if_match) a utilizar para a operação de atualização.

update_digital_twin(digital_twin_id, digital_twin_patch, etag=None)

Parâmetros

Name Description
digital_twin_id
Necessário
digital_twin_patch
Necessário
etag
valor predefinido: None

Devoluções

Tipo Description

O objeto de retorno que contém o Digital Twin atualizado.

Exceções

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