DigitalTwinsClient Clase

Crea una instancia del cliente de Digital Twins.

Herencia

builtins.object

DigitalTwinsClient

Constructor

DigitalTwinsClient(endpoint: str, credential: AsyncTokenCredential, **kwargs)

Parámetros

endpoint

str

Requerido

Punto de conexión de dirección URL de un servicio de Azure Search

credential

AsyncTokenCredential

Requerido

Una credencial para autenticar las solicitudes en el servicio.

Métodos

close
create_models	Cree uno o varios modelos. Cuando se produce algún error, no se carga ningún modelo.
decommission_model	Retira un modelo.
delete_digital_twin	Elimine un gemelo digital.
delete_event_route	Elimine una ruta de eventos.
delete_model	Elimine un modelo.
delete_relationship	Elimine una relación en un gemelo digital.
get_component	Obtenga un componente en un gemelo digital.
get_digital_twin	Obtenga un gemelo digital.
get_event_route	Obtenga una ruta de eventos.
get_model	Obtenga un modelo, incluidos los metadatos del modelo y la definición del modelo.
get_relationship	Obtener una relación en un gemelo digital.
list_event_routes	Recupera todas las rutas de eventos.
list_incoming_relationships	Recupere todas las relaciones entrantes de un gemelo digital.
list_models	Obtenga la lista de modelos.
list_relationships	Recupere las relaciones de un gemelo digital.
publish_component_telemetry	Publique la telemetría desde el componente de un gemelo digital, que luego se consume en uno o varios puntos de conexión de destino (suscriptores) definidos en.
publish_telemetry	Publique la telemetría desde un gemelo digital, que luego se consume en uno o varios puntos de conexión de destino (suscriptores) definidos en.
query_twins	Consulta de gemelos digitales. Nota: es posible que haya un retraso entre antes de que los cambios en la instancia se reflejen en las consultas. Para más información sobre las limitaciones de las consultas, consulte https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations
update_component	Actualice las propiedades de un componente en un gemelo digital mediante una revisión JSON.
update_digital_twin	Actualice un gemelo digital mediante una revisión JSON.
update_relationship	Novedades las propiedades de una relación en un gemelo digital mediante una revisión JSON.
upsert_digital_twin	Cree o actualice un gemelo digital.
upsert_event_route	Cree o actualice una ruta de eventos.
upsert_relationship	Cree o actualice una relación en un gemelo digital.

close

async close() -> None

create_models

Cree uno o varios modelos. Cuando se produce algún error, no se carga ningún modelo.

async create_models(dtdl_models: List[object], **kwargs) -> List[DigitalTwinsModelData]

Parámetros

model_list

List[object]

Requerido

Conjunto de modelos que se van a crear. Cada dict corresponde exactamente a un modelo.

Devoluciones

Lista de modelos creados

Tipo de valor devuelto

List[DigitalTwinsModelData]

Excepciones

HttpResponseError

ResourceExistsError

Ya existen uno o varios de los modelos proporcionados.

decommission_model

Retira un modelo.

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

Parámetros

model_id

str

Requerido

Identificador del modelo. El identificador es único global y distingue mayúsculas de minúsculas.

Devoluciones

Ninguno

Tipo de valor devuelto

None

Excepciones

HttpResponseError

ResourceNotFoundError

No hay ningún modelo con el identificador proporcionado.

delete_digital_twin

Elimine un gemelo digital.

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

Parámetros

digital_twin_id

str

Requerido

Identificador del gemelo digital.

match_condition

MatchConditions

Condición en la que se va a realizar la operación.

etag

str

Realice solo la operación si la etag de la entidad coincide con el valor proporcionado según el match_condition.

Devoluciones

None

Tipo de valor devuelto

None

Excepciones

HttpResponseError

ResourceNotFoundError

Si no hay ningún gemelo digital con el identificador proporcionado.

delete_event_route

Elimine una ruta de eventos.

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

Parámetros

event_route_id

str

Requerido

Identificador de la ruta de eventos que se va a eliminar.

Devoluciones

None

Tipo de valor devuelto

None

Excepciones

HttpResponseError

ResourceNotFoundError

No hay ninguna ruta de eventos con el identificador proporcionado.

delete_model

Elimine un modelo.

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

Parámetros

model_id

str

Requerido

Identificador del modelo que se va a eliminar.

Devoluciones

Ninguno

Tipo de valor devuelto

None

Excepciones

HttpResponseError

ResourceNotFoundError

No hay ningún modelo con el identificador proporcionado.

ResourceExistsError

Hay dependencias en el modelo que impiden que se eliminen.

delete_relationship

Elimine una relación en un gemelo digital.

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

Parámetros

digital_twin_id

str

Requerido

Identificador del gemelo digital.

relationship_id

str

Requerido

Identificador de la relación que se va a eliminar.

match_condition

MatchConditions

Condición en la que se va a realizar la operación.

etag

str

Realice solo la operación si la etag de la entidad coincide con el valor proporcionado según el match_condition.

Devoluciones

None

Tipo de valor devuelto

None

Excepciones

HttpResponseError

ResourceNotFoundError

Si no hay ningún gemelo digital o relación con el identificador proporcionado.

get_component

Obtenga un componente en un gemelo digital.

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

Parámetros

digital_twin_id

str

Requerido

Identificador del gemelo digital.

component_name

str

Requerido

Componente que se va a recuperar.

Devoluciones

Diccionario que contiene el componente.

Tipo de valor devuelto

Dict[str, object]

Excepciones

HttpResponseError

ResourceNotFoundError

Si no hay ningún gemelo digital con el identificador proporcionado o el nombre del componente no es válido.

get_digital_twin

Obtenga un gemelo digital.

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

Parámetros

digital_twin_id

str

Requerido

Identificador del gemelo digital.

Devoluciones

Diccionario que contiene el gemelo.

Tipo de valor devuelto

Dict[str, object]

Excepciones

HttpResponseError

ResourceNotFoundError

Si el gemelo digital no existe.

get_event_route

Obtenga una ruta de eventos.

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

Parámetros

event_route_id

str

Requerido

Identificador de la ruta de eventos.

Devoluciones

Objeto de ruta de eventos.

Tipo de valor devuelto

DigitalTwinsEventRoute

Excepciones

HttpResponseError

ResourceNotFoundError

No hay ninguna ruta de eventos con el identificador proporcionado.

get_model

Obtenga un modelo, incluidos los metadatos del modelo y la definición del modelo.

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

Parámetros

model_id

str

Requerido

Identificador del modelo.

include_model_definition

bool

Incluya la definición del modelo como parte del resultado. El valor predeterminado es False.

Devoluciones

Datos del modelo.

Tipo de valor devuelto

DigitalTwinsModelData

Excepciones

HttpResponseError

ResourceNotFoundError

Si no hay ningún modelo con el identificador proporcionado.

get_relationship

Obtener una relación en un gemelo digital.

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

Parámetros

digital_twin_id

str

Requerido

Identificador del gemelo digital.

relationship_id

str

Requerido

Identificador de la relación que se va a recuperar.

Devoluciones

Diccionario que contiene la relación.

Tipo de valor devuelto

Dict[str, object]

Excepciones

HttpResponseError

ResourceNotFoundError

Si no hay ningún gemelo digital o relación con el identificador proporcionado.

list_event_routes

Recupera todas las rutas de eventos.

list_event_routes(**kwargs) -> AsyncItemPaged[DigitalTwinsEventRoute]

Parámetros

results_per_page

int

Número máximo de elementos que se van a recuperar por solicitud. El servidor puede optar por devolver menos del máximo solicitado.

Devoluciones

Una instancia de iterador de rutas de eventos.

Tipo de valor devuelto

AsyncItemPaged[DigitalTwinsEventRoute]

Excepciones

HttpResponseError

list_incoming_relationships

Recupere todas las relaciones entrantes de un gemelo digital.

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

Parámetros

digital_twin_id

str

Requerido

Identificador del gemelo digital.

Devoluciones

Instancia de iterador de la lista de relaciones entrantes.

Tipo de valor devuelto

AsyncItemPaged[IncomingRelationship]

Excepciones

HttpResponseError

ResourceNotFoundError

Si no hay ningún gemelo digital con el identificador proporcionado.

list_models

Obtenga la lista de modelos.

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

Parámetros

dependencies_for

List[str]

Requerido

Identificadores de modelo para que se recuperen las dependencias. Si se omite, se recuperan todos los modelos.

include_model_definition

bool

Incluya la definición del modelo como parte de los resultados. El valor predeterminado es False.

results_per_page

int

Número máximo de elementos que se van a recuperar por solicitud. El servidor puede optar por devolver menos del máximo solicitado.

Devoluciones

Instancia de iterador de la lista de datos del modelo.

Tipo de valor devuelto

<xref:azure.core.paging.AsyncItemPaged>[DigitalTwinsModelData]

Excepciones

HttpResponseError

list_relationships

Recupere las relaciones de un gemelo digital.

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

Parámetros

digital_twin_id

str

Requerido

Identificador del gemelo digital.

relationship_id

str

Requerido

Identificador de la relación que se va a obtener (si Ninguno se recuperará toda la relación).

Devoluciones

Instancia de iterador de lista de relaciones.

Tipo de valor devuelto

AsyncItemPaged[Dict[str,object]]

Excepciones

HttpResponseError

ResourceNotFoundError

Si no hay ningún gemelo digital con el identificador proporcionado.

publish_component_telemetry

Publique la telemetría desde el componente de un gemelo digital, que luego se consume en uno o varios puntos de conexión de destino (suscriptores) definidos en.

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

Parámetros

digital_twin_id

str

Requerido

Identificador del gemelo digital.

component_name

str

Requerido

Nombre del componente DTDL.

telemetry

object

Requerido

Datos de telemetría que se van a enviar.

message_id

str

El id. del mensaje. Si no se especifica, se generará un UUID.

Devoluciones

None

Tipo de valor devuelto

None

Excepciones

HttpResponseError

ResourceNotFoundError

Si no hay ningún gemelo digital con el identificador proporcionado o el nombre del componente no es válido.

publish_telemetry

Publique la telemetría desde un gemelo digital, que luego se consume en uno o varios puntos de conexión de destino (suscriptores) definidos en.

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

Parámetros

digital_twin_id

str

Requerido

El identificador del gemelo digital

telemetry

object

Requerido

Datos de telemetría que se van a enviar

message_id

str

El id. del mensaje. Si no se especifica, se generará un UUID.

Devoluciones

None

Tipo de valor devuelto

None

Excepciones

HttpResponseError

ResourceNotFoundError

Si no hay ningún gemelo digital con el identificador proporcionado.

query_twins

Consulta de gemelos digitales.

Nota: es posible que haya un retraso entre antes de que los cambios en la instancia se reflejen en las consultas. Para más información sobre las limitaciones de las consultas, consulte https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations

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

Parámetros

query_expression

str

Requerido

Expresión de consulta que se va a ejecutar.

Devoluciones

Iterable de los resultados de la consulta.

Tipo de valor devuelto

AsyncItemPaged[Dict[str, object]]

Excepciones

HttpResponseError

update_component

Actualice las propiedades de un componente en un gemelo digital mediante una revisión JSON.

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

Parámetros

digital_twin_id

str

Requerido

Identificador del gemelo digital.

component_name

str

Requerido

Componente que se está actualizando.

json_patch

List[Dict[str,object]]

Requerido

Especificación de actualización descrita por la revisión JSON.

match_condition

MatchConditions

Condición en la que se va a realizar la operación.

etag

str

Realice solo la operación si la etag de la entidad coincide con el valor proporcionado según el match_condition.

Devoluciones

Ninguno

Tipo de valor devuelto

None

Excepciones

HttpResponseError

ResourceNotFoundError

Si no hay ningún gemelo digital con el identificador proporcionado o el nombre del componente no es válido.

update_digital_twin

Actualice un gemelo digital mediante una revisión JSON.

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

Parámetros

digital_twin_id

str

Requerido

Identificador del gemelo digital.

json_patch

List[Dict[str,object]]

Requerido

Especificación de actualización descrita por la revisión JSON. Novedades a los valores de propiedad y los elementos $model pueden producirse en la misma solicitud. Las operaciones se limitan a agregar, reemplazar y quitar.

match_condition

MatchConditions

Condición en la que se va a realizar la operación.

etag

str

Realice solo la operación si la etag de la entidad coincide con el valor proporcionado según el match_condition.

Devoluciones

None

Tipo de valor devuelto

None

Excepciones

HttpResponseError

ResourceNotFoundError

Si no hay ningún gemelo digital con el identificador proporcionado.

update_relationship

Novedades las propiedades de una relación en un gemelo digital mediante una revisión JSON.

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

Parámetros

digital_twin_id

str

Requerido

Identificador del gemelo digital.

relationship_id

str

Requerido

Identificador de la relación que se va a recuperar.

json_patch

List[Dict[str,object]]

Requerido

Descripción de la revisión JSON de la actualización a las propiedades de la relación.

match_condition

MatchConditions

Condición en la que se va a realizar la operación.

etag

str

Realice solo la operación si la etag de la entidad coincide con el valor proporcionado según el match_condition.

Devoluciones

Ninguno

Tipo de valor devuelto

None

Excepciones

HttpResponseError

ResourceNotFoundError

Si no hay ningún gemelo digital o relación con el identificador proporcionado.

upsert_digital_twin

Cree o actualice un gemelo digital.

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

Parámetros

digital_twin_id

str

Requerido

Identificador del gemelo digital.

digital_twin

Dict[str,object]

Requerido

Diccionario que contiene el gemelo que se va a crear o actualizar.

match_condition

MatchConditions

Condición en la que se va a realizar la operación.

etag

str

Realice solo la operación si la etag de la entidad coincide con el valor proporcionado según el match_condition.

Devoluciones

Diccionario que contiene el gemelo creado o actualizado.

Tipo de valor devuelto

Dict[str, object]

Excepciones

HttpResponseError

ResourceExistsError

Si el gemelo digital ya existe.

upsert_event_route

Cree o actualice una ruta de eventos.

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

Parámetros

event_route_id

str

Requerido

Identificador de la ruta de eventos que se va a crear o actualizar.

event_route

DigitalTwinsEventRoute

Requerido

Los datos de la ruta del evento.

Devoluciones

Ninguno

Tipo de valor devuelto

None

Excepciones

HttpResponseError

upsert_relationship

Cree o actualice una relación en un gemelo digital.

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

Parámetros

digital_twin_id

str

Requerido

Identificador del gemelo digital.

relationship_id

str

Requerido

Identificador de la relación que se va a recuperar.

relationship

Dict[str,object]

Requerido

Diccionario que contiene la relación.

match_condition

MatchConditions

Condición en la que se va a realizar la operación.

etag

str

Realice solo la operación si la etag de la entidad coincide con el valor proporcionado según el match_condition.

Devoluciones

Relación creada o actualizada.

Tipo de valor devuelto

Dict[str, object]

Excepciones

HttpResponseError

ResourceNotFoundError

Si no hay ningún gemelo digital, dirija el gemelo digital o la relación con el identificador proporcionado.