DigitalTwinsClient Clase
Crea una instancia del cliente de Digital Twins.
- Herencia
-
builtins.objectDigitalTwinsClient
Constructor
DigitalTwinsClient(endpoint: str, credential: TokenCredential, **kwargs: Any)Parámetros
Métodos
| create_models |
Cree uno o varios modelos. Cuando se produce cualquier error, no se carga ningún modelo. |
| decommission_model |
Retira un modelo. |
| delete_digital_twin |
Elimine un gemelo digital. |
| delete_event_route |
Elimina una ruta de eventos. |
| delete_model |
Elimine un modelo. |
| delete_relationship |
Elimine una relación en un gemelo digital. |
| get_component |
Obtener un componente en un gemelo digital. |
| get_digital_twin |
Obtenga un gemelo digital. |
| get_event_route |
Obtener 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 usa 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. |
create_models
Cree uno o varios modelos. Cuando se produce cualquier error, no se carga ningún modelo.
create_models(dtdl_models: List[Dict[str, object]], **kwargs: Any) -> List[DigitalTwinsModelData]Parámetros
Conjunto de modelos que se van a crear. Cada dict corresponde exactamente a un modelo.
Devoluciones
Lista de modelos creados.
Tipo de valor devuelto
Excepciones
Ya existen uno o varios de los modelos proporcionados.
decommission_model
Retira un modelo.
decommission_model(model_id: str, **kwargs: Any) -> NoneParámetros
- model_id
- str
Identificador del modelo. El identificador distingue mayúsculas de minúsculas y únicos globalmente.
Devoluciones
None
Tipo de valor devuelto
Excepciones
No hay ningún modelo con el identificador proporcionado.
delete_digital_twin
Elimine un gemelo digital.
delete_digital_twin(digital_twin_id: str, **kwargs: Any) -> NoneParámetros
- match_condition
- MatchConditions
Condición en la que se va a realizar la operación.
- etag
- str
Realice solo la operación si la etiqueta electrónica de la entidad coincide con el valor proporcionado según el match_condition.
Devoluciones
None
Tipo de valor devuelto
Excepciones
Si no hay ningún gemelo digital con el identificador proporcionado.
delete_event_route
Elimina una ruta de eventos.
delete_event_route(event_route_id: str, **kwargs: Any) -> NoneParámetros
Devoluciones
None
Tipo de valor devuelto
Excepciones
No hay ninguna ruta de eventos con el identificador proporcionado.
delete_model
Elimine un modelo.
delete_model(model_id: str, **kwargs: Any) -> NoneParámetros
Devoluciones
None
Tipo de valor devuelto
Excepciones
No hay ningún modelo con el identificador proporcionado.
Hay dependencias en el modelo que impiden que se elimine.
delete_relationship
Elimine una relación en un gemelo digital.
delete_relationship(digital_twin_id: str, relationship_id: str, **kwargs: Any) -> NoneParámetros
- match_condition
- MatchConditions
Condición en la que se va a realizar la operación.
- etag
- str
Realice solo la operación si la etiqueta electrónica de la entidad coincide con el valor proporcionado según el match_condition.
Devoluciones
None
Tipo de valor devuelto
Excepciones
Si no hay ningún gemelo digital o relación con el identificador proporcionado.
get_component
Obtener un componente en un gemelo digital.
get_component(digital_twin_id: str, component_name: str, **kwargs: Any) -> Dict[str, object]Parámetros
Devoluciones
Diccionario que contiene el componente.
Tipo de valor devuelto
Excepciones
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.
get_digital_twin(digital_twin_id: str, **kwargs: Any) -> Dict[str, object]Parámetros
Devoluciones
Diccionario que contiene el gemelo.
Tipo de valor devuelto
Excepciones
Si el gemelo digital no existe.
get_event_route
Obtener una ruta de eventos.
get_event_route(event_route_id: str, **kwargs: Any) -> DigitalTwinsEventRouteParámetros
Devoluciones
Objeto de ruta de eventos.
Tipo de valor devuelto
Excepciones
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.
get_model(model_id: str, **kwargs: Any) -> DigitalTwinsModelDataParámetros
- 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
Excepciones
Si no hay ningún modelo con el identificador proporcionado.
get_relationship
Obtener una relación en un gemelo digital.
get_relationship(digital_twin_id: str, relationship_id: str, **kwargs: Any) -> Dict[str, object]Parámetros
Devoluciones
Diccionario que contiene la relación.
Tipo de valor devuelto
Excepciones
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: Any) -> ItemPaged[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
Excepciones
list_incoming_relationships
Recupere todas las relaciones entrantes de un gemelo digital.
list_incoming_relationships(digital_twin_id: str, **kwargs: Any) -> ItemPaged[IncomingRelationship]Parámetros
Devoluciones
Iterador como una instancia de cualquiera de las relaciones.
Tipo de valor devuelto
Excepciones
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: Any) -> ItemPaged[DigitalTwinsModelData]Parámetros
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
Excepciones
list_relationships
Recupere las relaciones de un gemelo digital.
list_relationships(digital_twin_id: str, relationship_id: str | None = None, **kwargs: Any) -> ItemPaged[Dict[str, object]]Parámetros
- relationship_id
- str
El identificador de la relación que se va a obtener (si No se recuperará toda la relación).
Devoluciones
Una instancia de iterador de la lista de relaciones
Tipo de valor devuelto
Excepciones
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 usa en uno o varios puntos de conexión de destino (suscriptores) definidos en .
publish_component_telemetry(digital_twin_id: str, component_name: str, telemetry: object, **kwargs: Any) -> NoneParámetros
- message_id
- str
El id. del mensaje. Si no se especifica, se generará un UUID.
Devoluciones
None
Tipo de valor devuelto
Excepciones
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.
publish_telemetry(digital_twin_id: str, telemetry: object, **kwargs: Any) -> NoneParámetros
- message_id
- str
El id. del mensaje. Si no se especifica, se generará un UUID.
Devoluciones
None
Tipo de valor devuelto
Excepciones
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: Any) -> ItemPaged[Dict[str, object]]Parámetros
Devoluciones
Iterable de los resultados de la consulta.
Tipo de valor devuelto
Excepciones
update_component
Actualice las propiedades de un componente en un gemelo digital mediante una revisión JSON.
update_component(digital_twin_id: str, component_name: str, json_patch: List[Dict[str, object]], **kwargs: Any) -> NoneParámetros
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
None
Tipo de valor devuelto
Excepciones
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.
update_digital_twin(digital_twin_id: str, json_patch: List[Dict[str, object]], **kwargs: Any) -> NoneParámetros
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
Excepciones
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.
update_relationship(digital_twin_id: str, relationship_id: str, json_patch: List[Dict[str, object]], **kwargs: Any) -> NoneParámetros
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
None
Tipo de valor devuelto
Excepciones
Si no hay ningún gemelo digital o relación con el identificador proporcionado.
upsert_digital_twin
Cree o actualice un gemelo digital.
upsert_digital_twin(digital_twin_id: str, digital_twin: Dict[str, object], **kwargs: Any) -> Dict[str, object]Parámetros
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
Excepciones
Si el gemelo digital ya existe.
upsert_event_route
Cree o actualice una ruta de eventos.
upsert_event_route(event_route_id: str, event_route: DigitalTwinsEventRoute, **kwargs: Any) -> NoneParámetros
Devoluciones
None
Tipo de valor devuelto
Excepciones
upsert_relationship
Cree o actualice una relación en un gemelo digital.
upsert_relationship(digital_twin_id: str, relationship_id: str, relationship: Dict[str, object], **kwargs: Any) -> Dict[str, object]Parámetros
- 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
Excepciones
Si no hay ningún gemelo digital, dirija el gemelo digital o la relación con el identificador proporcionado.
Azure SDK for Python