DigitalTwinsClient Klasa
Tworzy wystąpienie klienta usługi Digital Twins.
- Dziedziczenie
-
builtins.objectDigitalTwinsClient
Konstruktor
DigitalTwinsClient(endpoint: str, credential: AsyncTokenCredential, **kwargs)
Parametry
Metody
close | |
create_models |
Utwórz co najmniej jeden model. W przypadku wystąpienia dowolnego błędu nie są przekazywane żadne modele. |
decommission_model |
Likwiduje model. |
delete_digital_twin |
Usuwanie cyfrowej reprezentacji bliźniaczej. |
delete_event_route |
Usuwanie trasy zdarzeń. |
delete_model |
Usuwanie modelu. |
delete_relationship |
Usuwanie relacji w cyfrowej reprezentacji bliźniaczej. |
get_component |
Pobieranie składnika w cyfrowej reprezentacji bliźniaczej. |
get_digital_twin |
Pobierz cyfrową reprezentację bliźniaczą. |
get_event_route |
Pobieranie trasy zdarzeń. |
get_model |
Pobierz model, w tym metadane modelu i definicję modelu. |
get_relationship |
Uzyskiwanie relacji na cyfrowej reprezentacji bliźniaczej. |
list_event_routes |
Pobiera wszystkie trasy zdarzeń. |
list_incoming_relationships |
Pobieranie wszystkich relacji przychodzących 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óry jest następnie używany 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. |
close
async close() -> None
create_models
Utwórz co najmniej jeden model. W przypadku wystąpienia dowolnego błędu nie są przekazywane żadne modele.
async create_models(dtdl_models: List[object], **kwargs) -> List[DigitalTwinsModelData]
Parametry
Zestaw modeli do utworzenia. Każdy dykt odpowiada dokładnie jednemu modelowi.
Zwraca
Lista utworzonych modeli
Typ zwracany
Wyjątki
Co najmniej jeden z dostarczonych modeli już istnieje.
decommission_model
Likwiduje model.
async decommission_model(model_id: str, **kwargs) -> None
Parametry
- model_id
- str
Identyfikator modelu. Identyfikator jest globalnie unikatowy i uwzględnia wielkość liter.
Zwraca
Brak
Typ zwracany
Wyjątki
Nie ma modelu z podanym identyfikatorem.
delete_digital_twin
Usuwanie cyfrowej reprezentacji bliźniaczej.
async delete_digital_twin(digital_twin_id: str, **kwargs) -> None
Parametry
- 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
Wyjątki
Jeśli nie ma cyfrowej reprezentacji bliźniaczej z podanym identyfikatorem.
delete_event_route
Usuwanie trasy zdarzeń.
async delete_event_route(event_route_id: str, **kwargs) -> None
Parametry
Zwraca
Brak
Typ zwracany
Wyjątki
Nie ma trasy zdarzeń o podanym identyfikatorze.
delete_model
Usuwanie modelu.
async delete_model(model_id: str, **kwargs) -> None
Parametry
Zwraca
Brak
Typ zwracany
Wyjątki
Nie ma modelu z podanym identyfikatorem.
Istnieją zależności od modelu, które uniemożliwiają jego usunięcie.
delete_relationship
Usuwanie relacji w cyfrowej reprezentacji bliźniaczej.
async delete_relationship(digital_twin_id: str, relationship_id: str, **kwargs) -> None
Parametry
- 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
Wyjątki
Jeśli nie ma cyfrowej reprezentacji bliźniaczej lub relacji z podanym identyfikatorem.
get_component
Pobieranie składnika w cyfrowej reprezentacji bliźniaczej.
async get_component(digital_twin_id: str, component_name: str, **kwargs) -> Dict[str, object]
Parametry
Zwraca
Słownik zawierający składnik.
Typ zwracany
Wyjątki
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ą.
async get_digital_twin(digital_twin_id: str, **kwargs) -> Dict[str, object]
Parametry
Zwraca
Słownik zawierający bliźniaczą reprezentację.
Typ zwracany
Wyjątki
Jeśli cyfrowa reprezentacja bliźniaka nie istnieje.
get_event_route
Pobieranie trasy zdarzeń.
async get_event_route(event_route_id: str, **kwargs) -> DigitalTwinsEventRoute
Parametry
Zwraca
Obiekt trasy zdarzenia.
Typ zwracany
Wyjątki
Nie ma trasy zdarzeń o podanym identyfikatorze.
get_model
Pobierz model, w tym metadane modelu i definicję modelu.
async get_model(model_id: str, **kwargs) -> DigitalTwinsModelData
Parametry
- include_model_definition
- bool
Uwzględnij definicję modelu w ramach wyniku. Wartość domyślna to False.
Zwraca
Dane modelu.
Typ zwracany
Wyjątki
Jeśli nie ma modelu z podanym identyfikatorem.
get_relationship
Uzyskiwanie relacji na cyfrowej reprezentacji bliźniaczej.
async get_relationship(digital_twin_id: str, relationship_id: str, **kwargs) -> Dict[str, object]
Parametry
Zwraca
Słownik zawierający relację.
Typ zwracany
Wyjątki
Jeśli nie ma cyfrowej reprezentacji bliźniaczej lub relacji z podanym identyfikatorem.
list_event_routes
Pobiera wszystkie trasy zdarzeń.
list_event_routes(**kwargs) -> AsyncItemPaged[DigitalTwinsEventRoute]
Parametry
- results_per_page
- int
Maksymalna liczba elementów do pobrania na żądanie. Serwer może zdecydować się na zwrócenie mniejszej niż żądana wartość maksymalna.
Zwraca
Wystąpienie iteratora tras zdarzeń.
Typ zwracany
Wyjątki
list_incoming_relationships
Pobieranie wszystkich relacji przychodzących dla cyfrowej reprezentacji bliźniaczej.
list_incoming_relationships(digital_twin_id: str, **kwargs) -> AsyncItemPaged[IncomingRelationship]
Parametry
Zwraca
Wystąpienie iteratora listy relacji przychodzących.
Typ zwracany
Wyjątki
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) -> AsyncItemPaged[DigitalTwinsModelData]
Parametry
Identyfikatory modeli do pobrania zależności. W przypadku pominięcia wszystkie modele są pobierane.
- include_model_definition
- bool
Uwzględnij definicję modelu jako część wyników. Wartość domyślna to False.
- results_per_page
- int
Maksymalna liczba elementów do pobrania na żądanie. Serwer może zdecydować się na zwrócenie mniejszej niż żądana wartość maksymalna.
Zwraca
Wystąpienie iteratora listy danych modelu.
Typ zwracany
Wyjątki
list_relationships
Pobieranie relacji dla cyfrowej reprezentacji bliźniaczej.
list_relationships(digital_twin_id: str, relationship_id: str | None = None, **kwargs) -> AsyncItemPaged[Dict[str, object]]
Parametry
- relationship_id
- str
Identyfikator relacji do pobrania (jeśli nie zostaną pobrane wszystkie relacje).
Zwraca
Wystąpienie iteratora listy relacji.
Typ zwracany
Wyjątki
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óry jest następnie używany przez jeden lub wiele docelowych punktów końcowych (subskrybentów) zdefiniowanych w ramach.
async publish_component_telemetry(digital_twin_id: str, component_name: str, telemetry: object, **kwargs) -> None
Parametry
- message_id
- str
Identyfikator komunikatu. Jeśli nie zostanie określony, zostanie wygenerowany identyfikator UUID.
Zwraca
Brak
Typ zwracany
Wyjątki
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.
async publish_telemetry(digital_twin_id: str, telemetry: object, **kwargs) -> None
Parametry
- message_id
- str
Identyfikator komunikatu. Jeśli nie zostanie określony, zostanie wygenerowany identyfikator UUID.
Zwraca
Brak
Typ zwracany
Wyjątki
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) -> AsyncItemPaged[Dict[str, object]]
Parametry
Zwraca
Iterowalne wyniki zapytania.
Typ zwracany
Wyjątki
update_component
Aktualizowanie właściwości składnika w cyfrowej reprezentacji bliźniaczej przy użyciu poprawki JSON.
async update_component(digital_twin_id: str, component_name: str, json_patch: List[Dict[str, object]], **kwargs) -> None
Parametry
- 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
Wyjątki
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.
async update_digital_twin(digital_twin_id: str, json_patch: List[Dict[str, object]], **kwargs) -> None
Parametry
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
Wyjątki
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.
async update_relationship(digital_twin_id: str, relationship_id: str, json_patch: List[Dict[str, object]], **kwargs) -> None
Parametry
- 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
Wyjątki
Jeśli nie ma cyfrowej reprezentacji bliźniaczej lub relacji z podanym identyfikatorem.
upsert_digital_twin
Tworzenie lub aktualizowanie cyfrowej reprezentacji bliźniaczej.
async upsert_digital_twin(digital_twin_id: str, digital_twin: Dict[str, object], **kwargs) -> Dict[str, object]
Parametry
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
Wyjątki
Jeśli cyfrowy bliźniaczek już istnieje.
upsert_event_route
Tworzenie lub aktualizowanie trasy zdarzeń.
async upsert_event_route(event_route_id: str, event_route: DigitalTwinsEventRoute, **kwargs) -> None
Parametry
Zwraca
Brak
Typ zwracany
Wyjątki
upsert_relationship
Tworzenie lub aktualizowanie relacji w cyfrowej reprezentacji bliźniaczej.
async upsert_relationship(digital_twin_id: str, relationship_id: str, relationship: Dict[str, object], **kwargs) -> Dict[str, object]
Parametry
- 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
Wyjątki
Jeśli nie ma cyfrowej reprezentacji bliźniaczej, należy określić docelową cyfrową reprezentację bliźniaczą lub relację z podanym identyfikatorem.
Azure SDK for Python
Opinia
https://aka.ms/ContentUserFeedback.
Dostępne już wkrótce: W 2024 r. będziemy stopniowo wycofywać zgłoszenia z serwisu GitHub jako mechanizm przesyłania opinii na temat zawartości i zastępować go nowym systemem opinii. Aby uzyskać więcej informacji, sprawdź:Prześlij i wyświetl opinię dla