DigitalTwinsClient Classe

Cria um caso do cliente Digital Twins.

Herança

builtins.object

DigitalTwinsClient

Construtor

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

Parâmetros

endpoint

str

Necessário

O ponto final url de um serviço de pesquisa Azure

credential

TokenCredential

Necessário

Uma credencial para autenticar pedidos ao serviço

Métodos

create_models	Crie um ou mais modelos. Quando ocorre qualquer erro, não são carregados modelos.
decommission_model	Desativa um modelo.
delete_digital_twin	Apague um gémeo digital.
delete_event_route	Apague uma rota de eventos.
delete_model	Apague um modelo.
delete_relationship	Apagar uma relação com um gémeo digital.
get_component	Arranja um componente num gémeo digital.
get_digital_twin	Arranja um gémeo digital.
get_event_route	Faça uma rota de eventos.
get_model	Obtenha um modelo, incluindo os metadados-modelo e a definição do modelo.
get_relationship	Arranja uma relação com um gémeo digital.
list_event_routes	Recupera todas as rotas do evento.
list_incoming_relationships	Recupere todas as relações de entrada para um gémeo digital.
list_models	Pegue a lista de modelos.
list_relationships	Recupere relacionamentos para um gémeo digital.
publish_component_telemetry	Publique telemetria a partir de um componente de um twin digital, que é então consumido por um ou muitos pontos finais de destino (assinantes) definidos em.
publish_telemetry	Publique telemetria a partir de um gémeo digital, que é então consumido por um ou muitos pontos finais de destino (assinantes) definidos em.
query_twins	Consulta para gémeos digitais. Nota: que pode haver um atraso entre antes de as alterações no seu caso se refletirem em consultas. Para obter mais detalhes sobre as 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 num gémeo digital utilizando 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 com 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 eventos.
upsert_relationship	Criar ou atualizar uma relação num gémeo digital.

create_models

Crie um ou mais modelos. Quando ocorre qualquer erro, não são carregados modelos.

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

Parâmetros

model_list

List[Dict[str,object]]

Necessário

O conjunto de modelos para criar. Cada dict corresponde a exatamente um modelo.

Devoluções

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

Necessário

A identificação para o modelo. O ID é globalmente único e sensível a casos.

Devoluções

Nenhuma

Tipo de retorno

None

Exceções

HttpResponseError

ResourceNotFoundError

Não há modelo com a identificação fornecida.

delete_digital_twin

Apague um gémeo digital.

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

Parâmetros

digital_twin_id

str

Necessário

A identificação do gémeo digital.

match_condition

MatchConditions

A condição para realizar a operação.

etag

str

Só efetuar a operação se o etag da entidade corresponder ao valor fornecido de acordo com o match_condition.

Devoluções

Nenhuma

Tipo de retorno

None

Exceções

HttpResponseError

ResourceNotFoundError

Se não houver gémeo digital com a identificação fornecida.

delete_event_route

Apague uma rota de eventos.

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

Parâmetros

event_route_id

str

Necessário

O ID da rota do evento para eliminar.

Devoluções

Nenhuma

Tipo de retorno

None

Exceções

HttpResponseError

ResourceNotFoundError

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

delete_model

Apague um modelo.

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

Parâmetros

model_id

str

Necessário

A identificação do modelo para apagar.

Devoluções

Nenhuma

Tipo de retorno

None

Exceções

HttpResponseError

ResourceNotFoundError

Não há modelo com a identificação fornecida.

ResourceExistsError

Existem dependências do modelo que impedem que seja eliminado.

delete_relationship

Apagar uma relação com um gémeo digital.

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

Parâmetros

digital_twin_id

str

Necessário

A identificação do gémeo digital.

relationship_id

str

Necessário

A identificação da relação para apagar.

match_condition

MatchConditions

A condição para realizar a operação.

etag

str

Só efetuar a operação se o etag da entidade corresponder ao valor fornecido de acordo com o match_condition.

Devoluções

Nenhuma

Tipo de retorno

None

Exceções

HttpResponseError

ResourceNotFoundError

Se não houver gémeo digital ou relação com o ID fornecido.

get_component

Arranja um componente num gémeo digital.

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

Parâmetros

digital_twin_id

str

Necessário

A identificação do gémeo digital.

component_name

str

Necessário

O componente a ser recuperado.

Devoluções

Dicionário contendo o componente.

Tipo de retorno

Dict[str, object]

Exceções

HttpResponseError

ResourceNotFoundError

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

get_digital_twin

Arranja um gémeo digital.

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

Parâmetros

digital_twin_id

str

Necessário

A identificação do gémeo digital.

Devoluções

Dicionário contendo o gémeo.

Tipo de retorno

Dict[str, object]

Exceções

HttpResponseError

ResourceNotFoundError

Se o gémeo digital não existir.

get_event_route

Faça uma rota de eventos.

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

Parâmetros

event_route_id

str

Necessário

A identificação da rota do evento.

Devoluções

O objeto da rota do evento.

Tipo de retorno

DigitalTwinsEventRoute

Exceções

HttpResponseError

ResourceNotFoundError

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

get_model

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

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

Parâmetros

model_id

str

Necessário

A identificação do modelo.

include_model_definition

bool

Incluir a definição do modelo como parte do resultado. O valor predefinido é falso.

Devoluções

Os dados do modelo.

Tipo de retorno

DigitalTwinsModelData

Exceções

HttpResponseError

ResourceNotFoundError

Se não houver modelo com o ID fornecido.

get_relationship

Arranja uma relação com um gémeo digital.

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

Parâmetros

digital_twin_id

str

Necessário

A identificação do gémeo digital.

relationship_id

str

Necessário

A identificação da relação para recuperar.

Devoluções

Dicionário contendo a relação.

Tipo de retorno

Dict[str, object]

Exceções

HttpResponseError

ResourceNotFoundError

Se não houver gémeo digital ou relação com o ID fornecido.

list_event_routes

Recupera todas as rotas do evento.

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

Parâmetros

results_per_page

int

O número máximo de itens a recuperar por pedido. O servidor pode optar por devolver menos do que o máximo solicitado.

Devoluções

Uma ocorrência iterador de rotas de eventos.

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

Necessário

A identificação do gémeo digital.

Devoluções

Um iterador como um exemplo de qualquer relacionamento.

Tipo de retorno

ItemPaged[IncomingRelationship]

Exceções

HttpResponseError

ResourceNotFoundError

Se não houver gémeo digital com a identificação fornecida.

list_models

Pegue a lista de modelos.

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

Parâmetros

dependencies_for

List[str]

Necessário

O modelo identifica para ter dependências recuperadas. Se omitidos, todos os modelos são recuperados.

include_model_definition

bool

Incluir a definição do modelo como parte dos resultados. O valor predefinido é falso.

results_per_page

int

O número máximo de itens a recuperar por pedido. O servidor pode optar por devolver menos do que o máximo solicitado.

Devoluções

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

Tipo de retorno

ItemPaged[DigitalTwinsModelData]

Exceções

HttpResponseError

list_relationships

Recupere relacionamentos 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

Necessário

A identificação do gémeo digital.

relationship_id

str

Necessário

A ID da relação a obter (se nenhuma toda a relação será recuperada).

Devoluções

Uma instância iterador da lista de relacionamentos

Tipo de retorno

ItemPaged[Dict[str,object]]

Exceções

HttpResponseError

ResourceNotFoundError

Se não houver gémeo digital com a identificação fornecida.

publish_component_telemetry

Publique telemetria a partir de um componente de um twin digital, que é então consumido por um ou muitos pontos finais 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

Necessário

A identificação do gémeo digital.

component_name

str

Necessário

O nome do componente DTDL.

telemetry

object

Necessário

Os dados da telemetria a enviar.

message_id

str

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

Devoluções

Nenhuma

Tipo de retorno

None

Exceções

HttpResponseError

ResourceNotFoundError

Se não houver gémeos digitais com o ID fornecido ou o nome do componente for inválido.

publish_telemetry

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

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

Parâmetros

digital_twin_id

str

Necessário

A ID do gémeo digital

telemetry

object

Necessário

Os dados da telemetria a enviar

message_id

str

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

Devoluções

Nenhuma

Tipo de retorno

None

Exceções

HttpResponseError

ResourceNotFoundError

Se não houver gémeo digital com a identificação fornecida.

query_twins

Consulta para gémeos digitais.

Nota: que pode haver um atraso entre antes de as alterações no seu caso se refletirem em consultas. Para obter mais detalhes sobre as 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

Necessário

A expressão de consulta para executar.

Devoluções

Um iterável de resultados de consulta.

Tipo de retorno

ItemPaged[Dict[str, object]]

Exceções

HttpResponseError

update_component

Atualize as propriedades de um componente num gémeo digital utilizando 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

Necessário

A identificação do gémeo digital.

component_name

str

Necessário

O componente está a ser atualizado.

json_patch

List[Dict[str,object]]

Necessário

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

match_condition

MatchConditions

A condição para realizar a operação.

etag

str

Só efetuar a operação se o etag da entidade corresponder ao valor fornecido de acordo com o match_condition.

Devoluções

Nenhuma

Tipo de retorno

None

Exceções

HttpResponseError

ResourceNotFoundError

Se não houver nenhum gémeo digital com o ID fornecido 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

Necessário

A identificação do gémeo digital.

json_patch

List[Dict[str,object]]

Necessário

Uma especificação de atualização descrita pelo JSON Patch. Atualizações aos valores patrimoniais e elementos $model podem ocorrer no mesmo pedido. As operações são limitadas para adicionar, substituir e remover.

match_condition

MatchConditions

A condição para realizar a operação.

etag

str

Só efetuar a operação se o etag da entidade corresponder ao valor fornecido de acordo com o match_condition.

Devoluções

Nenhuma

Tipo de retorno

None

Exceções

HttpResponseError

ResourceNotFoundError

Se não houver gémeo digital com a identificação fornecida.

update_relationship

Atualizações as propriedades de uma relação com 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

Necessário

A identificação do gémeo digital.

relationship_id

str

Necessário

A identificação da relação para recuperar.

json_patch

List[Dict[str,object]]

Necessário

Descrição do Patch JSON da atualização às propriedades da relação.

match_condition

MatchConditions

A condição para realizar a operação.

etag

str

Só efetuar a operação se o etag da entidade corresponder ao valor fornecido de acordo com o match_condition.

Devoluções

Nenhuma

Tipo de retorno

None

Exceções

HttpResponseError

ResourceNotFoundError

Se não houver gémeo digital ou relação com o ID fornecido.

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

Necessário

A identificação do gémeo digital.

digital_twin

Dict[str,object]

Necessário

Dicionário contendo o gémeo para criar ou atualizar.

match_condition

MatchConditions

A condição para realizar a operação.

etag

str

Só efetuar a operação se o etag da entidade corresponder ao valor fornecido de acordo com o match_condition.

Devoluções

Dicionário contendo o gémeo criado ou atualizado.

Tipo de retorno

Dict[str, object]

Exceções

HttpResponseError

ResourceExistsError

Se o gémeo digital já existe.

upsert_event_route

Criar ou atualizar uma rota de eventos.

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

Parâmetros

event_route_id

str

Necessário

O ID da rota do evento para criar ou atualizar.

event_route

DigitalTwinsEventRoute

Necessário

Os dados da rota do evento.

Devoluções

Nenhuma

Tipo de retorno

None

Exceções

HttpResponseError

upsert_relationship

Criar ou atualizar uma relação num 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

Necessário

A identificação do gémeo digital.

relationship_id

str

Necessário

A identificação da relação para recuperar.

relationship

Dict[str,object]

Necessário

Dicionário contendo a relação.

match_condition

MatchConditions

A condição para realizar a operação.

etag

str

Só efetuar a operação se o etag da entidade corresponder ao valor fornecido de acordo com o match_condition.

Devoluções

A relação criada ou atualizada.

Tipo de retorno

Dict[str, object]

Exceções

HttpResponseError

ResourceNotFoundError

Se não houver gémeo digital, o gémeo digital alvo ou a relação com o ID fornecido.