DigitalTwinsClient Klasse
Erstellt eine Instanz des Digital Twins-Clients.
- Vererbung
-
builtins.objectDigitalTwinsClient
Konstruktor
DigitalTwinsClient(endpoint: str, credential: AsyncTokenCredential, **kwargs)Parameter
- credential
- AsyncTokenCredential
Anmeldeinformationen zum Authentifizieren von Anforderungen an den Dienst.
Methoden
| close | |
| create_models |
Erstellen Sie mindestens ein Modell. Wenn ein Fehler auftritt, werden keine Modelle hochgeladen. |
| decommission_model |
Stellt ein Modell außer Betrieb. |
| delete_digital_twin |
Löschen sie einen digitalen Zwilling. |
| delete_event_route |
Löschen Sie eine Ereignisroute. |
| delete_model |
Löschen Sie ein Modell. |
| delete_relationship |
Löschen sie eine Beziehung zu einem digitalen Zwilling. |
| get_component |
Rufen Sie eine Komponente für einen digitalen Zwilling ab. |
| get_digital_twin |
Rufen Sie einen digitalen Zwilling ab. |
| get_event_route |
Rufen Sie eine Ereignisroute ab. |
| get_model |
Rufen Sie ein Modell ab, einschließlich der Modellmetadaten und der Modelldefinition. |
| get_relationship |
Rufen Sie eine Beziehung zu einem digitalen Zwilling ab. |
| list_event_routes |
Ruft alle Ereignisrouten ab. |
| list_incoming_relationships |
Ruft alle eingehenden Beziehungen für einen digitalen Zwilling ab. |
| list_models |
Rufen Sie die Liste der Modelle ab. |
| list_relationships |
Ruft Beziehungen für einen digitalen Zwilling ab. |
| publish_component_telemetry |
Veröffentlichen Sie Telemetriedaten aus der Komponente eines digitalen Zwillings, die dann von einem oder mehreren Zielendpunkten (Abonnenten) genutzt wird, die unter definiert sind. |
| publish_telemetry |
Veröffentlichen Sie Telemetriedaten aus einem digitalen Zwilling, die dann von einem oder mehreren Zielendpunkten (Abonnenten) genutzt werden, die unter definiert sind. |
| query_twins |
Abfragen für digitale Zwillinge. Hinweis: Es kann zu einer Verzögerung zwischen den Abfragen kommen, bevor Änderungen in Ihrer Instanz in Abfragen widerspiegelt werden. Weitere Informationen zu Abfragebeschränkungen finden Sie unter https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations |
| update_component |
Aktualisieren sie die Eigenschaften einer Komponente auf einem digitalen Zwilling mithilfe eines JSON-Patches. |
| update_digital_twin |
Aktualisieren sie einen digitalen Zwilling mithilfe eines JSON-Patches. |
| update_relationship |
Aktualisierungen die Eigenschaften einer Beziehung zu einem digitalen Zwilling mithilfe eines JSON-Patches. |
| upsert_digital_twin |
Erstellen oder Aktualisieren eines digitalen Zwillings |
| upsert_event_route |
Erstellen oder Aktualisieren einer Ereignisroute |
| upsert_relationship |
Erstellen oder Aktualisieren einer Beziehung zu einem digitalen Zwilling |
close
async close() -> Nonecreate_models
Erstellen Sie mindestens ein Modell. Wenn ein Fehler auftritt, werden keine Modelle hochgeladen.
async create_models(dtdl_models: List[object], **kwargs) -> List[DigitalTwinsModelData]Parameter
Die Gruppe der zu erstellenden Modelle. Jedes Dict entspricht genau einem Modell.
Gibt zurück
Die Liste der erstellten Modelle
Rückgabetyp
Ausnahmen
Mindestens eins der bereitgestellten Modelle ist bereits vorhanden.
decommission_model
Stellt ein Modell außer Betrieb.
async decommission_model(model_id: str, **kwargs) -> NoneParameter
- model_id
- str
Die ID für das Modell. Die ID ist global eindeutig und beachtet die Groß-/Kleinschreibung.
Gibt zurück
Keine
Rückgabetyp
Ausnahmen
Es gibt kein Modell mit der angegebenen ID.
delete_digital_twin
Löschen sie einen digitalen Zwilling.
async delete_digital_twin(digital_twin_id: str, **kwargs) -> NoneParameter
- match_condition
- MatchConditions
Die Bedingung, unter der der Vorgang ausgeführt werden soll.
- etag
- str
Führen Sie den Vorgang nur aus, wenn das etag der Entität mit dem gemäß dem match_condition angegebenen Wert übereinstimmt.
Gibt zurück
Keine
Rückgabetyp
Ausnahmen
Wenn kein digitaler Zwilling mit der angegebenen ID vorhanden ist.
delete_event_route
Löschen Sie eine Ereignisroute.
async delete_event_route(event_route_id: str, **kwargs) -> NoneParameter
Gibt zurück
Keine
Rückgabetyp
Ausnahmen
Es gibt keine Ereignisroute mit der angegebenen ID.
delete_model
Löschen Sie ein Modell.
async delete_model(model_id: str, **kwargs) -> NoneParameter
Gibt zurück
Keine
Rückgabetyp
Ausnahmen
Es gibt kein Modell mit der angegebenen ID.
Es gibt Abhängigkeiten vom Modell, die verhindern, dass es gelöscht wird.
delete_relationship
Löschen sie eine Beziehung zu einem digitalen Zwilling.
async delete_relationship(digital_twin_id: str, relationship_id: str, **kwargs) -> NoneParameter
- match_condition
- MatchConditions
Die Bedingung, unter der der Vorgang ausgeführt werden soll.
- etag
- str
Führen Sie den Vorgang nur aus, wenn das etag der Entität mit dem gemäß dem match_condition angegebenen Wert übereinstimmt.
Gibt zurück
Keine
Rückgabetyp
Ausnahmen
Wenn entweder kein digitaler Zwilling oder eine Beziehung mit der bereitgestellten ID besteht.
get_component
Rufen Sie eine Komponente für einen digitalen Zwilling ab.
async get_component(digital_twin_id: str, component_name: str, **kwargs) -> Dict[str, object]Parameter
Gibt zurück
Wörterbuch, das die Komponente enthält.
Rückgabetyp
Ausnahmen
Wenn entweder kein digitaler Zwilling mit der angegebenen ID vorhanden ist oder der Komponentenname ungültig ist.
get_digital_twin
Rufen Sie einen digitalen Zwilling ab.
async get_digital_twin(digital_twin_id: str, **kwargs) -> Dict[str, object]Parameter
Gibt zurück
Wörterbuch, das den Zwilling enthält.
Rückgabetyp
Ausnahmen
Wenn der digitale Zwilling nicht vorhanden ist.
get_event_route
Rufen Sie eine Ereignisroute ab.
async get_event_route(event_route_id: str, **kwargs) -> DigitalTwinsEventRouteParameter
Gibt zurück
Das Ereignisroutenobjekt.
Rückgabetyp
Ausnahmen
Es gibt keine Ereignisroute mit der angegebenen ID.
get_model
Rufen Sie ein Modell ab, einschließlich der Modellmetadaten und der Modelldefinition.
async get_model(model_id: str, **kwargs) -> DigitalTwinsModelDataParameter
- include_model_definition
- bool
Schließen Sie die Modelldefinition als Teil des Ergebnisses ein. Der Standardwert ist False.
Gibt zurück
Die Modelldaten.
Rückgabetyp
Ausnahmen
Wenn kein Modell mit der angegebenen ID vorhanden ist.
get_relationship
Rufen Sie eine Beziehung zu einem digitalen Zwilling ab.
async get_relationship(digital_twin_id: str, relationship_id: str, **kwargs) -> Dict[str, object]Parameter
Gibt zurück
Wörterbuch, das die Beziehung enthält.
Rückgabetyp
Ausnahmen
Wenn entweder kein digitaler Zwilling oder eine Beziehung mit der bereitgestellten ID besteht.
list_event_routes
Ruft alle Ereignisrouten ab.
list_event_routes(**kwargs) -> AsyncItemPaged[DigitalTwinsEventRoute]Parameter
- results_per_page
- int
Die maximale Anzahl von Elementen, die pro Anforderung abgerufen werden sollen. Der Server kann sich dafür entscheiden, weniger als die angeforderte max.
Gibt zurück
Eine Iteratorinstanz von Ereignisrouten.
Rückgabetyp
Ausnahmen
list_incoming_relationships
Ruft alle eingehenden Beziehungen für einen digitalen Zwilling ab.
list_incoming_relationships(digital_twin_id: str, **kwargs) -> AsyncItemPaged[IncomingRelationship]Parameter
Gibt zurück
Eine Iteratorinstanz der Liste der eingehenden Beziehungen.
Rückgabetyp
Ausnahmen
Wenn kein digitaler Zwilling mit der angegebenen ID vorhanden ist.
list_models
Rufen Sie die Liste der Modelle ab.
list_models(dependencies_for: List[str] | None = None, **kwargs) -> AsyncItemPaged[DigitalTwinsModelData]Parameter
Die Modell-IDs, die Abhängigkeiten abgerufen werden sollen. Wenn nicht angegeben, werden alle Modelle abgerufen.
- include_model_definition
- bool
Schließen Sie die Modelldefinition als Teil der Ergebnisse ein. Der Standardwert ist False.
- results_per_page
- int
Die maximale Anzahl von Elementen, die pro Anforderung abgerufen werden sollen. Der Server kann sich dafür entscheiden, weniger als die angeforderte max.
Gibt zurück
Eine Iteratorinstanz der Liste der Modelldaten.
Rückgabetyp
Ausnahmen
list_relationships
Ruft Beziehungen für einen digitalen Zwilling ab.
list_relationships(digital_twin_id: str, relationship_id: str | None = None, **kwargs) -> AsyncItemPaged[Dict[str, object]]Parameter
- relationship_id
- str
Die ID der abzurufenden Beziehung (wenn Keine alle Beziehungen abgerufen werden).
Gibt zurück
Eine Iteratorinstanz der Beziehungsliste.
Rückgabetyp
Ausnahmen
Wenn kein digitaler Zwilling mit der angegebenen ID vorhanden ist.
publish_component_telemetry
Veröffentlichen Sie Telemetriedaten aus der Komponente eines digitalen Zwillings, die dann von einem oder mehreren Zielendpunkten (Abonnenten) genutzt wird, die unter definiert sind.
async publish_component_telemetry(digital_twin_id: str, component_name: str, telemetry: object, **kwargs) -> NoneParameter
- message_id
- str
Die Meldungs-ID. Wenn nicht angegeben, wird eine UUID generiert.
Gibt zurück
Keine
Rückgabetyp
Ausnahmen
Wenn kein digitaler Zwilling mit der angegebenen ID vorhanden ist oder der Komponentenname ungültig ist.
publish_telemetry
Veröffentlichen Sie Telemetriedaten aus einem digitalen Zwilling, die dann von einem oder mehreren Zielendpunkten (Abonnenten) genutzt werden, die unter definiert sind.
async publish_telemetry(digital_twin_id: str, telemetry: object, **kwargs) -> NoneParameter
- message_id
- str
Die Meldungs-ID. Wenn nicht angegeben, wird eine UUID generiert.
Gibt zurück
Keine
Rückgabetyp
Ausnahmen
Wenn kein digitaler Zwilling mit der angegebenen ID vorhanden ist.
query_twins
Abfragen für digitale Zwillinge.
Hinweis: Es kann zu einer Verzögerung zwischen den Abfragen kommen, bevor Änderungen in Ihrer Instanz in Abfragen widerspiegelt werden. Weitere Informationen zu Abfragebeschränkungen finden Sie unter https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations
query_twins(query_expression: str, **kwargs) -> AsyncItemPaged[Dict[str, object]]Parameter
Gibt zurück
Eine Iterable von Abfrageergebnissen.
Rückgabetyp
Ausnahmen
update_component
Aktualisieren sie die Eigenschaften einer Komponente auf einem digitalen Zwilling mithilfe eines JSON-Patches.
async update_component(digital_twin_id: str, component_name: str, json_patch: List[Dict[str, object]], **kwargs) -> NoneParameter
Eine Updatespezifikation, die von JSON Patch beschrieben wird.
- match_condition
- MatchConditions
Die Bedingung, unter der der Vorgang ausgeführt werden soll.
- etag
- str
Führen Sie den Vorgang nur aus, wenn das etag der Entität mit dem gemäß dem match_condition angegebenen Wert übereinstimmt.
Gibt zurück
Keine
Rückgabetyp
Ausnahmen
Wenn entweder kein digitaler Zwilling mit der angegebenen ID vorhanden ist oder der Komponentenname ungültig ist.
update_digital_twin
Aktualisieren sie einen digitalen Zwilling mithilfe eines JSON-Patches.
async update_digital_twin(digital_twin_id: str, json_patch: List[Dict[str, object]], **kwargs) -> NoneParameter
Eine Updatespezifikation, die von JSON Patch beschrieben wird. Aktualisierungen zu Eigenschaftswerten und $model Elementen kann in derselben Anforderung erfolgen. Vorgänge sind auf das Hinzufügen, Ersetzen und Entfernen beschränkt.
- match_condition
- MatchConditions
Die Bedingung, unter der der Vorgang ausgeführt werden soll.
- etag
- str
Führen Sie den Vorgang nur aus, wenn das etag der Entität mit dem gemäß dem match_condition angegebenen Wert übereinstimmt.
Gibt zurück
Keine
Rückgabetyp
Ausnahmen
Wenn kein digitaler Zwilling mit der angegebenen ID vorhanden ist.
update_relationship
Aktualisierungen die Eigenschaften einer Beziehung zu einem digitalen Zwilling mithilfe eines JSON-Patches.
async update_relationship(digital_twin_id: str, relationship_id: str, json_patch: List[Dict[str, object]], **kwargs) -> NoneParameter
JSON-Patchbeschreibung der Aktualisierung der Beziehungseigenschaften.
- match_condition
- MatchConditions
Die Bedingung, unter der der Vorgang ausgeführt werden soll.
- etag
- str
Führen Sie den Vorgang nur aus, wenn das etag der Entität mit dem gemäß dem match_condition angegebenen Wert übereinstimmt.
Gibt zurück
Keine
Rückgabetyp
Ausnahmen
Wenn entweder kein digitaler Zwilling oder eine Beziehung mit der bereitgestellten ID vorhanden ist.
upsert_digital_twin
Erstellen oder Aktualisieren eines digitalen Zwillings
async upsert_digital_twin(digital_twin_id: str, digital_twin: Dict[str, object], **kwargs) -> Dict[str, object]Parameter
Wörterbuch, das den zu erstellenden oder zu aktualisierenden Zwilling enthält.
- match_condition
- MatchConditions
Die Bedingung, unter der der Vorgang ausgeführt werden soll.
- etag
- str
Führen Sie den Vorgang nur aus, wenn das etag der Entität mit dem gemäß dem match_condition angegebenen Wert übereinstimmt.
Gibt zurück
Wörterbuch, das den erstellten oder aktualisierten Zwilling enthält.
Rückgabetyp
Ausnahmen
Wenn der digitale Zwilling bereits vorhanden ist.
upsert_event_route
Erstellen oder Aktualisieren einer Ereignisroute
async upsert_event_route(event_route_id: str, event_route: DigitalTwinsEventRoute, **kwargs) -> NoneParameter
Gibt zurück
Keine
Rückgabetyp
Ausnahmen
upsert_relationship
Erstellen oder Aktualisieren einer Beziehung zu einem digitalen Zwilling
async upsert_relationship(digital_twin_id: str, relationship_id: str, relationship: Dict[str, object], **kwargs) -> Dict[str, object]Parameter
- match_condition
- MatchConditions
Die Bedingung, unter der der Vorgang ausgeführt werden soll.
- etag
- str
Führen Sie den Vorgang nur aus, wenn das etag der Entität mit dem gemäß dem match_condition angegebenen Wert übereinstimmt.
Gibt zurück
Die erstellte oder aktualisierte Beziehung.
Rückgabetyp
Ausnahmen
Wenn kein digitaler Zwilling vorhanden ist, sollten Sie den digitalen Zwilling als Ziel verwenden oder eine Beziehung mit der angegebenen ID herstellen.
