DigitalTwinsClient Classe

Cria uma instância do cliente gêmeos digitais.

Herança

builtins.object

DigitalTwinsClient

Construtor

DigitalTwinsClient(endpoint: str, credential: TokenCredential, **kwargs: Any)

Parâmetros

endpoint

str

Obrigatório

O ponto de extremidade de URL de um serviço de pesquisa do Azure

credential

TokenCredential

Obrigatório

Uma credencial para autenticar solicitações para o serviço

Métodos

create_models	Crie um ou mais modelos. Quando ocorre qualquer erro, nenhum modelo é carregado.
decommission_model	Desativa um modelo.
delete_digital_twin	Excluir um gêmeo digital.
delete_event_route	Excluir uma rota de evento.
delete_model	Exclua um modelo.
delete_relationship	Exclua uma relação em um gêmeo digital.
get_component	Obtenha um componente em um gêmeo digital.
get_digital_twin	Obtenha um gêmeo digital.
get_event_route	Obter uma rota de evento.
get_model	Obtenha um modelo, incluindo os metadados do modelo e a definição do modelo.
get_relationship	Obter um relacionamento em um gêmeo digital.
list_event_routes	Recupera todas as rotas de evento.
list_incoming_relationships	Recupere todas as relações de entrada para um gêmeo digital.
list_models	Obtenha a lista de modelos.
list_relationships	Recuperar relações para um gêmeo digital.
publish_component_telemetry	Publique a telemetria do componente de um gêmeo digital, que é então consumido por um ou muitos pontos de extremidade de destino (assinantes) definidos em.
publish_telemetry	Publique a telemetria de um gêmeo digital, que é consumida por um ou muitos pontos de extremidade de destino (assinantes) definidos em.
query_twins	Consultar gêmeos digitais. Observação: pode haver um atraso entre antes que as alterações em sua instância sejam refletidas em consultas. Para obter mais detalhes sobre limitações de consulta, consulte https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations
update_component	Atualize as propriedades de um componente em um gêmeo digital usando um patch JSON.
update_digital_twin	Atualize um gêmeo digital usando um patch JSON.
update_relationship	Atualizações as propriedades de uma relação em um gêmeo digital usando um patch JSON.
upsert_digital_twin	Criar ou atualizar um gêmeo digital.
upsert_event_route	Criar ou atualizar uma rota de evento.
upsert_relationship	Criar ou atualizar uma relação em um gêmeo digital.

create_models

Crie um ou mais modelos. Quando ocorre qualquer erro, nenhum modelo é carregado.

create_models(dtdl_models: List[Dict[str, object]], **kwargs: Any) -> List[DigitalTwinsModelData]

Parâmetros

model_list

List[Dict[str,object]]

Obrigatório

O conjunto de modelos a serem criados. Cada ditado corresponde a exatamente um modelo.

Retornos

A lista de modelos criados.

Tipo de retorno

List[DigitalTwinsModelData]

Exceções

HttpResponseError

ResourceExistsError

Um ou mais dos modelos fornecidos já existem.

decommission_model

Desativa um modelo.

decommission_model(model_id: str, **kwargs: Any) -> None

Parâmetros

model_id

str

Obrigatório

A ID do modelo. A ID é globalmente exclusiva e diferencia maiúsculas de minúsculas.

Retornos

Nenhum

Tipo de retorno

None

Exceções

HttpResponseError

ResourceNotFoundError

Não há nenhum modelo com a ID fornecida.

delete_digital_twin

Excluir um gêmeo digital.

delete_digital_twin(digital_twin_id: str, **kwargs: Any) -> None

Parâmetros

digital_twin_id

str

Obrigatório

A ID do gêmeo digital.

match_condition

MatchConditions

A condição sob a qual executar a operação.

etag

str

Execute a operação somente se a etag da entidade corresponder ao valor fornecido de acordo com o match_condition.

Retornos

Nenhum

Tipo de retorno

None

Exceções

HttpResponseError

ResourceNotFoundError

Se não houver nenhum gêmeo digital com a ID fornecida.

delete_event_route

Excluir uma rota de evento.

delete_event_route(event_route_id: str, **kwargs: Any) -> None

Parâmetros

event_route_id

str

Obrigatório

A ID da rota de evento a ser excluída.

Retornos

Nenhum

Tipo de retorno

None

Exceções

HttpResponseError

ResourceNotFoundError

Não há nenhuma rota de evento com a ID fornecida.

delete_model

Exclua um modelo.

delete_model(model_id: str, **kwargs: Any) -> None

Parâmetros

model_id

str

Obrigatório

A ID do modelo a ser excluído.

Retornos

Nenhum

Tipo de retorno

None

Exceções

HttpResponseError

ResourceNotFoundError

Não há nenhum modelo com a ID fornecida.

ResourceExistsError

Há dependências no modelo que impedem que ele seja excluído.

delete_relationship

Exclua uma relação em um gêmeo digital.

delete_relationship(digital_twin_id: str, relationship_id: str, **kwargs: Any) -> None

Parâmetros

digital_twin_id

str

Obrigatório

A ID do gêmeo digital.

relationship_id

str

Obrigatório

A ID da relação a ser excluída.

match_condition

MatchConditions

A condição sob a qual executar a operação.

etag

str

Execute a operação somente se a etag da entidade corresponder ao valor fornecido de acordo com o match_condition.

Retornos

Nenhum

Tipo de retorno

None

Exceções

HttpResponseError

ResourceNotFoundError

Se não houver nenhum gêmeo digital ou relação com a ID fornecida.

get_component

Obtenha um componente em um gêmeo digital.

get_component(digital_twin_id: str, component_name: str, **kwargs: Any) -> Dict[str, object]

Parâmetros

digital_twin_id

str

Obrigatório

A ID do gêmeo digital.

component_name

str

Obrigatório

O componente que está sendo recuperado.

Retornos

Dicionário que contém o componente.

Tipo de retorno

Dict[str, object]

Exceções

HttpResponseError

ResourceNotFoundError

Se não houver nenhum gêmeo digital com a ID fornecida ou o nome do componente for inválido.

get_digital_twin

Obtenha um gêmeo digital.

get_digital_twin(digital_twin_id: str, **kwargs: Any) -> Dict[str, object]

Parâmetros

digital_twin_id

str

Obrigatório

A ID do gêmeo digital.

Retornos

Dicionário que contém o gêmeo.

Tipo de retorno

Dict[str, object]

Exceções

HttpResponseError

ResourceNotFoundError

Se o gêmeo digital não existir.

get_event_route

Obter uma rota de evento.

get_event_route(event_route_id: str, **kwargs: Any) -> DigitalTwinsEventRoute

Parâmetros

event_route_id

str

Obrigatório

A ID da rota do evento.

Retornos

O objeto de rota de evento.

Tipo de retorno

DigitalTwinsEventRoute

Exceções

HttpResponseError

ResourceNotFoundError

Não há nenhuma rota de evento com a ID fornecida.

get_model

Obtenha um modelo, incluindo os metadados do modelo e a definição do modelo.

get_model(model_id: str, **kwargs: Any) -> DigitalTwinsModelData

Parâmetros

model_id

str

Obrigatório

A ID do modelo.

include_model_definition

bool

Inclua a definição de modelo como parte do resultado. O valor padrão é False.

Retornos

Os dados do modelo.

Tipo de retorno

DigitalTwinsModelData

Exceções

HttpResponseError

ResourceNotFoundError

Se não houver nenhum modelo com a ID fornecida.

get_relationship

Obter um relacionamento em um gêmeo digital.

get_relationship(digital_twin_id: str, relationship_id: str, **kwargs: Any) -> Dict[str, object]

Parâmetros

digital_twin_id

str

Obrigatório

A ID do gêmeo digital.

relationship_id

str

Obrigatório

A ID da relação a ser recuperada.

Retornos

Dicionário que contém a relação.

Tipo de retorno

Dict[str, object]

Exceções

HttpResponseError

ResourceNotFoundError

Se não houver nenhum gêmeo digital ou relação com a ID fornecida.

list_event_routes

Recupera todas as rotas de evento.

list_event_routes(**kwargs: Any) -> ItemPaged[DigitalTwinsEventRoute]

Parâmetros

results_per_page

int

O número máximo de itens a serem recuperados por solicitação. O servidor pode optar por retornar menos do que o máximo solicitado.

Retornos

Uma instância de iterador de rotas de evento.

Tipo de retorno

ItemPaged[DigitalTwinsEventRoute]

Exceções

HttpResponseError

list_incoming_relationships

Recupere todas as relações de entrada para um gêmeo digital.

list_incoming_relationships(digital_twin_id: str, **kwargs: Any) -> ItemPaged[IncomingRelationship]

Parâmetros

digital_twin_id

str

Obrigatório

A ID do gêmeo digital.

Retornos

Um iterador como uma instância de qualquer Relação.

Tipo de retorno

ItemPaged[IncomingRelationship]

Exceções

HttpResponseError

ResourceNotFoundError

Se não houver nenhum gêmeo digital com a ID fornecida.

list_models

Obtenha a lista de modelos.

list_models(dependencies_for: List[str] | None = None, **kwargs: Any) -> ItemPaged[DigitalTwinsModelData]

Parâmetros

dependencies_for

List[str]

Obrigatório

As IDs de modelo a serem recuperadas. Se for omitido, todos os modelos serão recuperados.

include_model_definition

bool

Inclua a definição de modelo como parte dos resultados. O valor padrão é False.

results_per_page

int

O número máximo de itens a serem recuperados por solicitação. O servidor pode optar por retornar menos do que o máximo solicitado.

Retornos

Uma instância do iterador da lista de dados do modelo.

Tipo de retorno

ItemPaged[DigitalTwinsModelData]

Exceções

HttpResponseError

list_relationships

Recuperar relações para um gêmeo digital.

list_relationships(digital_twin_id: str, relationship_id: str | None = None, **kwargs: Any) -> ItemPaged[Dict[str, object]]

Parâmetros

digital_twin_id

str

Obrigatório

A ID do gêmeo digital.

relationship_id

str

Obrigatório

A ID da relação a ser obtida (se Nenhuma, toda a relação será recuperada).

Retornos

Uma instância do iterador da lista de relações

Tipo de retorno

ItemPaged[Dict[str,object]]

Exceções

HttpResponseError

ResourceNotFoundError

Se não houver nenhum gêmeo digital com a ID fornecida.

publish_component_telemetry

Publique a telemetria do componente de um gêmeo digital, que é então consumido por um ou muitos pontos de extremidade de destino (assinantes) definidos em.

publish_component_telemetry(digital_twin_id: str, component_name: str, telemetry: object, **kwargs: Any) -> None

Parâmetros

digital_twin_id

str

Obrigatório

A ID do gêmeo digital.

component_name

str

Obrigatório

O nome do componente DTDL.

telemetry

object

Obrigatório

Os dados de telemetria a serem enviados.

message_id

str

A ID da mensagem. Se não for especificado, um UUID será gerado.

Retornos

Nenhum

Tipo de retorno

None

Exceções

HttpResponseError

ResourceNotFoundError

Se não houver nenhum gêmeo digital com a ID fornecida ou o nome do componente for inválido.

publish_telemetry

Publique a telemetria de um gêmeo digital, que é consumida por um ou muitos pontos de extremidade de destino (assinantes) definidos em.

publish_telemetry(digital_twin_id: str, telemetry: object, **kwargs: Any) -> None

Parâmetros

digital_twin_id

str

Obrigatório

A ID do gêmeo digital

telemetry

object

Obrigatório

Os dados de telemetria a serem enviados

message_id

str

A ID da mensagem. Se não for especificado, um UUID será gerado.

Retornos

Nenhum

Tipo de retorno

None

Exceções

HttpResponseError

ResourceNotFoundError

Se não houver nenhum gêmeo digital com a ID fornecida.

query_twins

Consultar gêmeos digitais.

Observação: pode haver um atraso entre antes que as alterações em sua instância sejam refletidas em consultas. Para obter mais detalhes sobre limitações de consulta, consulte https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations

query_twins(query_expression: str, **kwargs: Any) -> ItemPaged[Dict[str, object]]

Parâmetros

query_expression

str

Obrigatório

A expressão de consulta a ser executada.

Retornos

Uma iterável dos resultados da consulta.

Tipo de retorno

ItemPaged[Dict[str, object]]

Exceções

HttpResponseError

update_component

Atualize as propriedades de um componente em um gêmeo digital usando um patch JSON.

update_component(digital_twin_id: str, component_name: str, json_patch: List[Dict[str, object]], **kwargs: Any) -> None

Parâmetros

digital_twin_id

str

Obrigatório

A ID do gêmeo digital.

component_name

str

Obrigatório

O componente que está sendo atualizado.

json_patch

List[Dict[str,object]]

Obrigatório

Uma especificação de atualização descrita pelo Patch JSON.

match_condition

MatchConditions

A condição sob a qual executar a operação.

etag

str

Execute a operação somente se a etag da entidade corresponder ao valor fornecido de acordo com o match_condition.

Retornos

Nenhum

Tipo de retorno

None

Exceções

HttpResponseError

ResourceNotFoundError

Se não houver nenhum gêmeo digital com a ID fornecida ou o nome do componente for inválido.

update_digital_twin

Atualize um gêmeo digital usando um patch JSON.

update_digital_twin(digital_twin_id: str, json_patch: List[Dict[str, object]], **kwargs: Any) -> None

Parâmetros

digital_twin_id

str

Obrigatório

A ID do gêmeo digital.

json_patch

List[Dict[str,object]]

Obrigatório

Uma especificação de atualização descrita pelo Patch JSON. Atualizações a valores de propriedade e elementos $model podem ocorrer na mesma solicitação. As operações são limitadas para adicionar, substituir e remover.

match_condition

MatchConditions

A condição sob a qual executar a operação.

etag

str

Execute a operação somente se a etag da entidade corresponder ao valor fornecido de acordo com o match_condition.

Retornos

Nenhum

Tipo de retorno

None

Exceções

HttpResponseError

ResourceNotFoundError

Se não houver nenhum gêmeo digital com a ID fornecida.

update_relationship

Atualizações as propriedades de uma relação em um gêmeo digital usando um patch JSON.

update_relationship(digital_twin_id: str, relationship_id: str, json_patch: List[Dict[str, object]], **kwargs: Any) -> None

Parâmetros

digital_twin_id

str

Obrigatório

A ID do gêmeo digital.

relationship_id

str

Obrigatório

A ID da relação a ser recuperada.

json_patch

List[Dict[str,object]]

Obrigatório

Descrição do patch JSON da atualização para as propriedades da relação.

match_condition

MatchConditions

A condição sob a qual executar a operação.

etag

str

Execute a operação somente se a etag da entidade corresponder ao valor fornecido de acordo com o match_condition.

Retornos

Nenhum

Tipo de retorno

None

Exceções

HttpResponseError

ResourceNotFoundError

Se não houver nenhum gêmeo digital ou relação com a ID fornecida.

upsert_digital_twin

Criar ou atualizar um gêmeo digital.

upsert_digital_twin(digital_twin_id: str, digital_twin: Dict[str, object], **kwargs: Any) -> Dict[str, object]

Parâmetros

digital_twin_id

str

Obrigatório

A ID do gêmeo digital.

digital_twin

Dict[str,object]

Obrigatório

Dicionário que contém o gêmeo a ser criado ou atualizado.

match_condition

MatchConditions

A condição sob a qual executar a operação.

etag

str

Execute a operação somente se a etag da entidade corresponder ao valor fornecido de acordo com o match_condition.

Retornos

Dicionário que contém o gêmeo criado ou atualizado.

Tipo de retorno

Dict[str, object]

Exceções

HttpResponseError

ResourceExistsError

Se o gêmeo digital já existir.

upsert_event_route

Criar ou atualizar uma rota de evento.

upsert_event_route(event_route_id: str, event_route: DigitalTwinsEventRoute, **kwargs: Any) -> None

Parâmetros

event_route_id

str

Obrigatório

A ID da rota de evento a ser criada ou atualizada.

event_route

DigitalTwinsEventRoute

Obrigatório

Os dados de rota de evento.

Retornos

Nenhum

Tipo de retorno

None

Exceções

HttpResponseError

upsert_relationship

Criar ou atualizar uma relação em um gêmeo digital.

upsert_relationship(digital_twin_id: str, relationship_id: str, relationship: Dict[str, object], **kwargs: Any) -> Dict[str, object]

Parâmetros

digital_twin_id

str

Obrigatório

A ID do gêmeo digital.

relationship_id

str

Obrigatório

A ID da relação a ser recuperada.

relationship

Dict[str,object]

Obrigatório

Dicionário que contém a relação.

match_condition

MatchConditions

A condição sob a qual executar a operação.

etag

str

Execute a operação somente se a etag da entidade corresponder ao valor fornecido de acordo com o match_condition.

Retornos

A relação criada ou atualizada.

Tipo de retorno

Dict[str, object]

Exceções

HttpResponseError

ResourceNotFoundError

Se não houver nenhum gêmeo digital, direcione o gêmeo digital ou a relação com a ID fornecida.