DigitalTwinsClient Klass

Skapar en instans av Digital Twins-klienten.

Arv

builtins.object

DigitalTwinsClient

Konstruktor

DigitalTwinsClient(endpoint: str, credential: TokenCredential, **kwargs: Any)

Parametrar

endpoint

str

Obligatorisk

URL-slutpunkten för en Azure Search-tjänst

credential

TokenCredential

Obligatorisk

En autentiseringsuppgift för att autentisera begäranden till tjänsten

Metoder

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 definierats 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.

create_models

Skapa en eller flera modeller. När ett fel inträffar laddas inga modeller upp.

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

Parametrar

model_list

List[Dict[str,object]]

Obligatorisk

Den uppsättning modeller som ska skapas. Varje dikta motsvarar exakt en modell.

Returer

Listan över skapade modeller.

Returtyp

List[DigitalTwinsModelData]

Undantag

HttpResponseError

ResourceExistsError

En eller flera av de angivna modellerna finns redan.

decommission_model

Inaktiverar en modell.

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

Parametrar

model_id

str

Obligatorisk

ID:t för modellen. ID:t är globalt unikt och skiftlägeskänsligt.

Returer

Ingen

Returtyp

None

Undantag

HttpResponseError

ResourceNotFoundError

Det finns ingen modell med det angivna ID:t.

delete_digital_twin

Ta bort en digital tvilling.

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

Parametrar

digital_twin_id

str

Obligatorisk

ID:t för den digitala tvillingen.

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

None

Undantag

HttpResponseError

ResourceNotFoundError

Om det inte finns någon digital tvilling med det angivna ID:t.

delete_event_route

Ta bort en händelseväg.

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

Parametrar

event_route_id

str

Obligatorisk

ID:t för händelsevägen som ska tas bort.

Returer

Ingen

Returtyp

None

Undantag

HttpResponseError

ResourceNotFoundError

Det finns ingen händelseväg med det angivna ID:t.

delete_model

Ta bort en modell.

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

Parametrar

model_id

str

Obligatorisk

ID:t för modellen som ska tas bort.

Returer

Ingen

Returtyp

None

Undantag

HttpResponseError

ResourceNotFoundError

Det finns ingen modell med det angivna ID:t.

ResourceExistsError

Det finns beroenden för modellen som förhindrar att den tas bort.

delete_relationship

Ta bort en relation på en digital tvilling.

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

Parametrar

digital_twin_id

str

Obligatorisk

ID:t för den digitala tvillingen.

relationship_id

str

Obligatorisk

ID:t för relationen som ska tas 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

None

Undantag

HttpResponseError

ResourceNotFoundError

Om det antingen inte finns någon digital tvilling eller relation med det angivna ID:t.

get_component

Hämta en komponent på en digital tvilling.

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

Parametrar

digital_twin_id

str

Obligatorisk

ID:t för den digitala tvillingen.

component_name

str

Obligatorisk

Komponenten som hämtas.

Returer

Ordlista som innehåller komponenten.

Returtyp

Dict[str, object]

Undantag

HttpResponseError

ResourceNotFoundError

Om det antingen inte finns någon digital tvilling med det angivna ID:t eller om komponentnamnet är ogiltigt.

get_digital_twin

Skaffa en digital tvilling.

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

Parametrar

digital_twin_id

str

Obligatorisk

ID:t för den digitala tvillingen.

Returer

Ordlista som innehåller tvillingen.

Returtyp

Dict[str, object]

Undantag

HttpResponseError

ResourceNotFoundError

Om den digitala tvillingen inte finns.

get_event_route

Hämta en händelseväg.

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

Parametrar

event_route_id

str

Obligatorisk

ID för händelsevägen.

Returer

Händelsevägsobjektet.

Returtyp

DigitalTwinsEventRoute

Undantag

HttpResponseError

ResourceNotFoundError

Det finns ingen händelseväg med det angivna ID:t.

get_model

Hämta en modell, inklusive modellmetadata och modelldefinitionen.

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

Parametrar

model_id

str

Obligatorisk

Modellens ID.

include_model_definition

bool

Inkludera modelldefinitionen som en del av resultatet. Standardvärdet är Falskt.

Returer

Modelldata.

Returtyp

DigitalTwinsModelData

Undantag

HttpResponseError

ResourceNotFoundError

Om det inte finns någon modell med det angivna ID:t.

get_relationship

Skaffa en relation på en digital tvilling.

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

Parametrar

digital_twin_id

str

Obligatorisk

ID:t för den digitala tvillingen.

relationship_id

str

Obligatorisk

ID:t för relationen som ska hämtas.

Returer

Ordlista som innehåller relationen.

Returtyp

Dict[str, object]

Undantag

HttpResponseError

ResourceNotFoundError

Om det antingen inte finns någon digital tvilling eller relation med det angivna ID:t.

list_event_routes

Hämtar alla händelsevägar.

list_event_routes(**kwargs: Any) -> ItemPaged[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

ItemPaged[DigitalTwinsEventRoute]

Undantag

HttpResponseError

list_incoming_relationships

Hämta alla inkommande relationer för en digital tvilling.

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

Parametrar

digital_twin_id

str

Obligatorisk

ID:t för den digitala tvillingen.

Returer

En iterator som en instans av någon av relationerna.

Returtyp

ItemPaged[IncomingRelationship]

Undantag

HttpResponseError

ResourceNotFoundError

Om det inte finns någon digital tvilling med det angivna ID:t.

list_models

Hämta listan över modeller.

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

Parametrar

dependencies_for

List[str]

Obligatorisk

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

ItemPaged[DigitalTwinsModelData]

Undantag

HttpResponseError

list_relationships

Hämta relationer för en digital tvilling.

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

Parametrar

digital_twin_id

str

Obligatorisk

ID:t för den digitala tvillingen.

relationship_id

str

Obligatorisk

ID för den relation som ska hämtas (om Ingen hämtas alla relationer).

Returer

En iteratorinstans av en lista över relationer

Returtyp

ItemPaged[Dict[str,object]]

Undantag

HttpResponseError

ResourceNotFoundError

Om det inte finns någon digital tvilling med det angivna ID:t.

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_component_telemetry(digital_twin_id: str, component_name: str, telemetry: object, **kwargs: Any) -> None

Parametrar

digital_twin_id

str

Obligatorisk

ID:t för den digitala tvillingen.

component_name

str

Obligatorisk

Namnet på DTDL-komponenten.

telemetry

object

Obligatorisk

Telemetridata som ska skickas.

message_id

str

Meddelande-ID:t. Om inget anges genereras ett UUID.

Returer

Ingen

Returtyp

None

Undantag

HttpResponseError

ResourceNotFoundError

Om det inte finns någon digital tvilling med det angivna ID:t eller om komponentnamnet är ogiltigt.

publish_telemetry

Publicera telemetri från en digital tvilling, som sedan används av en eller flera målslutpunkter (prenumeranter) som definierats under.

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

Parametrar

digital_twin_id

str

Obligatorisk

ID för den digitala tvillingen

telemetry

object

Obligatorisk

Telemetridata som ska skickas

message_id

str

Meddelande-ID:t. Om inget anges genereras ett UUID.

Returer

Ingen

Returtyp

None

Undantag

HttpResponseError

ResourceNotFoundError

Om det inte finns någon digital tvilling med det angivna ID:t.

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

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

Parametrar

query_expression

str

Obligatorisk

Frågeuttrycket som ska köras.

Returer

En iterabel av frågeresultat.

Returtyp

ItemPaged[Dict[str, object]]

Undantag

HttpResponseError

update_component

Uppdatera egenskaper för en komponent på en digital tvilling med hjälp av en JSON-korrigering.

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

Parametrar

digital_twin_id

str

Obligatorisk

ID för den digitala tvillingen.

component_name

str

Obligatorisk

Komponenten som uppdateras.

json_patch

List[Dict[str,object]]

Obligatorisk

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 det värde som anges enligt match_condition.

Returer

Ingen

Returtyp

None

Undantag

HttpResponseError

ResourceNotFoundError

Om det antingen inte finns någon digital tvilling med det angivna ID:t eller om komponentnamnet är ogiltigt.

update_digital_twin

Uppdatera en digital tvilling med hjälp av en JSON-korrigering.

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

Parametrar

digital_twin_id

str

Obligatorisk

ID för den digitala tvillingen.

json_patch

List[Dict[str,object]]

Obligatorisk

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 det värde som anges enligt match_condition.

Returer

Ingen

Returtyp

None

Undantag

HttpResponseError

ResourceNotFoundError

Om det inte finns någon digital tvilling med det angivna ID:t.

update_relationship

Uppdateringar egenskaperna för en relation på en digital tvilling med hjälp av en JSON-korrigering.

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

Parametrar

digital_twin_id

str

Obligatorisk

ID för den digitala tvillingen.

relationship_id

str

Obligatorisk

ID för relationen som ska hämtas.

json_patch

List[Dict[str,object]]

Obligatorisk

JSON-korrigeringsbeskrivning 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 det värde som anges enligt match_condition.

Returer

Ingen

Returtyp

None

Undantag

HttpResponseError

ResourceNotFoundError

Om det antingen inte finns någon digital tvilling eller relation med det angivna ID:t.

upsert_digital_twin

Skapa eller uppdatera en digital tvilling.

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

Parametrar

digital_twin_id

str

Obligatorisk

ID för den digitala tvillingen.

digital_twin

Dict[str,object]

Obligatorisk

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 det värde som anges enligt match_condition.

Returer

Ordlista som innehåller den skapade eller uppdaterade tvillingen.

Returtyp

Dict[str, object]

Undantag

HttpResponseError

ResourceExistsError

Om den digitala tvillingen redan finns.

upsert_event_route

Skapa eller uppdatera en händelseväg.

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

Parametrar

event_route_id

str

Obligatorisk

ID:t för händelsevägen som ska skapas eller uppdateras.

event_route

DigitalTwinsEventRoute

Obligatorisk

Händelsevägens data.

Returer

Ingen

Returtyp

None

Undantag

HttpResponseError

upsert_relationship

Skapa eller uppdatera en relation på en digital tvilling.

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

Parametrar

digital_twin_id

str

Obligatorisk

ID för den digitala tvillingen.

relationship_id

str

Obligatorisk

ID för relationen som ska hämtas.

relationship

Dict[str,object]

Obligatorisk

Ordlista som innehåller relationen.

match_condition

MatchConditions

Villkoret under vilket åtgärden ska utföras.

etag

str

Utför endast åtgärden om entitetens etag matchar det värde som anges enligt match_condition.

Returer

Den skapade eller uppdaterade relationen.

Returtyp

Dict[str, object]

Undantag

HttpResponseError

ResourceNotFoundError

Om det antingen inte finns någon digital tvilling kan du rikta in dig på en digital tvilling eller en relation med det angivna ID:t.