DigitalTwinsClient Class
Creates an instance of the Digital Twins client.
- Inheritance
-
builtins.objectDigitalTwinsClient
Constructor
DigitalTwinsClient(endpoint: str, credential: AsyncTokenCredential, **kwargs)Parameters
Methods
| close | |
| create_models |
Create one or more models. When any error occurs, no models are uploaded. |
| decommission_model |
Decommissions a model. |
| delete_digital_twin |
Delete a digital twin. |
| delete_event_route |
Delete an event route. |
| delete_model |
Delete a model. |
| delete_relationship |
Delete a relationship on a digital twin. |
| get_component |
Get a component on a digital twin. |
| get_digital_twin |
Get a digital twin. |
| get_event_route |
Get an event route. |
| get_model |
Get a model, including the model metadata and the model definition. |
| get_relationship |
Get a relationship on a digital twin. |
| list_event_routes |
Retrieves all event routes. |
| list_incoming_relationships |
Retrieve all incoming relationships for a digital twin. |
| list_models |
Get the list of models. |
| list_relationships |
Retrieve relationships for a digital twin. |
| publish_component_telemetry |
Publish telemetry from a digital twin's component, which is then consumed by one or many destination endpoints (subscribers) defined under. |
| publish_telemetry |
Publish telemetry from a digital twin, which is then consumed by one or many destination endpoints (subscribers) defined under. |
| query_twins |
Query for digital twins. Note: that there may be a delay between before changes in your instance are reflected in queries. For more details on query limitations, see https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations |
| update_component |
Update properties of a component on a digital twin using a JSON patch. |
| update_digital_twin |
Update a digital twin using a JSON patch. |
| update_relationship |
Updates the properties of a relationship on a digital twin using a JSON patch. |
| upsert_digital_twin |
Create or update a digital twin. |
| upsert_event_route |
Create or update an event route. |
| upsert_relationship |
Create or update a relationship on a digital twin. |
close
async close() -> Nonecreate_models
Create one or more models. When any error occurs, no models are uploaded.
async create_models(dtdl_models: List[object], **kwargs) -> List[azure.digitaltwins.core._generated.models._models_py3.DigitalTwinsModelData]Parameters
- model_list
- <xref:List>[object]
The set of models to create. Each dict corresponds to exactly one model.
Returns
The list of created models
Return type
Exceptions
One or more of the provided models already exist.
decommission_model
Decommissions a model.
async decommission_model(model_id: str, **kwargs) -> NoneParameters
Returns
None
Return type
Exceptions
There is no model with the provided ID.
delete_digital_twin
Delete a digital twin.
async delete_digital_twin(digital_twin_id: str, **kwargs) -> NoneParameters
- match_condition
- MatchConditions
The condition under which to perform the operation.
- etag
- str
Only perform the operation if the entity's etag matches the value provided according to the match_condition.
Returns
None
Return type
Exceptions
If there is no digital twin with the provided ID.
delete_event_route
Delete an event route.
async delete_event_route(event_route_id: str, **kwargs) -> NoneParameters
Returns
None
Return type
Exceptions
There is no event route with the provided ID.
delete_model
Delete a model.
async delete_model(model_id: str, **kwargs) -> NoneParameters
Returns
None
Return type
Exceptions
There is no model with the provided ID.
There are dependencies on the model that prevent it from being deleted.
delete_relationship
Delete a relationship on a digital twin.
async delete_relationship(digital_twin_id: str, relationship_id: str, **kwargs) -> NoneParameters
- match_condition
- MatchConditions
The condition under which to perform the operation.
- etag
- str
Only perform the operation if the entity's etag matches the value provided according to the match_condition.
Returns
None
Return type
Exceptions
If there is either no digital twin or relationship with the provided ID.
get_component
Get a component on a digital twin.
async get_component(digital_twin_id: str, component_name: str, **kwargs) -> Dict[str, object]Parameters
Returns
Dictionary containing the component.
Return type
Exceptions
If there is either no digital twin with the provided ID or the component name is invalid.
get_digital_twin
Get a digital twin.
async get_digital_twin(digital_twin_id: str, **kwargs) -> Dict[str, object]Parameters
Returns
Dictionary containing the twin.
Return type
Exceptions
If the digital twin doesn't exist.
get_event_route
Get an event route.
async get_event_route(event_route_id: str, **kwargs) -> DigitalTwinsEventRouteParameters
Returns
The event route object.
Return type
Exceptions
There is no event route with the provided ID.
get_model
Get a model, including the model metadata and the model definition.
async get_model(model_id: str, **kwargs) -> azure.digitaltwins.core._generated.models._models_py3.DigitalTwinsModelDataParameters
- include_model_definition
- bool
Include the model definition as part of the result. The default value is False.
Returns
The model data.
Return type
Exceptions
If there is no model with the provided ID.
get_relationship
Get a relationship on a digital twin.
async get_relationship(digital_twin_id: str, relationship_id: str, **kwargs) -> Dict[str, object]Parameters
Returns
Dictionary containing the relationship.
Return type
Exceptions
If there is either no digital twin or relationship with the provided ID.
list_event_routes
Retrieves all event routes.
list_event_routes(**kwargs) -> azure.core.async_paging.AsyncItemPaged[DigitalTwinsEventRoute]Parameters
- results_per_page
- int
The maximum number of items to retrieve per request. The server may choose to return less than the requested max.
Returns
An iterator instance of event routes.
Return type
Exceptions
list_incoming_relationships
Retrieve all incoming relationships for a digital twin.
list_incoming_relationships(digital_twin_id: str, **kwargs) -> azure.core.async_paging.AsyncItemPaged[IncomingRelationship]Parameters
Returns
An iterator instance of list of incoming relationships.
Return type
Exceptions
If there is no digital twin with the provided ID.
list_models
Get the list of models.
list_models(dependencies_for: Optional[List[str]] = None, **kwargs) -> azure.core.async_paging.AsyncItemPaged[azure.digitaltwins.core._generated.models._models_py3.DigitalTwinsModelData]Parameters
- dependencies_for
- <xref:List>[str]
The model IDs to have dependencies retrieved. If omitted, all models are retrieved.
- include_model_definition
- bool
Include the model definition as part of the results. The default value is False.
- results_per_page
- int
The maximum number of items to retrieve per request. The server may choose to return less than the requested max.
Returns
An iterator instance of list of model data.
Return type
Exceptions
list_relationships
Retrieve relationships for a digital twin.
list_relationships(digital_twin_id: str, relationship_id: Optional[str] = None, **kwargs) -> azure.core.async_paging.AsyncItemPaged[Dict[str, object]]Parameters
- relationship_id
- str
The ID of the relationship to get (if None all the relationship will be retrieved).
Returns
An iterator instance of list of relationships.
Return type
Exceptions
If there is no digital twin with the provided ID.
publish_component_telemetry
Publish telemetry from a digital twin's component, which is then consumed by one or many destination endpoints (subscribers) defined under.
async publish_component_telemetry(digital_twin_id: str, component_name: str, telemetry: object, **kwargs) -> NoneParameters
- message_id
- str
The message ID. If not specified, a UUID will be generated.
Returns
None
Return type
Exceptions
If there is no digital twin with the provided ID or the component name is invalid.
publish_telemetry
Publish telemetry from a digital twin, which is then consumed by one or many destination endpoints (subscribers) defined under.
async publish_telemetry(digital_twin_id: str, telemetry: object, **kwargs) -> NoneParameters
- message_id
- str
The message ID. If not specified, a UUID will be generated.
Returns
None
Return type
Exceptions
If there is no digital twin with the provided ID.
query_twins
Query for digital twins.
Note: that there may be a delay between before changes in your instance are reflected in queries. For more details on query limitations, see https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations
query_twins(query_expression: str, **kwargs) -> azure.core.async_paging.AsyncItemPaged[Dict[str, object]]Parameters
Returns
An iterable of query results.
Return type
Exceptions
update_component
Update properties of a component on a digital twin using a JSON patch.
async update_component(digital_twin_id: str, component_name: str, json_patch: List[Dict[str, object]], **kwargs) -> NoneParameters
- json_patch
- <xref:List>[<xref:Dict>[<xref:str,object>]]
An update specification described by JSON Patch.
- match_condition
- MatchConditions
The condition under which to perform the operation.
- etag
- str
Only perform the operation if the entity's etag matches the value provided according to the match_condition.
Returns
None
Return type
Exceptions
If there is either no digital twin with the provided ID or the component name is invalid.
update_digital_twin
Update a digital twin using a JSON patch.
async update_digital_twin(digital_twin_id: str, json_patch: List[Dict[str, object]], **kwargs) -> NoneParameters
- json_patch
- <xref:List>[<xref:Dict>[<xref:str,object>]]
An update specification described by JSON Patch. Updates to property values and $model elements may happen in the same request. Operations are limited to add, replace and remove.
- match_condition
- MatchConditions
The condition under which to perform the operation.
- etag
- str
Only perform the operation if the entity's etag matches the value provided according to the match_condition.
Returns
None
Return type
Exceptions
If there is no digital twin with the provided ID.
update_relationship
Updates the properties of a relationship on a digital twin using a JSON patch.
async update_relationship(digital_twin_id: str, relationship_id: str, json_patch: List[Dict[str, object]], **kwargs) -> NoneParameters
- json_patch
- <xref:List>[<xref:Dict>[<xref:str,object>]]
JSON Patch description of the update to the relationship properties.
- match_condition
- MatchConditions
The condition under which to perform the operation.
- etag
- str
Only perform the operation if the entity's etag matches the value provided according to the match_condition.
Returns
None
Return type
Exceptions
If there is either no digital twin or relationship with the provided ID.
upsert_digital_twin
Create or update a digital twin.
async upsert_digital_twin(digital_twin_id: str, digital_twin: Dict[str, object], **kwargs) -> Dict[str, object]Parameters
- digital_twin
- <xref:Dict>[<xref:str,object>]
Dictionary containing the twin to create or update.
- match_condition
- MatchConditions
The condition under which to perform the operation.
- etag
- str
Only perform the operation if the entity's etag matches the value provided according to the match_condition.
Returns
Dictionary containing the created or updated twin.
Return type
Exceptions
If the digital twin already exists.
upsert_event_route
Create or update an event route.
async upsert_event_route(event_route_id: str, event_route: DigitalTwinsEventRoute, **kwargs) -> NoneParameters
Returns
None
Return type
Exceptions
upsert_relationship
Create or update a relationship on a digital twin.
async upsert_relationship(digital_twin_id: str, relationship_id: str, relationship: Dict[str, object], **kwargs) -> Dict[str, object]Parameters
- relationship
- <xref:Dict>[<xref:str,object>]
Dictionary containing the relationship.
- match_condition
- MatchConditions
The condition under which to perform the operation.
- etag
- str
Only perform the operation if the entity's etag matches the value provided according to the match_condition.
Returns
The created or updated relationship.
Return type
Exceptions
If there is either no digital twin, target digital twin or relationship with the provided ID.
Feedback
Submit and view feedback for