DigitalTwinsClient クラス

1 つ以上のモデルを作成します。 エラーが発生した場合、モデルはアップロードされません。

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

パラメーター

戻り値

作成されたモデルの一覧。

の戻り値の型 :

例外

指定されたモデルの 1 つ以上が既に存在します。

モデルの使用を停止します。

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

パラメーター

戻り値

なし

の戻り値の型 :

例外

指定された ID を持つモデルはありません。

デジタル ツインを削除します。

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

パラメーター

戻り値

なし

の戻り値の型 :

例外

指定された ID を持つデジタル ツインがない場合。

イベント ルートを削除します。

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

パラメーター

戻り値

なし

の戻り値の型 :

例外

指定された ID を持つイベント ルートはありません。

モデルを削除します。

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

パラメーター

戻り値

なし

の戻り値の型 :

例外

指定された ID を持つモデルはありません。

モデルには、削除されない依存関係があります。

デジタル ツインのリレーションシップを削除します。

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

パラメーター

戻り値

なし

の戻り値の型 :

例外

デジタル ツインまたは指定された ID との関係がない場合。

デジタル ツインのコンポーネントを取得します。

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

パラメーター

戻り値

コンポーネントを含むディクショナリ。

の戻り値の型 :

例外

指定された ID を持つデジタル ツインがない場合、またはコンポーネント名が無効な場合。

デジタル ツインを取得します。

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

パラメーター

戻り値

ツインを含むディクショナリ。

の戻り値の型 :

例外

デジタル ツインが存在しない場合。

イベント ルートを取得します。

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

パラメーター

戻り値

イベント ルート オブジェクト。

の戻り値の型 :

例外

指定された ID を持つイベント ルートはありません。

モデルメタデータやモデル定義を含むモデルを取得します。

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

パラメーター

戻り値

モデル データ。

の戻り値の型 :

例外

指定された ID を持つモデルがない場合。

デジタル ツインのリレーションシップを取得します。

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

パラメーター

戻り値

リレーションシップを含むディクショナリ。

の戻り値の型 :

例外

デジタル ツインまたは指定された ID との関係がない場合。

すべてのイベント ルートを取得します。

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

パラメーター

戻り値

イベント ルートの反復子インスタンス。

の戻り値の型 :

例外

デジタル ツインのすべての受信リレーションシップを取得します。

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

パラメーター

戻り値

いずれかの Relationship のインスタンスのような反復子。

の戻り値の型 :

例外

指定された ID を持つデジタル ツインがない場合。

モデルの一覧を取得します。

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

パラメーター

戻り値

モデル データのリストの反復子インスタンス。

の戻り値の型 :

例外

デジタル ツインのリレーションシップを取得します。

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

パラメーター

戻り値

リレーションシップのリストの反復子インスタンス

の戻り値の型 :

例外

指定された ID を持つデジタル ツインがない場合。

デジタル ツインのコンポーネントからテレメトリを発行します。このコンポーネントは、 で定義されている 1 つまたは複数の宛先エンドポイント (サブスクライバー) によって使用されます。

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

パラメーター

戻り値

なし

の戻り値の型 :

例外

指定された ID を持つデジタル ツインがない場合、またはコンポーネント名が無効です。

デジタル ツインからテレメトリを発行します。このテレメトリは、 で定義されている 1 つまたは複数の宛先エンドポイント (サブスクライバー) によって使用されます。

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

パラメーター

戻り値

なし

の戻り値の型 :

例外

指定された ID を持つデジタル ツインがない場合。

デジタル ツインのクエリ。

注: インスタンスの変更がクエリに反映されるまでに遅延が発生する可能性があります。 クエリの制限の詳細については、次を参照してください。 https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations

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

パラメーター

戻り値

クエリ結果の許容量。

の戻り値の型 :

例外

JSON パッチを使用して、デジタル ツイン上のコンポーネントのプロパティを更新します。

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

パラメーター

戻り値

なし

の戻り値の型 :

例外

指定された ID を持つデジタル ツインがない場合、またはコンポーネント名が無効な場合。

JSON パッチを使用してデジタル ツインを更新します。

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

パラメーター

戻り値

なし

の戻り値の型 :

例外

指定された ID を持つデジタル ツインがない場合。

JSON パッチを使用して、デジタル ツイン上のリレーションシップのプロパティを更新します。

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

パラメーター

戻り値

なし

の戻り値の型 :

例外

指定された ID を持つデジタル ツインまたはリレーションシップがない場合。

デジタル ツインを作成または更新します。

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

パラメーター

戻り値

作成または更新されたツインを含むディクショナリ。

の戻り値の型 :

例外

デジタル ツインが既に存在する場合。

イベント ルートを作成または更新します。

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

パラメーター

戻り値

なし

の戻り値の型 :

例外

デジタル ツインでリレーションシップを作成または更新します。

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

パラメーター

戻り値

作成または更新されたリレーションシップ。

の戻り値の型 :

例外

デジタル ツインがない場合は、指定された ID を使用してデジタル ツインまたはリレーションシップをターゲットにします。