DigitalTwinsClient Klasa

Tworzy wystąpienie klienta usługi Digital Twins.

Dziedziczenie

builtins.object

DigitalTwinsClient

Konstruktor

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

Parametry

endpoint

str

Wymagane

Punkt końcowy adresu URL usługi Azure Search

credential

TokenCredential

Wymagane

Poświadczenie służące do uwierzytelniania żądań w usłudze

Metody

create_models	Utwórz co najmniej jeden model. W przypadku wystąpienia jakiegokolwiek błędu nie są przekazywane żadne modele.
decommission_model	Likwiduje model.
delete_digital_twin	Usuwanie cyfrowej reprezentacji bliźniaczej.
delete_event_route	Usuń trasę zdarzenia.
delete_model	Usuwanie modelu.
delete_relationship	Usuwanie relacji w cyfrowej reprezentacji bliźniaczej.
get_component	Pobierz składnik w cyfrowej reprezentacji bliźniaczej.
get_digital_twin	Pobierz cyfrową reprezentację bliźniaczą.
get_event_route	Pobierz trasę zdarzenia.
get_model	Pobierz model, w tym metadane modelu i definicję modelu.
get_relationship	Uzyskaj relację na cyfrowej reprezentacji bliźniaczej.
list_event_routes	Pobiera wszystkie trasy zdarzeń.
list_incoming_relationships	Pobierz wszystkie relacje przychodzące dla cyfrowej reprezentacji bliźniaczej.
list_models	Pobierz listę modeli.
list_relationships	Pobieranie relacji dla cyfrowej reprezentacji bliźniaczej.
publish_component_telemetry	Opublikuj dane telemetryczne ze składnika cyfrowej reprezentacji bliźniaczej, która jest następnie zużywana przez jeden lub wiele docelowych punktów końcowych (subskrybentów) zdefiniowanych w ramach.
publish_telemetry	Opublikuj dane telemetryczne z cyfrowej reprezentacji bliźniaczej, która jest następnie zużywana przez jeden lub wiele docelowych punktów końcowych (subskrybentów) zdefiniowanych w obszarze.
query_twins	Wykonywanie zapytań dotyczących cyfrowych reprezentacji bliźniaczych. Uwaga: może wystąpić opóźnienie między zmianami w wystąpieniu, które zostaną odzwierciedlone w zapytaniach. Aby uzyskać więcej informacji na temat ograniczeń zapytań, zobacz https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations
update_component	Aktualizowanie właściwości składnika w cyfrowej reprezentacji bliźniaczej przy użyciu poprawki JSON.
update_digital_twin	Aktualizowanie cyfrowej reprezentacji bliźniaczej przy użyciu poprawki JSON.
update_relationship	Aktualizacje właściwości relacji w cyfrowej reprezentacji bliźniaczej przy użyciu poprawki JSON.
upsert_digital_twin	Tworzenie lub aktualizowanie cyfrowej reprezentacji bliźniaczej.
upsert_event_route	Tworzenie lub aktualizowanie trasy zdarzeń.
upsert_relationship	Tworzenie lub aktualizowanie relacji w cyfrowej reprezentacji bliźniaczej.

create_models

Utwórz co najmniej jeden model. W przypadku wystąpienia jakiegokolwiek błędu nie są przekazywane żadne modele.

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

Parametry

model_list

List[Dict[str,object]]

Wymagane

Zestaw modeli do utworzenia. Każdy dykt odpowiada dokładnie jednemu modelowi.

Zwraca

Lista utworzonych modeli.

Typ zwracany

List[DigitalTwinsModelData]

Wyjątki

HttpResponseError

ResourceExistsError

Co najmniej jeden z dostarczonych modeli już istnieje.

decommission_model

Likwiduje model.

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

Parametry

model_id

str

Wymagane

Identyfikator modelu. Identyfikator jest globalnie unikatowy i uwzględnia wielkość liter.

Zwraca

Brak

Typ zwracany

None

Wyjątki

HttpResponseError

ResourceNotFoundError

Brak modelu z podanym identyfikatorem.

delete_digital_twin

Usuwanie cyfrowej reprezentacji bliźniaczej.

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

Parametry

digital_twin_id

str

Wymagane

Identyfikator cyfrowej reprezentacji bliźniaczej.

match_condition

MatchConditions

Warunek, w którym należy wykonać operację.

etag

str

Wykonaj operację tylko wtedy, gdy tag jednostki pasuje do wartości podanej zgodnie z match_condition.

Zwraca

Brak

Typ zwracany

None

Wyjątki

HttpResponseError

ResourceNotFoundError

Jeśli nie ma cyfrowej reprezentacji bliźniaczej z podanym identyfikatorem.

delete_event_route

Usuń trasę zdarzenia.

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

Parametry

event_route_id

str

Wymagane

Identyfikator trasy zdarzenia do usunięcia.

Zwraca

Brak

Typ zwracany

None

Wyjątki

HttpResponseError

ResourceNotFoundError

Nie ma trasy zdarzeń o podanym identyfikatorze.

delete_model

Usuwanie modelu.

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

Parametry

model_id

str

Wymagane

Identyfikator modelu do usunięcia.

Zwraca

Brak

Typ zwracany

None

Wyjątki

HttpResponseError

ResourceNotFoundError

Brak modelu z podanym identyfikatorem.

ResourceExistsError

Istnieją zależności od modelu, które uniemożliwiają jego usunięcie.

delete_relationship

Usuwanie relacji w cyfrowej reprezentacji bliźniaczej.

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

Parametry

digital_twin_id

str

Wymagane

Identyfikator cyfrowej reprezentacji bliźniaczej.

relationship_id

str

Wymagane

Identyfikator relacji do usunięcia.

match_condition

MatchConditions

Warunek, w którym należy wykonać operację.

etag

str

Wykonaj operację tylko wtedy, gdy tag jednostki pasuje do wartości podanej zgodnie z match_condition.

Zwraca

Brak

Typ zwracany

None

Wyjątki

HttpResponseError

ResourceNotFoundError

Jeśli nie ma cyfrowej reprezentacji bliźniaczej lub relacji z podanym identyfikatorem.

get_component

Pobierz składnik w cyfrowej reprezentacji bliźniaczej.

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

Parametry

digital_twin_id

str

Wymagane

Identyfikator cyfrowej reprezentacji bliźniaczej.

component_name

str

Wymagane

Pobierany składnik.

Zwraca

Słownik zawierający składnik.

Typ zwracany

Dict[str, object]

Wyjątki

HttpResponseError

ResourceNotFoundError

Jeśli nie ma cyfrowej reprezentacji bliźniaczej z podanym identyfikatorem lub nazwa składnika jest nieprawidłowa.

get_digital_twin

Pobierz cyfrową reprezentację bliźniaczą.

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

Parametry

digital_twin_id

str

Wymagane

Identyfikator cyfrowej reprezentacji bliźniaczej.

Zwraca

Słownik zawierający bliźniaczą reprezentację.

Typ zwracany

Dict[str, object]

Wyjątki

HttpResponseError

ResourceNotFoundError

Jeśli cyfrowa reprezentacja bliźniacza nie istnieje.

get_event_route

Pobierz trasę zdarzenia.

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

Parametry

event_route_id

str

Wymagane

Identyfikator trasy zdarzenia.

Zwraca

Obiekt trasy zdarzenia.

Typ zwracany

DigitalTwinsEventRoute

Wyjątki

HttpResponseError

ResourceNotFoundError

Nie ma trasy zdarzeń o podanym identyfikatorze.

get_model

Pobierz model, w tym metadane modelu i definicję modelu.

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

Parametry

model_id

str

Wymagane

Identyfikator modelu.

include_model_definition

bool

Uwzględnij definicję modelu w ramach wyniku. Wartość domyślna to False.

Zwraca

Dane modelu.

Typ zwracany

DigitalTwinsModelData

Wyjątki

HttpResponseError

ResourceNotFoundError

Jeśli nie ma modelu z podanym identyfikatorem.

get_relationship

Uzyskaj relację na cyfrowej reprezentacji bliźniaczej.

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

Parametry

digital_twin_id

str

Wymagane

Identyfikator cyfrowej reprezentacji bliźniaczej.

relationship_id

str

Wymagane

Identyfikator relacji do pobrania.

Zwraca

Słownik zawierający relację.

Typ zwracany

Dict[str, object]

Wyjątki

HttpResponseError

ResourceNotFoundError

Jeśli nie ma cyfrowej reprezentacji bliźniaczej lub relacji z podanym identyfikatorem.

list_event_routes

Pobiera wszystkie trasy zdarzeń.

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

Parametry

results_per_page

int

Maksymalna liczba elementów do pobrania na żądanie. Serwer może zdecydować się zwrócić mniej niż żądana wartość maksymalna.

Zwraca

Wystąpienie iteratora tras zdarzeń.

Typ zwracany

ItemPaged[DigitalTwinsEventRoute]

Wyjątki

HttpResponseError

list_incoming_relationships

Pobierz wszystkie relacje przychodzące dla cyfrowej reprezentacji bliźniaczej.

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

Parametry

digital_twin_id

str

Wymagane

Identyfikator cyfrowej reprezentacji bliźniaczej.

Zwraca

Iterator, taki jak wystąpienie jednej z relacji.

Typ zwracany

ItemPaged[IncomingRelationship]

Wyjątki

HttpResponseError

ResourceNotFoundError

Jeśli nie ma cyfrowej reprezentacji bliźniaczej z podanym identyfikatorem.

list_models

Pobierz listę modeli.

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

Parametry

dependencies_for

List[str]

Wymagane

Identyfikatory modeli do pobrania zależności. W przypadku pominięcia wszystkie modele zostaną pobrane.

include_model_definition

bool

Uwzględnij definicję modelu w ramach wyników. Wartość domyślna to False.

results_per_page

int

Maksymalna liczba elementów do pobrania na żądanie. Serwer może zdecydować się zwrócić mniej niż żądana wartość maksymalna.

Zwraca

Iterator wystąpienia listy danych modelu.

Typ zwracany

ItemPaged[DigitalTwinsModelData]

Wyjątki

HttpResponseError

list_relationships

Pobieranie relacji dla cyfrowej reprezentacji bliźniaczej.

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

Parametry

digital_twin_id

str

Wymagane

Identyfikator cyfrowej reprezentacji bliźniaczej.

relationship_id

str

Wymagane

Identyfikator relacji do pobrania (jeśli nie zostanie pobrana żadna relacja).

Zwraca

Wystąpienie iteratora listy relacji

Typ zwracany

ItemPaged[Dict[str,object]]

Wyjątki

HttpResponseError

ResourceNotFoundError

Jeśli nie ma cyfrowej reprezentacji bliźniaczej z podanym identyfikatorem.

publish_component_telemetry

Opublikuj dane telemetryczne ze składnika cyfrowej reprezentacji bliźniaczej, która jest następnie zużywana przez jeden lub wiele docelowych punktów końcowych (subskrybentów) zdefiniowanych w ramach.

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

Parametry

digital_twin_id

str

Wymagane

Identyfikator cyfrowej reprezentacji bliźniaczej.

component_name

str

Wymagane

Nazwa składnika DTDL.

telemetry

object

Wymagane

Dane telemetryczne do wysłania.

message_id

str

Identyfikator komunikatu. Jeśli nie zostanie określony, zostanie wygenerowany identyfikator UUID.

Zwraca

Brak

Typ zwracany

None

Wyjątki

HttpResponseError

ResourceNotFoundError

Jeśli nie ma cyfrowej reprezentacji bliźniaczej z podanym identyfikatorem lub nazwa składnika jest nieprawidłowa.

publish_telemetry

Opublikuj dane telemetryczne z cyfrowej reprezentacji bliźniaczej, która jest następnie zużywana przez jeden lub wiele docelowych punktów końcowych (subskrybentów) zdefiniowanych w obszarze.

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

Parametry

digital_twin_id

str

Wymagane

Identyfikator cyfrowej reprezentacji bliźniaczej

telemetry

object

Wymagane

Dane telemetryczne do wysłania

message_id

str

Identyfikator komunikatu. Jeśli nie zostanie określony, zostanie wygenerowany identyfikator UUID.

Zwraca

Brak

Typ zwracany

None

Wyjątki

HttpResponseError

ResourceNotFoundError

Jeśli nie ma cyfrowej reprezentacji bliźniaczej z podanym identyfikatorem.

query_twins

Wykonywanie zapytań dotyczących cyfrowych reprezentacji bliźniaczych.

Uwaga: może wystąpić opóźnienie między zmianami w wystąpieniu, które zostaną odzwierciedlone w zapytaniach. Aby uzyskać więcej informacji na temat ograniczeń zapytań, zobacz https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations

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

Parametry

query_expression

str

Wymagane

Wyrażenie zapytania do wykonania.

Zwraca

Iterowalne wyniki zapytania.

Typ zwracany

ItemPaged[Dict[str, object]]

Wyjątki

HttpResponseError

update_component

Aktualizowanie właściwości składnika w cyfrowej reprezentacji bliźniaczej przy użyciu poprawki JSON.

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

Parametry

digital_twin_id

str

Wymagane

Identyfikator cyfrowej reprezentacji bliźniaczej.

component_name

str

Wymagane

Składnik, który jest aktualizowany.

json_patch

List[Dict[str,object]]

Wymagane

Specyfikacja aktualizacji opisana przez poprawkę JSON.

match_condition

MatchConditions

Warunek, w którym należy wykonać operację.

etag

str

Wykonaj operację tylko wtedy, gdy tag jednostki jest zgodny z wartością podaną zgodnie z match_condition.

Zwraca

Brak

Typ zwracany

None

Wyjątki

HttpResponseError

ResourceNotFoundError

Jeśli nie ma cyfrowej reprezentacji bliźniaczej z podanym identyfikatorem lub nazwa składnika jest nieprawidłowa.

update_digital_twin

Aktualizowanie cyfrowej reprezentacji bliźniaczej przy użyciu poprawki JSON.

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

Parametry

digital_twin_id

str

Wymagane

Identyfikator cyfrowej reprezentacji bliźniaczej.

json_patch

List[Dict[str,object]]

Wymagane

Specyfikacja aktualizacji opisana przez poprawkę JSON. Aktualizacje wartości właściwości i $model elementy mogą wystąpić w tym samym żądaniu. Operacje są ograniczone do dodawania, zastępowania i usuwania.

match_condition

MatchConditions

Warunek, w którym należy wykonać operację.

etag

str

Wykonaj operację tylko wtedy, gdy tag jednostki jest zgodny z wartością podaną zgodnie z match_condition.

Zwraca

Brak

Typ zwracany

None

Wyjątki

HttpResponseError

ResourceNotFoundError

Jeśli nie ma cyfrowej reprezentacji bliźniaczej z podanym identyfikatorem.

update_relationship

Aktualizacje właściwości relacji w cyfrowej reprezentacji bliźniaczej przy użyciu poprawki JSON.

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

Parametry

digital_twin_id

str

Wymagane

Identyfikator cyfrowej reprezentacji bliźniaczej.

relationship_id

str

Wymagane

Identyfikator relacji do pobrania.

json_patch

List[Dict[str,object]]

Wymagane

Opis poprawki JSON aktualizacji właściwości relacji.

match_condition

MatchConditions

Warunek, w którym należy wykonać operację.

etag

str

Wykonaj operację tylko wtedy, gdy tag jednostki jest zgodny z wartością podaną zgodnie z match_condition.

Zwraca

Brak

Typ zwracany

None

Wyjątki

HttpResponseError

ResourceNotFoundError

Jeśli nie ma cyfrowej reprezentacji bliźniaczej lub relacji z podanym identyfikatorem.

upsert_digital_twin

Tworzenie lub aktualizowanie cyfrowej reprezentacji bliźniaczej.

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

Parametry

digital_twin_id

str

Wymagane

Identyfikator cyfrowej reprezentacji bliźniaczej.

digital_twin

Dict[str,object]

Wymagane

Słownik zawierający bliźniaczą reprezentację do utworzenia lub zaktualizowania.

match_condition

MatchConditions

Warunek, w którym należy wykonać operację.

etag

str

Wykonaj operację tylko wtedy, gdy tag jednostki jest zgodny z wartością podaną zgodnie z match_condition.

Zwraca

Słownik zawierający utworzoną lub zaktualizowaną reprezentację bliźniaczą.

Typ zwracany

Dict[str, object]

Wyjątki

HttpResponseError

ResourceExistsError

Jeśli cyfrowy bliźniaczek już istnieje.

upsert_event_route

Tworzenie lub aktualizowanie trasy zdarzeń.

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

Parametry

event_route_id

str

Wymagane

Identyfikator trasy zdarzeń do utworzenia lub zaktualizowania.

event_route

DigitalTwinsEventRoute

Wymagane

Dane trasy zdarzenia.

Zwraca

Brak

Typ zwracany

None

Wyjątki

HttpResponseError

upsert_relationship

Tworzenie lub aktualizowanie relacji w cyfrowej reprezentacji bliźniaczej.

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

Parametry

digital_twin_id

str

Wymagane

Identyfikator cyfrowej reprezentacji bliźniaczej.

relationship_id

str

Wymagane

Identyfikator relacji do pobrania.

relationship

Dict[str,object]

Wymagane

Słownik zawierający relację.

match_condition

MatchConditions

Warunek, w którym należy wykonać operację.

etag

str

Wykonaj operację tylko wtedy, gdy tag jednostki jest zgodny z wartością podaną zgodnie z match_condition.

Zwraca

Utworzona lub zaktualizowana relacja.

Typ zwracany

Dict[str, object]

Wyjątki

HttpResponseError

ResourceNotFoundError

Jeśli nie ma cyfrowej reprezentacji bliźniaczej, należy określić docelową cyfrową reprezentację bliźniaczą lub relację z podanym identyfikatorem.