DigitalTwinsClient Klass
Skapar en instans av Digital Twins-klienten.
- Arv
-
builtins.objectDigitalTwinsClient
DigitalTwinsClient(endpoint: str, credential: AsyncTokenCredential, **kwargs)
- credential
- AsyncTokenCredential
En autentiseringsuppgift för att autentisera begäranden till tjänsten.
close | |
create_models |
Skapa en eller flera modeller. När ett fel inträffar laddas inga modeller upp. |
decommission_model |
Inaktiverar en modell. |
delete_digital_twin |
Ta bort en digital tvilling. |
delete_event_route |
Ta bort en händelseväg. |
delete_model |
Ta bort en modell. |
delete_relationship |
Ta bort en relation på en digital tvilling. |
get_component |
Hämta en komponent på en digital tvilling. |
get_digital_twin |
Skaffa en digital tvilling. |
get_event_route |
Hämta en händelseväg. |
get_model |
Hämta en modell, inklusive modellmetadata och modelldefinitionen. |
get_relationship |
Skaffa en relation på en digital tvilling. |
list_event_routes |
Hämtar alla händelsevägar. |
list_incoming_relationships |
Hämta alla inkommande relationer för en digital tvilling. |
list_models |
Hämta listan över modeller. |
list_relationships |
Hämta relationer för en digital tvilling. |
publish_component_telemetry |
Publicera telemetri från en digital tvillings komponent, som sedan används av en eller flera målslutpunkter (prenumeranter) som definierats under. |
publish_telemetry |
Publicera telemetri från en digital tvilling, som sedan används av en eller flera målslutpunkter (prenumeranter) som definieras under. |
query_twins |
Fråga efter digitala tvillingar. Obs! Det kan uppstå en fördröjning mellan innan ändringar i din instans återspeglas i frågor. Mer information om frågebegränsningar finns i https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations |
update_component |
Uppdatera egenskaper för en komponent på en digital tvilling med hjälp av en JSON-korrigering. |
update_digital_twin |
Uppdatera en digital tvilling med hjälp av en JSON-korrigering. |
update_relationship |
Uppdateringar egenskaperna för en relation på en digital tvilling med hjälp av en JSON-korrigering. |
upsert_digital_twin |
Skapa eller uppdatera en digital tvilling. |
upsert_event_route |
Skapa eller uppdatera en händelseväg. |
upsert_relationship |
Skapa eller uppdatera en relation på en digital tvilling. |
async close() -> None
Skapa en eller flera modeller. När ett fel inträffar laddas inga modeller upp.
async create_models(dtdl_models: List[object], **kwargs) -> List[DigitalTwinsModelData]
Parametrar
Den uppsättning modeller som ska skapas. Varje dikta motsvarar exakt en modell.
Returer
Listan över skapade modeller
Returtyp
Undantag
En eller flera av de angivna modellerna finns redan.
Inaktiverar en modell.
async decommission_model(model_id: str, **kwargs) -> None
Parametrar
Returer
Ingen
Returtyp
Undantag
Det finns ingen modell med det angivna ID:t.
Ta bort en digital tvilling.
async delete_digital_twin(digital_twin_id: str, **kwargs) -> None
Parametrar
- match_condition
- MatchConditions
Villkoret under vilket åtgärden ska utföras.
- etag
- str
Utför endast åtgärden om entitetens etag matchar värdet som anges enligt match_condition.
Returer
Ingen
Returtyp
Undantag
Om det inte finns någon digital tvilling med det angivna ID:t.
Ta bort en händelseväg.
async delete_event_route(event_route_id: str, **kwargs) -> None
Parametrar
Returer
Ingen
Returtyp
Undantag
Det finns ingen händelseväg med det angivna ID:t.
Ta bort en modell.
async delete_model(model_id: str, **kwargs) -> None
Parametrar
Returer
Ingen
Returtyp
Undantag
Det finns ingen modell med det angivna ID:t.
Det finns beroenden för modellen som förhindrar att den tas bort.
Ta bort en relation på en digital tvilling.
async delete_relationship(digital_twin_id: str, relationship_id: str, **kwargs) -> None
Parametrar
- match_condition
- MatchConditions
Villkoret under vilket åtgärden ska utföras.
- etag
- str
Utför endast åtgärden om entitetens etag matchar värdet som anges enligt match_condition.
Returer
Ingen
Returtyp
Undantag
Om det antingen inte finns någon digital tvilling eller relation med det angivna ID:t.
Hämta en komponent på en digital tvilling.
async get_component(digital_twin_id: str, component_name: str, **kwargs) -> Dict[str, object]
Parametrar
Returer
Ordlista som innehåller komponenten.
Returtyp
Undantag
Om det antingen inte finns någon digital tvilling med det angivna ID:t eller om komponentnamnet är ogiltigt.
Skaffa en digital tvilling.
async get_digital_twin(digital_twin_id: str, **kwargs) -> Dict[str, object]
Parametrar
Returer
Ordlista som innehåller tvillingen.
Returtyp
Undantag
Om den digitala tvillingen inte finns.
Hämta en händelseväg.
async get_event_route(event_route_id: str, **kwargs) -> DigitalTwinsEventRoute
Parametrar
Returer
Händelsevägsobjektet.
Returtyp
Undantag
Det finns ingen händelseväg med det angivna ID:t.
Hämta en modell, inklusive modellmetadata och modelldefinitionen.
async get_model(model_id: str, **kwargs) -> DigitalTwinsModelData
Parametrar
- include_model_definition
- bool
Inkludera modelldefinitionen som en del av resultatet. Standardvärdet är Falskt.
Returer
Modelldata.
Returtyp
Undantag
Om det inte finns någon modell med det angivna ID:t.
Skaffa en relation på en digital tvilling.
async get_relationship(digital_twin_id: str, relationship_id: str, **kwargs) -> Dict[str, object]
Parametrar
Returer
Ordlista som innehåller relationen.
Returtyp
Undantag
Om det antingen inte finns någon digital tvilling eller relation med det angivna ID:t.
Hämtar alla händelsevägar.
list_event_routes(**kwargs) -> AsyncItemPaged[DigitalTwinsEventRoute]
Parametrar
- results_per_page
- int
Det maximala antalet objekt som ska hämtas per begäran. Servern kan välja att returnera mindre än det begärda maxvärdet.
Returer
En iteratorinstans av händelsevägar.
Returtyp
Undantag
Hämta alla inkommande relationer för en digital tvilling.
list_incoming_relationships(digital_twin_id: str, **kwargs) -> AsyncItemPaged[IncomingRelationship]
Parametrar
Returer
En iteratorinstans av listan över inkommande relationer.
Returtyp
Undantag
Om det inte finns någon digital tvilling med det angivna ID:t.
Hämta listan över modeller.
list_models(dependencies_for: List[str] | None = None, **kwargs) -> AsyncItemPaged[DigitalTwinsModelData]
Parametrar
Modell-ID:t för att hämta beroenden. Om det utelämnas hämtas alla modeller.
- include_model_definition
- bool
Inkludera modelldefinitionen som en del av resultatet. Standardvärdet är Falskt.
- results_per_page
- int
Det maximala antalet objekt som ska hämtas per begäran. Servern kan välja att returnera mindre än det begärda maxvärdet.
Returer
En iteratorinstans av en lista över modelldata.
Returtyp
Undantag
Hämta relationer för en digital tvilling.
list_relationships(digital_twin_id: str, relationship_id: str | None = None, **kwargs) -> AsyncItemPaged[Dict[str, object]]
Parametrar
- relationship_id
- str
ID för den relation som ska hämtas (om Ingen hämtas alla relationer).
Returer
En iteratorinstans av en lista över relationer.
Returtyp
Undantag
Om det inte finns någon digital tvilling med det angivna ID:t.
Publicera telemetri från en digital tvillings komponent, som sedan används av en eller flera målslutpunkter (prenumeranter) som definierats under.
async publish_component_telemetry(digital_twin_id: str, component_name: str, telemetry: object, **kwargs) -> None
Parametrar
- message_id
- str
Meddelande-ID:t. Om inget anges genereras ett UUID.
Returer
Ingen
Returtyp
Undantag
Om det inte finns någon digital tvilling med det angivna ID:t eller om komponentnamnet är ogiltigt.
Publicera telemetri från en digital tvilling, som sedan används av en eller flera målslutpunkter (prenumeranter) som definieras under.
async publish_telemetry(digital_twin_id: str, telemetry: object, **kwargs) -> None
Parametrar
- message_id
- str
Meddelande-ID:t. Om inget anges genereras ett UUID.
Returer
Ingen
Returtyp
Undantag
Om det inte finns någon digital tvilling med det angivna ID:t.
Fråga efter digitala tvillingar.
Obs! Det kan uppstå en fördröjning mellan innan ändringar i din instans återspeglas i frågor. Mer information om frågebegränsningar finns i https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations
query_twins(query_expression: str, **kwargs) -> AsyncItemPaged[Dict[str, object]]
Parametrar
Returer
En iterabel frågeresultat.
Returtyp
Undantag
Uppdatera egenskaper för en komponent på en digital tvilling med hjälp av en JSON-korrigering.
async update_component(digital_twin_id: str, component_name: str, json_patch: List[Dict[str, object]], **kwargs) -> None
Parametrar
En uppdateringsspecifikation som beskrivs av JSON Patch.
- match_condition
- MatchConditions
Villkoret under vilket åtgärden ska utföras.
- etag
- str
Utför endast åtgärden om entitetens etag matchar värdet som anges enligt match_condition.
Returer
Ingen
Returtyp
Undantag
Om det antingen inte finns någon digital tvilling med det angivna ID:t eller om komponentnamnet är ogiltigt.
Uppdatera en digital tvilling med hjälp av en JSON-korrigering.
async update_digital_twin(digital_twin_id: str, json_patch: List[Dict[str, object]], **kwargs) -> None
Parametrar
En uppdateringsspecifikation som beskrivs av JSON Patch. Uppdateringar till egenskapsvärden och $model element kan inträffa i samma begäran. Åtgärderna är begränsade till att lägga till, ersätta och ta bort.
- match_condition
- MatchConditions
Villkoret under vilket åtgärden ska utföras.
- etag
- str
Utför endast åtgärden om entitetens etag matchar värdet som anges enligt match_condition.
Returer
Ingen
Returtyp
Undantag
Om det inte finns någon digital tvilling med det angivna ID:t.
Uppdateringar egenskaperna för en relation på en digital tvilling med hjälp av en JSON-korrigering.
async update_relationship(digital_twin_id: str, relationship_id: str, json_patch: List[Dict[str, object]], **kwargs) -> None
Parametrar
JSON Patch-beskrivning av uppdateringen av relationsegenskaperna.
- match_condition
- MatchConditions
Villkoret under vilket åtgärden ska utföras.
- etag
- str
Utför endast åtgärden om entitetens etag matchar värdet som anges enligt match_condition.
Returer
Ingen
Returtyp
Undantag
Om det antingen inte finns någon digital tvilling eller relation med det angivna ID:t.
Skapa eller uppdatera en digital tvilling.
async upsert_digital_twin(digital_twin_id: str, digital_twin: Dict[str, object], **kwargs) -> Dict[str, object]
Parametrar
Ordlista som innehåller tvillingen för att skapa eller uppdatera.
- match_condition
- MatchConditions
Villkoret under vilket åtgärden ska utföras.
- etag
- str
Utför endast åtgärden om entitetens etag matchar värdet som anges enligt match_condition.
Returer
Ordlista som innehåller den skapade eller uppdaterade tvillingen.
Returtyp
Undantag
Om den digitala tvillingen redan finns.
Skapa eller uppdatera en händelseväg.
async upsert_event_route(event_route_id: str, event_route: DigitalTwinsEventRoute, **kwargs) -> None
Parametrar
Returer
Ingen
Returtyp
Undantag
Skapa eller uppdatera en relation på en digital tvilling.
async upsert_relationship(digital_twin_id: str, relationship_id: str, relationship: Dict[str, object], **kwargs) -> Dict[str, object]
Parametrar
- match_condition
- MatchConditions
Villkoret under vilket åtgärden ska utföras.
- etag
- str
Utför endast åtgärden om entitetens etag matchar värdet som anges enligt match_condition.
Returer
Den skapade eller uppdaterade relationen.
Returtyp
Undantag
Om det antingen inte finns någon digital tvilling kan du rikta in dig på den digitala tvillingen eller relationen med det angivna ID:t.
Feedback om Azure SDK for Python
Azure SDK for Python är ett öppen källkod projekt. Välj en länk för att ge feedback: