DigitalTwinsClient 类

async close() -> None

创建一个或多个模型。 发生任何错误时，不会上传任何模型。

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

参数

返回

已创建模型的列表

返回类型

例外

提供的一个或多个模型已存在。

解除模型授权。

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

参数

返回

无

返回类型

例外

没有具有提供的 ID 的模型。

删除数字孪生体。

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

参数

返回

无

返回类型

例外

如果没有具有所提供 ID 的数字孪生体。

删除事件路由。

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

参数

返回

无

返回类型

例外

没有提供 ID 的事件路由。

删除模型。

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

参数

返回

无

返回类型

例外

没有具有提供的 ID 的模型。

模型存在依赖项，导致模型无法删除。

删除数字孪生体上的关系。

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

参数

返回

无

返回类型

例外

如果没有数字孪生体或与所提供的 ID 的关系。

获取数字孪生体的组件。

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

参数

返回

包含组件的字典。

返回类型

例外

如果没有提供 ID 的数字孪生体，或者组件名称无效。

获取数字孪生体。

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

参数

返回

包含孪生体的字典。

返回类型

例外

如果数字孪生体不存在。

获取事件路由。

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

参数

返回

事件路由对象。

返回类型

例外

没有提供 ID 的事件路由。

获取模型，包括模型元数据和模型定义。

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

参数

返回

模型数据。

返回类型

例外

如果没有具有提供的 ID 的模型。

在数字孪生体上获取关系。

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

参数

返回

包含关系的字典。

返回类型

例外

如果没有数字孪生体或与所提供的 ID 的关系。

检索所有事件路由。

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

参数

返回

事件路由的迭代器实例。

返回类型

例外

检索数字孪生体的所有传入关系。

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

参数

返回

传入关系列表的迭代器实例。

返回类型

例外

如果没有具有所提供 ID 的数字孪生体。

获取模型列表。

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

参数

返回

模型数据列表的迭代器实例。

返回类型

例外

检索数字孪生体的关系。

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

参数

返回

关系列表的迭代器实例。

返回类型

例外

如果没有具有所提供 ID 的数字孪生体。

发布来自数字孪生组件的遥测数据，然后由一个或多个目标终结点使用， () 定义订阅者。

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

参数

返回

无

返回类型

例外

如果没有具有所提供 ID 的数字孪生体，或者组件名称无效。

从数字孪生体发布遥测数据，然后由一个或多个目标终结点 (定义) 订阅者使用。

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

参数

返回

无

返回类型

例外

如果没有具有所提供 ID 的数字孪生体。

查询数字孪生体。

注意：在实例中的更改反映在查询中之前，可能存在延迟。 有关查询限制的更多详细信息，请参阅 https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations

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

参数

返回

查询结果的可迭代。

返回类型

例外

使用 JSON 修补程序更新数字孪生上的组件属性。

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

参数

返回

无

返回类型

例外

如果没有提供 ID 的数字孪生体，或者组件名称无效。

使用 JSON 修补程序更新数字孪生体。

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

参数

返回

无

返回类型

例外

如果没有提供 ID 的数字孪生体。

使用 JSON 修补程序汇报数字孪生体上关系的属性。

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

参数

返回

无

返回类型

例外

如果没有数字孪生体或与所提供的 ID 的关系。

创建或更新数字孪生体。

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

参数

返回

包含已创建或更新的孪生体的字典。

返回类型

例外

如果数字孪生体已存在，则为 。

创建或更新事件路由。

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

参数

返回

无

返回类型

例外

在数字孪生体上创建或更新关系。

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

参数

返回

创建或更新的关系。

返回类型

例外

如果没有数字孪生体，则面向数字孪生体或与所提供的 ID 的关系。