你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

DigitalTwinsClient 类

创建数字孪生客户端的实例。

继承
builtins.object
DigitalTwinsClient

构造函数

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

参数

endpoint
str
必需

Azure 搜索服务的 URL 终结点

credential
TokenCredential
必需

用于对服务的请求进行身份验证的凭据

方法

create_models

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

decommission_model

解除模型授权。

delete_digital_twin

删除数字孪生体。

delete_event_route

删除事件路由。

delete_model

删除模型。

delete_relationship

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

get_component

获取数字孪生上的组件。

get_digital_twin

获取数字孪生体。

get_event_route

获取事件路由。

get_model

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

get_relationship

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

list_event_routes

检索所有事件路由。

list_incoming_relationships

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

list_models

获取模型列表。

list_relationships

检索数字孪生体的关系。

publish_component_telemetry

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

publish_telemetry

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

query_twins

查询数字孪生体。

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

update_component

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

update_digital_twin

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

update_relationship

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

upsert_digital_twin

创建或更新数字孪生体。

upsert_event_route

创建或更新事件路由。

upsert_relationship

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

create_models

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

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

参数

model_list
List[Dict[str,object]]
必需

要创建的模型集。 每个听写只对应于一个模型。

返回

已创建模型的列表。

返回类型

例外

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

decommission_model

解除模型授权。

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

参数

model_id
str
必需

模型的 ID。 ID 全局唯一且区分大小写。

返回

None

返回类型

例外

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

delete_digital_twin

删除数字孪生体。

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

参数

digital_twin_id
str
必需

数字孪生体的 ID。

match_condition
MatchConditions

执行操作的条件。

etag
str

仅当实体的 etag 与根据 match_condition提供的值匹配时,才执行操作。

返回

None

返回类型

例外

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

delete_event_route

删除事件路由。

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

参数

event_route_id
str
必需

要删除的事件路由的 ID。

返回

None

返回类型

例外

没有提供 ID 的事件路由。

delete_model

删除模型。

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

参数

model_id
str
必需

要删除的模型的 ID。

返回

None

返回类型

例外

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

模型存在依赖项,无法删除它。

delete_relationship

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

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

参数

digital_twin_id
str
必需

数字孪生体的 ID。

relationship_id
str
必需

要删除的关系的 ID。

match_condition
MatchConditions

执行操作的条件。

etag
str

仅当实体的 etag 与根据 match_condition提供的值匹配时,才执行操作。

返回

None

返回类型

例外

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

get_component

获取数字孪生上的组件。

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

参数

digital_twin_id
str
必需

数字孪生体的 ID。

component_name
str
必需

正在检索的组件。

返回

包含组件的字典。

返回类型

例外

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

get_digital_twin

获取数字孪生体。

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

参数

digital_twin_id
str
必需

数字孪生体的 ID。

返回

包含孪生体的字典。

返回类型

例外

如果数字孪生体不存在。

get_event_route

获取事件路由。

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

参数

event_route_id
str
必需

事件路由的 ID。

返回

事件路由对象。

返回类型

例外

没有提供 ID 的事件路由。

get_model

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

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

参数

model_id
str
必需

模型的 ID。

include_model_definition
bool

将模型定义包含在结果中。 默认值为 False。

返回

模型数据。

返回类型

例外

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

get_relationship

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

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

参数

digital_twin_id
str
必需

数字孪生体的 ID。

relationship_id
str
必需

要检索的关系的 ID。

返回

包含关系的字典。

返回类型

例外

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

list_event_routes

检索所有事件路由。

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

参数

results_per_page
int

每个请求要检索的最大项数。 服务器可以选择返回小于请求的最大值。

返回

事件路由的迭代器实例。

返回类型

例外

list_incoming_relationships

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

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

参数

digital_twin_id
str
必需

数字孪生体的 ID。

返回

一个迭代器,类似于任一关系的实例。

返回类型

例外

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

list_models

获取模型列表。

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

参数

dependencies_for
List[str]
必需

要检索依赖项的模型 ID。 如果省略,则检索所有模型。

include_model_definition
bool

将模型定义包含在结果中。 默认值为 False。

results_per_page
int

每个请求要检索的最大项数。 服务器可以选择返回小于请求的最大值。

返回

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

返回类型

例外

list_relationships

检索数字孪生体的关系。

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

参数

digital_twin_id
str
必需

数字孪生体的 ID。

relationship_id
str
必需

要获取 (的关系 ID(如果“无”)将在) 检索所有关系。

返回

关系列表的迭代器实例

返回类型

例外

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

publish_component_telemetry

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

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

参数

digital_twin_id
str
必需

数字孪生体的 ID。

component_name
str
必需

DTDL 组件的名称。

telemetry
object
必需

要发送的遥测数据。

message_id
str

消息 ID。 如果未指定,将生成 UUID。

返回

None

返回类型

例外

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

publish_telemetry

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

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

参数

digital_twin_id
str
必需

数字孪生体的 ID

telemetry
object
必需

要发送的遥测数据

message_id
str

消息 ID。 如果未指定,将生成 UUID。

返回

None

返回类型

例外

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

query_twins

查询数字孪生体。

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

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

参数

query_expression
str
必需

要执行的查询表达式。

返回

查询结果的可迭代。

返回类型

例外

update_component

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

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

参数

digital_twin_id
str
必需

数字孪生体的 ID。

component_name
str
必需

正在更新的组件。

json_patch
List[Dict[str,object]]
必需

JSON 修补程序描述的更新规范。

match_condition
MatchConditions

执行操作的条件。

etag
str

仅当实体的 etag 与根据 match_condition提供的值匹配时,才执行操作。

返回

None

返回类型

例外

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

update_digital_twin

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

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

参数

digital_twin_id
str
必需

数字孪生体的 ID。

json_patch
List[Dict[str,object]]
必需

JSON 修补程序描述的更新规范。 同一请求中可能会汇报属性值和$model元素。 操作仅限于 添加替换删除

match_condition
MatchConditions

执行操作的条件。

etag
str

仅当实体的 etag 与根据 match_condition提供的值匹配时,才执行操作。

返回

None

返回类型

例外

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

update_relationship

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

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

参数

digital_twin_id
str
必需

数字孪生体的 ID。

relationship_id
str
必需

要检索的关系的 ID。

json_patch
List[Dict[str,object]]
必需

关系属性更新的 JSON 修补程序说明。

match_condition
MatchConditions

执行操作的条件。

etag
str

仅当实体的 etag 与根据 match_condition提供的值匹配时,才执行操作。

返回

None

返回类型

例外

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

upsert_digital_twin

创建或更新数字孪生体。

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

参数

digital_twin_id
str
必需

数字孪生体的 ID。

digital_twin
Dict[str,object]
必需

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

match_condition
MatchConditions

执行操作的条件。

etag
str

仅当实体的 etag 与根据 match_condition提供的值匹配时,才执行操作。

返回

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

返回类型

例外

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

upsert_event_route

创建或更新事件路由。

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

参数

event_route_id
str
必需

要创建或更新的事件路由的 ID。

event_route
DigitalTwinsEventRoute
必需

事件路由数据。

返回

None

返回类型

例外

upsert_relationship

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

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

参数

digital_twin_id
str
必需

数字孪生体的 ID。

relationship_id
str
必需

要检索的关系的 ID。

relationship
Dict[str,object]
必需

包含关系的字典。

match_condition
MatchConditions

执行操作的条件。

etag
str

仅当实体的 etag 与根据 match_condition提供的值匹配时,才执行操作。

返回

创建或更新的关系。

返回类型

例外

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