DigitalTwinsClient 類別

建立 Digital Twins 用戶端的實例。

繼承

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]]

必要

要建立的一組模型。 每個聽寫都對應至一個模型。

傳回

已建立的模型清單。

傳回類型

List[DigitalTwinsModelData]

例外狀況

HttpResponseError

ResourceExistsError

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

decommission_model

解除委任模型。

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

參數

model_id

str

必要

模型的識別碼。 識別碼是全域唯一且區分大小寫。

傳回

None

傳回類型

None

例外狀況

HttpResponseError

ResourceNotFoundError

沒有具有所提供識別碼的模型。

delete_digital_twin

刪除數位對應項。

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

參數

digital_twin_id

str

必要

數位對應項的識別碼。

match_condition

MatchConditions

要在其中執行作業的條件。

etag

str

只有在實體的 etag 符合根據 match_condition提供的值時，才會執行作業。

傳回

None

傳回類型

None

例外狀況

HttpResponseError

ResourceNotFoundError

如果沒有具有所提供識別碼的數位對應項。

delete_event_route

刪除事件路由。

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

參數

event_route_id

str

必要

要刪除之事件路由的識別碼。

傳回

None

傳回類型

None

例外狀況

HttpResponseError

ResourceNotFoundError

沒有具有所提供識別碼的事件路由。

delete_model

刪除模型。

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

參數

model_id

str

必要

要刪除之模型的識別碼。

傳回

None

傳回類型

None

例外狀況

HttpResponseError

ResourceNotFoundError

沒有具有所提供識別碼的模型。

ResourceExistsError

模型有一個相依性，可防止它遭到刪除。

delete_relationship

刪除數位對應項上的關聯性。

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

參數

digital_twin_id

str

必要

數位對應項的識別碼。

relationship_id

str

必要

要刪除之關聯性的識別碼。

match_condition

MatchConditions

要在其中執行作業的條件。

etag

str

只有在實體的 etag 符合根據 match_condition提供的值時，才會執行作業。

傳回

None

傳回類型

None

例外狀況

HttpResponseError

ResourceNotFoundError

如果沒有數位對應項或與所提供識別碼的關聯性。

get_component

取得數位對應項上的元件。

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

參數

digital_twin_id

str

必要

數位對應項的識別碼。

component_name

str

必要

正在擷取的元件。

傳回

包含元件的字典。

傳回類型

Dict[str, object]

例外狀況

HttpResponseError

ResourceNotFoundError

如果沒有具有所提供識別碼的數位對應項，或元件名稱無效。

get_digital_twin

取得數位對應項。

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

參數

digital_twin_id

str

必要

數位對應項的識別碼。

傳回

包含對應項的字典。

傳回類型

Dict[str, object]

例外狀況

HttpResponseError

ResourceNotFoundError

如果數位對應項不存在。

get_event_route

取得事件路由。

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

參數

event_route_id

str

必要

事件路由的識別碼。

傳回

事件路由物件。

傳回類型

DigitalTwinsEventRoute

例外狀況

HttpResponseError

ResourceNotFoundError

沒有具有所提供識別碼的事件路由。

get_model

取得模型，包括模型中繼資料和模型定義。

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

參數

model_id

str

必要

模型的識別碼。

include_model_definition

bool

將模型定義納入結果的一部分。 預設值是 False。

傳回

模型資料。

傳回類型

DigitalTwinsModelData

例外狀況

HttpResponseError

ResourceNotFoundError

如果沒有具有所提供識別碼的模型。

get_relationship

取得數位對應項上的關聯性。

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

參數

digital_twin_id

str

必要

數位對應項的識別碼。

relationship_id

str

必要

要擷取之關聯性的識別碼。

傳回

包含關聯性的字典。

傳回類型

Dict[str, object]

例外狀況

HttpResponseError

ResourceNotFoundError

如果沒有數位對應項或與所提供識別碼的關聯性。

list_event_routes

擷取所有事件路由。

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

參數

results_per_page

int

每個要求要擷取的專案數目上限。 伺服器可以選擇傳回小於要求的最大值。

傳回

事件路由的反覆運算器實例。

傳回類型

ItemPaged[DigitalTwinsEventRoute]

例外狀況

HttpResponseError

list_incoming_relationships

擷取數位對應項的所有傳入關聯性。

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

參數

digital_twin_id

str

必要

數位對應項的識別碼。

傳回

反覆運算器，例如任一 Relationship 的實例。

傳回類型

ItemPaged[IncomingRelationship]

例外狀況

HttpResponseError

ResourceNotFoundError

如果沒有具有所提供識別碼的數位對應項。

list_models

取得模型清單。

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

參數

dependencies_for

List[str]

必要

要擷取相依性的模型識別碼。 如果省略，則會擷取所有模型。

include_model_definition

bool

在結果中包含模型定義。 預設值是 False。

results_per_page

int

每個要求要擷取的專案數目上限。 伺服器可以選擇傳回小於要求的最大值。

傳回

模型資料清單的反覆運算器實例。

傳回類型

ItemPaged[DigitalTwinsModelData]

例外狀況

HttpResponseError

list_relationships

擷取數位對應項的關聯性。

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

參數

digital_twin_id

str

必要

數位對應項的識別碼。

relationship_id

str

必要

如果未擷取所有關聯性，則會) 擷取所有關聯性的關聯性識別碼 (。

傳回

關聯性清單的反覆運算器實例

傳回類型

ItemPaged[Dict[str,object]]

例外狀況

HttpResponseError

ResourceNotFoundError

如果沒有具有所提供識別碼的數位對應項。

publish_component_telemetry

從數位對應項的元件發佈遙測，然後由一或多個目的地端點取用， (訂閱者) 定義。

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

參數

digital_twin_id

str

必要

數位對應項的識別碼。

component_name

str

必要

DTDL 元件的名稱。

telemetry

object

必要

要傳送的遙測資料。

message_id

str

訊息 ID。 如果未指定，則會產生 UUID。

傳回

None

傳回類型

None

例外狀況

HttpResponseError

ResourceNotFoundError

如果沒有具有所提供識別碼的數位對應項，或元件名稱無效。

publish_telemetry

從數位對應項發佈遙測，然後由一或多個目的地端點取用， (定義于下方的訂閱者) 。

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

參數

digital_twin_id

str

必要

數位對應項的識別碼

telemetry

object

必要

要傳送的遙測資料

message_id

str

訊息 ID。 如果未指定，則會產生 UUID。

傳回

None

傳回類型

None

例外狀況

HttpResponseError

ResourceNotFoundError

如果沒有具有所提供識別碼的數位對應項。

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

必要

要執行的查詢運算式。

傳回

可反覆運算的查詢結果。

傳回類型

ItemPaged[Dict[str, object]]

例外狀況

HttpResponseError

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

必要

數位對應項的識別碼。

component_name

str

必要

正在更新的元件。

json_patch

List[Dict[str,object]]

必要

JSON 修補程式所描述的更新規格。

match_condition

MatchConditions

要在其中執行作業的條件。

etag

str

只有在實體的 etag 符合根據 match_condition提供的值時，才執行作業。

傳回

None

傳回類型

None

例外狀況

HttpResponseError

ResourceNotFoundError

如果沒有具有所提供識別碼的數位對應項，或元件名稱無效。

update_digital_twin

使用 JSON 修補程式更新數位對應項。

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

參數

digital_twin_id

str

必要

數位對應項的識別碼。

json_patch

List[Dict[str,object]]

必要

JSON 修補程式所描述的更新規格。 更新屬性值和$model元素可能會在相同的要求中發生。 作業僅限於 新增、 取代 和 移除。

match_condition

MatchConditions

要在其中執行作業的條件。

etag

str

只有在實體的 etag 符合根據 match_condition提供的值時，才執行作業。

傳回

None

傳回類型

None

例外狀況

HttpResponseError

ResourceNotFoundError

如果沒有具有所提供識別碼的數位對應項。

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

必要

數位對應項的識別碼。

relationship_id

str

必要

要擷取之關聯性的識別碼。

json_patch

List[Dict[str,object]]

必要

關聯性屬性更新的 JSON 修補程式描述。

match_condition

MatchConditions

要在其中執行作業的條件。

etag

str

只有在實體的 etag 符合根據 match_condition提供的值時，才執行作業。

傳回

None

傳回類型

None

例外狀況

HttpResponseError

ResourceNotFoundError

如果沒有數位對應項或與所提供識別碼的關聯性。

upsert_digital_twin

建立或更新數位對應項。

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

參數

digital_twin_id

str

必要

數位對應項的識別碼。

digital_twin

Dict[str,object]

必要

包含要建立或更新之對應項的字典。

match_condition

MatchConditions

要在其中執行作業的條件。

etag

str

只有在實體的 etag 符合根據 match_condition提供的值時，才執行作業。

傳回

包含已建立或更新對應項的字典。

傳回類型

Dict[str, object]

例外狀況

HttpResponseError

ResourceExistsError

如果數位對應項已經存在。

upsert_event_route

建立或更新事件路由。

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

參數

event_route_id

str

必要

要建立或更新之事件路由的識別碼。

event_route

DigitalTwinsEventRoute

必要

事件路由資料。

傳回

None

傳回類型

None

例外狀況

HttpResponseError

upsert_relationship

在數位對應項上建立或更新關聯性。

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

參數

digital_twin_id

str

必要

數位對應項的識別碼。

relationship_id

str

必要

要擷取之關聯性的識別碼。

relationship

Dict[str,object]

必要

包含關聯性的字典。

match_condition

MatchConditions

要在其中執行作業的條件。

etag

str

只有在實體的 etag 符合根據 match_condition提供的值時，才執行作業。

傳回

已建立或更新的關聯性。

傳回類型

Dict[str, object]

例外狀況

HttpResponseError

ResourceNotFoundError

如果沒有數位對應項，請以數位對應項為目標，或與提供的識別碼建立關聯性。