DigitalTwinsClient Klas
Hiermee maakt u een exemplaar van de Digital Twins-client.
- Overname
-
builtins.objectDigitalTwinsClient
Constructor
DigitalTwinsClient(endpoint: str, credential: TokenCredential, **kwargs: Any)Parameters
Methoden
| create_models |
Maak een of meer modellen. Wanneer er een fout optreedt, worden er geen modellen geüpload. |
| decommission_model |
Een model buiten gebruik stellen. |
| delete_digital_twin |
Een digitale dubbel verwijderen. |
| delete_event_route |
Een gebeurtenisroute verwijderen. |
| delete_model |
Een model verwijderen. |
| delete_relationship |
Een relatie op een digitale dubbel verwijderen. |
| get_component |
Een onderdeel ophalen op een digitale dubbel. |
| get_digital_twin |
Een digitale dubbel ophalen. |
| get_event_route |
Een gebeurtenisroute ophalen. |
| get_model |
Haal een model op, inclusief de metagegevens van het model en de modeldefinitie. |
| get_relationship |
Een relatie op een digitale dubbel ophalen. |
| list_event_routes |
Hiermee worden alle gebeurtenisroutes opgehaald. |
| list_incoming_relationships |
Alle binnenkomende relaties voor een digitale dubbel ophalen. |
| list_models |
Haal de lijst met modellen op. |
| list_relationships |
Relaties voor een digitale dubbel ophalen. |
| publish_component_telemetry |
Publiceer telemetrie van het onderdeel van een digitale dubbel, die vervolgens wordt gebruikt door een of meer doeleindpunten (abonnees) die zijn gedefinieerd onder. |
| publish_telemetry |
Publiceer telemetrie van een digitale dubbel, die vervolgens wordt gebruikt door een of meer doeleindpunten (abonnees) die zijn gedefinieerd onder. |
| query_twins |
Query's uitvoeren op digitale dubbels. Opmerking: er kan een vertraging zijn tussen voordat wijzigingen in uw exemplaar worden doorgevoerd in query's. Zie voor meer informatie over querybeperkingen https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations |
| update_component |
Eigenschappen van een onderdeel op een digitale dubbel bijwerken met behulp van een JSON-patch. |
| update_digital_twin |
Een digitale dubbel bijwerken met behulp van een JSON-patch. |
| update_relationship |
Updates de eigenschappen van een relatie op een digitale dubbel met behulp van een JSON-patch. |
| upsert_digital_twin |
Een digitale dubbel maken of bijwerken. |
| upsert_event_route |
Een gebeurtenisroute maken of bijwerken. |
| upsert_relationship |
Een relatie op een digitale dubbel maken of bijwerken. |
create_models
Maak een of meer modellen. Wanneer er een fout optreedt, worden er geen modellen geüpload.
create_models(dtdl_models: List[Dict[str, object]], **kwargs: Any) -> List[DigitalTwinsModelData]Parameters
De set modellen die moeten worden gemaakt. Elke dict komt overeen met precies één model.
Retouren
De lijst met gemaakte modellen.
Retourtype
Uitzonderingen
Een of meer van de opgegeven modellen bestaan al.
decommission_model
Een model buiten gebruik stellen.
decommission_model(model_id: str, **kwargs: Any) -> NoneParameters
Retouren
Geen
Retourtype
Uitzonderingen
Er is geen model met de opgegeven id.
delete_digital_twin
Een digitale dubbel verwijderen.
delete_digital_twin(digital_twin_id: str, **kwargs: Any) -> NoneParameters
- match_condition
- MatchConditions
De voorwaarde waaronder de bewerking moet worden uitgevoerd.
- etag
- str
Voer de bewerking alleen uit als de etag van de entiteit overeenkomt met de waarde die is opgegeven volgens de match_condition.
Retouren
Geen
Retourtype
Uitzonderingen
Als er geen digitale dubbel is met de opgegeven id.
delete_event_route
Een gebeurtenisroute verwijderen.
delete_event_route(event_route_id: str, **kwargs: Any) -> NoneParameters
Retouren
Geen
Retourtype
Uitzonderingen
Er is geen gebeurtenisroute met de opgegeven id.
delete_model
Een model verwijderen.
delete_model(model_id: str, **kwargs: Any) -> NoneParameters
Retouren
Geen
Retourtype
Uitzonderingen
Er is geen model met de opgegeven id.
Er zijn afhankelijkheden van het model waardoor het niet kan worden verwijderd.
delete_relationship
Een relatie op een digitale dubbel verwijderen.
delete_relationship(digital_twin_id: str, relationship_id: str, **kwargs: Any) -> NoneParameters
- match_condition
- MatchConditions
De voorwaarde waaronder de bewerking moet worden uitgevoerd.
- etag
- str
Voer de bewerking alleen uit als de etag van de entiteit overeenkomt met de waarde die is opgegeven volgens de match_condition.
Retouren
Geen
Retourtype
Uitzonderingen
Als er geen digitale dubbel of relatie is met de opgegeven id.
get_component
Een onderdeel ophalen op een digitale dubbel.
get_component(digital_twin_id: str, component_name: str, **kwargs: Any) -> Dict[str, object]Parameters
Retouren
Woordenlijst met het onderdeel.
Retourtype
Uitzonderingen
Als er geen digitale dubbel is met de opgegeven id of als de naam van het onderdeel ongeldig is.
get_digital_twin
Een digitale dubbel ophalen.
get_digital_twin(digital_twin_id: str, **kwargs: Any) -> Dict[str, object]Parameters
Retouren
Woordenlijst met de dubbel.
Retourtype
Uitzonderingen
Als de digitale dubbel niet bestaat.
get_event_route
Een gebeurtenisroute ophalen.
get_event_route(event_route_id: str, **kwargs: Any) -> DigitalTwinsEventRouteParameters
Retouren
Het gebeurtenisroute-object.
Retourtype
Uitzonderingen
Er is geen gebeurtenisroute met de opgegeven id.
get_model
Haal een model op, inclusief de metagegevens van het model en de modeldefinitie.
get_model(model_id: str, **kwargs: Any) -> DigitalTwinsModelDataParameters
- include_model_definition
- bool
Neem de modeldefinitie op als onderdeel van het resultaat. De standaardwaarde is False.
Retouren
De modelgegevens.
Retourtype
Uitzonderingen
Als er geen model is met de opgegeven id.
get_relationship
Een relatie op een digitale dubbel ophalen.
get_relationship(digital_twin_id: str, relationship_id: str, **kwargs: Any) -> Dict[str, object]Parameters
Retouren
Woordenlijst met de relatie.
Retourtype
Uitzonderingen
Als er geen digitale dubbel of relatie is met de opgegeven id.
list_event_routes
Hiermee worden alle gebeurtenisroutes opgehaald.
list_event_routes(**kwargs: Any) -> ItemPaged[DigitalTwinsEventRoute]Parameters
- results_per_page
- int
Het maximum aantal items dat per aanvraag moet worden opgehaald. De server kan ervoor kiezen om minder dan het aangevraagde maximum te retourneren.
Retouren
Een iterator-exemplaar van gebeurtenisroutes.
Retourtype
Uitzonderingen
list_incoming_relationships
Alle binnenkomende relaties voor een digitale dubbel ophalen.
list_incoming_relationships(digital_twin_id: str, **kwargs: Any) -> ItemPaged[IncomingRelationship]Parameters
Retouren
Een iterator zoals een exemplaar van een relatie.
Retourtype
Uitzonderingen
Als er geen digitale dubbel is met de opgegeven id.
list_models
Haal de lijst met modellen op.
list_models(dependencies_for: List[str] | None = None, **kwargs: Any) -> ItemPaged[DigitalTwinsModelData]Parameters
De model-id's waarvoor afhankelijkheden moeten worden opgehaald. Als u dit weglaat, worden alle modellen opgehaald.
- include_model_definition
- bool
Neem de modeldefinitie op als onderdeel van de resultaten. De standaardwaarde is False.
- results_per_page
- int
Het maximum aantal items dat per aanvraag moet worden opgehaald. De server kan ervoor kiezen om minder dan het aangevraagde maximum te retourneren.
Retouren
Een iterator-exemplaar van een lijst met modelgegevens.
Retourtype
Uitzonderingen
list_relationships
Relaties voor een digitale dubbel ophalen.
list_relationships(digital_twin_id: str, relationship_id: str | None = None, **kwargs: Any) -> ItemPaged[Dict[str, object]]Parameters
- relationship_id
- str
De id van de relatie die moet worden opgehaald (als deze geen is, worden alle relaties opgehaald).
Retouren
Een iterator-exemplaar van een lijst met relaties
Retourtype
Uitzonderingen
Als er geen digitale dubbel is met de opgegeven id.
publish_component_telemetry
Publiceer telemetrie van het onderdeel van een digitale dubbel, die vervolgens wordt gebruikt door een of meer doeleindpunten (abonnees) die zijn gedefinieerd onder.
publish_component_telemetry(digital_twin_id: str, component_name: str, telemetry: object, **kwargs: Any) -> NoneParameters
- message_id
- str
De bericht-id. Als u dit niet opgeeft, wordt er een UUID gegenereerd.
Retouren
Geen
Retourtype
Uitzonderingen
Als er geen digitale dubbel is met de opgegeven id of als de naam van het onderdeel ongeldig is.
publish_telemetry
Publiceer telemetrie van een digitale dubbel, die vervolgens wordt gebruikt door een of meer doeleindpunten (abonnees) die zijn gedefinieerd onder.
publish_telemetry(digital_twin_id: str, telemetry: object, **kwargs: Any) -> NoneParameters
- message_id
- str
De bericht-id. Als u dit niet opgeeft, wordt er een UUID gegenereerd.
Retouren
Geen
Retourtype
Uitzonderingen
Als er geen digitale dubbel is met de opgegeven id.
query_twins
Query's uitvoeren op digitale dubbels.
Opmerking: er kan een vertraging zijn tussen voordat wijzigingen in uw exemplaar worden doorgevoerd in query's. Zie voor meer informatie over querybeperkingen https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations
query_twins(query_expression: str, **kwargs: Any) -> ItemPaged[Dict[str, object]]Parameters
Retouren
Een iterable van queryresultaten.
Retourtype
Uitzonderingen
update_component
Eigenschappen van een onderdeel op een digitale dubbel bijwerken met behulp van een JSON-patch.
update_component(digital_twin_id: str, component_name: str, json_patch: List[Dict[str, object]], **kwargs: Any) -> NoneParameters
Een updatespecificatie die wordt beschreven door JSON Patch.
- match_condition
- MatchConditions
De voorwaarde waaronder de bewerking moet worden uitgevoerd.
- etag
- str
Voer de bewerking alleen uit als de etag van de entiteit overeenkomt met de opgegeven waarde volgens de match_condition.
Retouren
Geen
Retourtype
Uitzonderingen
Als er geen digitale dubbel is met de opgegeven id of als de naam van het onderdeel ongeldig is.
update_digital_twin
Een digitale dubbel bijwerken met behulp van een JSON-patch.
update_digital_twin(digital_twin_id: str, json_patch: List[Dict[str, object]], **kwargs: Any) -> NoneParameters
Een updatespecificatie die wordt beschreven door JSON Patch. Updates voor eigenschapswaarden en $model elementen kunnen plaatsvinden in dezelfde aanvraag. Bewerkingen zijn beperkt tot toevoegen, vervangen en verwijderen.
- match_condition
- MatchConditions
De voorwaarde waaronder de bewerking moet worden uitgevoerd.
- etag
- str
Voer de bewerking alleen uit als de etag van de entiteit overeenkomt met de opgegeven waarde volgens de match_condition.
Retouren
Geen
Retourtype
Uitzonderingen
Als er geen digitale dubbel met de opgegeven id is.
update_relationship
Updates de eigenschappen van een relatie op een digitale dubbel met behulp van een JSON-patch.
update_relationship(digital_twin_id: str, relationship_id: str, json_patch: List[Dict[str, object]], **kwargs: Any) -> NoneParameters
Beschrijving van de JSON-patch van de update van de relatie-eigenschappen.
- match_condition
- MatchConditions
De voorwaarde waaronder de bewerking moet worden uitgevoerd.
- etag
- str
Voer de bewerking alleen uit als de etag van de entiteit overeenkomt met de opgegeven waarde volgens de match_condition.
Retouren
Geen
Retourtype
Uitzonderingen
Als er geen digitale dubbel of relatie met de opgegeven id is.
upsert_digital_twin
Een digitale dubbel maken of bijwerken.
upsert_digital_twin(digital_twin_id: str, digital_twin: Dict[str, object], **kwargs: Any) -> Dict[str, object]Parameters
- match_condition
- MatchConditions
De voorwaarde waaronder de bewerking moet worden uitgevoerd.
- etag
- str
Voer de bewerking alleen uit als de etag van de entiteit overeenkomt met de opgegeven waarde volgens de match_condition.
Retouren
Woordenlijst met de gemaakte of bijgewerkte tweeling.
Retourtype
Uitzonderingen
Als de digitale dubbel al bestaat.
upsert_event_route
Een gebeurtenisroute maken of bijwerken.
upsert_event_route(event_route_id: str, event_route: DigitalTwinsEventRoute, **kwargs: Any) -> NoneParameters
Retouren
Geen
Retourtype
Uitzonderingen
upsert_relationship
Een relatie op een digitale dubbel maken of bijwerken.
upsert_relationship(digital_twin_id: str, relationship_id: str, relationship: Dict[str, object], **kwargs: Any) -> Dict[str, object]Parameters
- match_condition
- MatchConditions
De voorwaarde waaronder de bewerking moet worden uitgevoerd.
- etag
- str
Voer de bewerking alleen uit als de etag van de entiteit overeenkomt met de opgegeven waarde volgens de match_condition.
Retouren
De gemaakte of bijgewerkte relatie.
Retourtype
Uitzonderingen
Als er geen digitale dubbel is, richt u de digitale dubbel op of de relatie met de opgegeven id.
