DigitalTwinsClient Sınıf

Digital Twins istemcisinin bir örneğini oluşturur.

Devralma

builtins.object

DigitalTwinsClient

Oluşturucu

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

Parametreler

endpoint

str

Gerekli

Azure arama hizmetinin URL uç noktası

credential

TokenCredential

Gerekli

Hizmete yönelik isteklerin kimliğini doğrulamak için bir kimlik bilgisi

Yöntemler

create_models	Bir veya daha fazla model oluşturun. Herhangi bir hata oluştuğunda hiçbir model karşıya yüklenmez.
decommission_model	Modelin yetkisini alır.
delete_digital_twin	Dijital ikizleri silme.
delete_event_route	Olay rotasını silin.
delete_model	Modeli silme.
delete_relationship	Dijital ikizdeki bir ilişkiyi silme.
get_component	Dijital ikizde bileşen alma.
get_digital_twin	Dijital ikiz alın.
get_event_route	Bir olay yolu alın.
get_model	Model meta verileri ve model tanımı dahil olmak üzere bir model alın.
get_relationship	Dijital ikizde ilişki edinin.
list_event_routes	Tüm olay yollarını alır.
list_incoming_relationships	Dijital ikiz için tüm gelen ilişkileri alma.
list_models	Modellerin listesini alın.
list_relationships	Dijital ikiz için ilişkileri alma.
publish_component_telemetry	Bir dijital ikizin bileşeninden telemetri yayımlayın. Bu, daha sonra altında tanımlanan bir veya birden çok hedef uç nokta (abone) tarafından kullanılır.
publish_telemetry	Bir dijital ikizden telemetri yayımlayın. Bu telemetri daha sonra altında tanımlanan bir veya daha fazla hedef uç nokta (abone) tarafından kullanılır.
query_twins	Dijital ikizleri sorgula. Not: Örneğinizdeki değişikliklerin sorgulara yansıtılması arasında bir gecikme olabileceğini unutmayın. Sorgu sınırlamaları hakkında daha fazla ayrıntı için bkz. https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations
update_component	JSON düzeltme eki kullanarak dijital ikiz üzerindeki bir bileşenin özelliklerini güncelleştirin.
update_digital_twin	JSON yaması kullanarak dijital ikizi güncelleştirme.
update_relationship	JSON yaması kullanarak dijital ikiz üzerindeki bir ilişkinin özelliklerini Güncelleştirmeler.
upsert_digital_twin	Dijital ikiz oluşturma veya güncelleştirme.
upsert_event_route	Olay yolu oluşturun veya güncelleştirin.
upsert_relationship	Dijital ikizde ilişki oluşturma veya güncelleştirme.

create_models

Bir veya daha fazla model oluşturun. Herhangi bir hata oluştuğunda hiçbir model karşıya yüklenmez.

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

Parametreler

model_list

List[Dict[str,object]]

Gerekli

Oluşturulacak model kümesi. Her dikte tam olarak bir modele karşılık gelir.

Döndürülenler

Oluşturulan modellerin listesi.

Dönüş türü

List[DigitalTwinsModelData]

Özel durumlar

HttpResponseError

ResourceExistsError

Sağlanan modellerden biri veya daha fazlası zaten var.

decommission_model

Modelin yetkisini alır.

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

Parametreler

model_id

str

Gerekli

Modelin kimliği. Kimlik genel olarak benzersizdir ve büyük/küçük harfe duyarlıdır.

Döndürülenler

Hiçbiri

Dönüş türü

None

Özel durumlar

HttpResponseError

ResourceNotFoundError

Sağlanan kimliği içeren bir model yok.

delete_digital_twin

Dijital ikizleri silme.

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

Parametreler

digital_twin_id

str

Gerekli

Dijital ikizin kimliği.

match_condition

MatchConditions

İşlemin gerçekleştirildiği koşul.

etag

str

yalnızca varlığın etag'i match_condition göre sağlanan değerle eşleşiyorsa işlemi gerçekleştirin.

Döndürülenler

Hiçbiri

Dönüş türü

None

Özel durumlar

HttpResponseError

ResourceNotFoundError

Sağlanan kimlikle dijital ikiz yoksa.

delete_event_route

Olay rotasını silin.

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

Parametreler

event_route_id

str

Gerekli

Silinecek olay yolunun kimliği.

Döndürülenler

Hiçbiri

Dönüş türü

None

Özel durumlar

HttpResponseError

ResourceNotFoundError

Sağlanan kimlikle bir olay yolu yok.

delete_model

Modeli silme.

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

Parametreler

model_id

str

Gerekli

Silinecek modelin kimliği.

Döndürülenler

Hiçbiri

Dönüş türü

None

Özel durumlar

HttpResponseError

ResourceNotFoundError

Sağlanan kimliği içeren bir model yok.

ResourceExistsError

Modelin silinmesini engelleyen bağımlılıklar vardır.

delete_relationship

Dijital ikizdeki bir ilişkiyi silme.

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

Parametreler

digital_twin_id

str

Gerekli

Dijital ikizin kimliği.

relationship_id

str

Gerekli

Silinecek ilişkinin kimliği.

match_condition

MatchConditions

İşlemin gerçekleştirildiği koşul.

etag

str

yalnızca varlığın etag'i match_condition göre sağlanan değerle eşleşiyorsa işlemi gerçekleştirin.

Döndürülenler

Hiçbiri

Dönüş türü

None

Özel durumlar

HttpResponseError

ResourceNotFoundError

Dijital ikiz veya sağlanan kimlikle ilişki yoksa.

get_component

Dijital ikizde bileşen alma.

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

Parametreler

digital_twin_id

str

Gerekli

Dijital ikizin kimliği.

component_name

str

Gerekli

Alınan bileşen.

Döndürülenler

Bileşeni içeren sözlük.

Dönüş türü

Dict[str, object]

Özel durumlar

HttpResponseError

ResourceNotFoundError

Sağlanan kimliği içeren bir dijital ikiz yoksa veya bileşen adı geçersizse.

get_digital_twin

Dijital ikiz alın.

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

Parametreler

digital_twin_id

str

Gerekli

Dijital ikizin kimliği.

Döndürülenler

İkizi içeren sözlük.

Dönüş türü

Dict[str, object]

Özel durumlar

HttpResponseError

ResourceNotFoundError

Dijital ikiz yoksa.

get_event_route

Bir olay yolu alın.

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

Parametreler

event_route_id

str

Gerekli

Olay yolunun kimliği.

Döndürülenler

Olay yolu nesnesi.

Dönüş türü

DigitalTwinsEventRoute

Özel durumlar

HttpResponseError

ResourceNotFoundError

Sağlanan kimlikle bir olay yolu yok.

get_model

Model meta verileri ve model tanımı dahil olmak üzere bir model alın.

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

Parametreler

model_id

str

Gerekli

Modelin kimliği.

include_model_definition

bool

Sonucun bir parçası olarak model tanımını ekleyin. Varsayılan değer False'tur.

Döndürülenler

Model verileri.

Dönüş türü

DigitalTwinsModelData

Özel durumlar

HttpResponseError

ResourceNotFoundError

Sağlanan kimliği içeren bir model yoksa.

get_relationship

Dijital ikizde ilişki edinin.

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

Parametreler

digital_twin_id

str

Gerekli

Dijital ikizin kimliği.

relationship_id

str

Gerekli

Alınacak ilişkinin kimliği.

Döndürülenler

İlişkiyi içeren sözlük.

Dönüş türü

Dict[str, object]

Özel durumlar

HttpResponseError

ResourceNotFoundError

Dijital ikiz veya sağlanan kimlikle ilişki yoksa.

list_event_routes

Tüm olay yollarını alır.

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

Parametreler

results_per_page

int

İstek başına alınacak en fazla öğe sayısı. Sunucu istenen maksimum değerden daha az döndürmeyi seçebilir.

Döndürülenler

Olay yollarının yineleyici örneği.

Dönüş türü

ItemPaged[DigitalTwinsEventRoute]

Özel durumlar

HttpResponseError

list_incoming_relationships

Dijital ikiz için tüm gelen ilişkileri alma.

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

Parametreler

digital_twin_id

str

Gerekli

Dijital ikizin kimliği.

Döndürülenler

her iki İlişki örneği gibi bir yineleyici.

Dönüş türü

ItemPaged[IncomingRelationship]

Özel durumlar

HttpResponseError

ResourceNotFoundError

Sağlanan kimlikle dijital ikiz yoksa.

list_models

Modellerin listesini alın.

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

Parametreler

dependencies_for

List[str]

Gerekli

Bağımlılıkların alınması için model kimlikleri. Atlanırsa, tüm modeller alınır.

include_model_definition

bool

Model tanımını sonuçların bir parçası olarak ekleyin. Varsayılan değer False'tur.

results_per_page

int

İstek başına alınacak en fazla öğe sayısı. Sunucu istenen maksimum değerden daha az döndürmeyi seçebilir.

Döndürülenler

Model verilerinin listesinin yineleyici örneği.

Dönüş türü

ItemPaged[DigitalTwinsModelData]

Özel durumlar

HttpResponseError

list_relationships

Dijital ikiz için ilişkileri alma.

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

Parametreler

digital_twin_id

str

Gerekli

Dijital ikizin kimliği.

relationship_id

str

Gerekli

Alınacak ilişkinin kimliği (Hiçbiri ise tüm ilişki alınır).

Döndürülenler

İlişki listesinin yineleyici örneği

Dönüş türü

ItemPaged[Dict[str,object]]

Özel durumlar

HttpResponseError

ResourceNotFoundError

Sağlanan kimlikle dijital ikiz yoksa.

publish_component_telemetry

Bir dijital ikizin bileşeninden telemetri yayımlayın. Bu, daha sonra altında tanımlanan bir veya birden çok hedef uç nokta (abone) tarafından kullanılır.

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

Parametreler

digital_twin_id

str

Gerekli

Dijital ikizin kimliği.

component_name

str

Gerekli

DTDL bileşeninin adı.

telemetry

object

Gerekli

Gönderilecek telemetri verileri.

message_id

str

İleti kimliği. Belirtilmezse bir UUID oluşturulur.

Döndürülenler

Hiçbiri

Dönüş türü

None

Özel durumlar

HttpResponseError

ResourceNotFoundError

Sağlanan kimliği içeren bir dijital ikiz yoksa veya bileşen adı geçersizse.

publish_telemetry

Bir dijital ikizden telemetri yayımlayın. Bu telemetri daha sonra altında tanımlanan bir veya daha fazla hedef uç nokta (abone) tarafından kullanılır.

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

Parametreler

digital_twin_id

str

Gerekli

Dijital ikizin kimliği

telemetry

object

Gerekli

Gönderilecek telemetri verileri

message_id

str

İleti kimliği. Belirtilmezse bir UUID oluşturulur.

Döndürülenler

Hiçbiri

Dönüş türü

None

Özel durumlar

HttpResponseError

ResourceNotFoundError

Sağlanan kimlikle dijital ikiz yoksa.

query_twins

Dijital ikizleri sorgula.

Not: Örneğinizdeki değişikliklerin sorgulara yansıtılması arasında bir gecikme olabileceğini unutmayın. Sorgu sınırlamaları hakkında daha fazla ayrıntı için bkz. https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations

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

Parametreler

query_expression

str

Gerekli

Yürütülecek sorgu ifadesi.

Döndürülenler

Sorgu sonuçlarının yinelenebilir bir örneği.

Dönüş türü

ItemPaged[Dict[str, object]]

Özel durumlar

HttpResponseError

update_component

JSON düzeltme eki kullanarak dijital ikiz üzerindeki bir bileşenin özelliklerini güncelleştirin.

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

Parametreler

digital_twin_id

str

Gerekli

Dijital ikizin kimliği.

component_name

str

Gerekli

Güncelleştirilen bileşen.

json_patch

List[Dict[str,object]]

Gerekli

JSON Düzeltme Eki tarafından açıklanan bir güncelleştirme belirtimi.

match_condition

MatchConditions

İşlemin gerçekleştirildiği koşul.

etag

str

İşlemi yalnızca varlığın etag'i match_condition göre sağlanan değerle eşleşiyorsa gerçekleştirin.

Döndürülenler

Hiçbiri

Dönüş türü

None

Özel durumlar

HttpResponseError

ResourceNotFoundError

Sağlanan kimlikle dijital ikiz yoksa veya bileşen adı geçersizse.

update_digital_twin

JSON yaması kullanarak dijital ikizi güncelleştirme.

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

Parametreler

digital_twin_id

str

Gerekli

Dijital ikizin kimliği.

json_patch

List[Dict[str,object]]

Gerekli

JSON Düzeltme Eki tarafından açıklanan bir güncelleştirme belirtimi. Özellik değerlerine ve $model öğelerine Güncelleştirmeler aynı istekte gerçekleşebilir. İşlemler ekleme, değiştirme ve kaldırma işlemleriyle sınırlıdır.

match_condition

MatchConditions

İşlemin gerçekleştirildiği koşul.

etag

str

İşlemi yalnızca varlığın etag'i match_condition göre sağlanan değerle eşleşiyorsa gerçekleştirin.

Döndürülenler

Hiçbiri

Dönüş türü

None

Özel durumlar

HttpResponseError

ResourceNotFoundError

Sağlanan kimlikle dijital ikiz yoksa.

update_relationship

JSON yaması kullanarak dijital ikiz üzerindeki bir ilişkinin özelliklerini Güncelleştirmeler.

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

Parametreler

digital_twin_id

str

Gerekli

Dijital ikizin kimliği.

relationship_id

str

Gerekli

Alınacak ilişkinin kimliği.

json_patch

List[Dict[str,object]]

Gerekli

İlişki özelliklerine yapılan güncelleştirmenin JSON Düzeltme Eki açıklaması.

match_condition

MatchConditions

İşlemin gerçekleştirildiği koşul.

etag

str

İşlemi yalnızca varlığın etag'i match_condition göre sağlanan değerle eşleşiyorsa gerçekleştirin.

Döndürülenler

Hiçbiri

Dönüş türü

None

Özel durumlar

HttpResponseError

ResourceNotFoundError

Dijital ikiz veya sağlanan kimlikle ilişki yoksa.

upsert_digital_twin

Dijital ikiz oluşturma veya güncelleştirme.

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

Parametreler

digital_twin_id

str

Gerekli

Dijital ikizin kimliği.

digital_twin

Dict[str,object]

Gerekli

Oluşturulacak veya güncelleştirilecek ikizi içeren sözlük.

match_condition

MatchConditions

İşlemin gerçekleştirildiği koşul.

etag

str

İşlemi yalnızca varlığın etag'i match_condition göre sağlanan değerle eşleşiyorsa gerçekleştirin.

Döndürülenler

Oluşturulan veya güncelleştirilmiş ikizi içeren sözlük.

Dönüş türü

Dict[str, object]

Özel durumlar

HttpResponseError

ResourceExistsError

Dijital ikiz zaten varsa.

upsert_event_route

Olay yolu oluşturun veya güncelleştirin.

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

Parametreler

event_route_id

str

Gerekli

Oluşturulacak veya güncelleştirilecek olay yolunun kimliği.

event_route

DigitalTwinsEventRoute

Gerekli

Olay yönlendirme verileri.

Döndürülenler

Hiçbiri

Dönüş türü

None

Özel durumlar

HttpResponseError

upsert_relationship

Dijital ikizde ilişki oluşturma veya güncelleştirme.

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

Parametreler

digital_twin_id

str

Gerekli

Dijital ikizin kimliği.

relationship_id

str

Gerekli

Alınacak ilişkinin kimliği.

relationship

Dict[str,object]

Gerekli

İlişkiyi içeren sözlük.

match_condition

MatchConditions

İşlemin gerçekleştirildiği koşul.

etag

str

İşlemi yalnızca varlığın etag'i match_condition göre sağlanan değerle eşleşiyorsa gerçekleştirin.

Döndürülenler

Oluşturulan veya güncelleştirilen ilişki.

Dönüş türü

Dict[str, object]

Özel durumlar

HttpResponseError

ResourceNotFoundError

Dijital ikiz yoksa, dijital ikizi veya sağlanan kimlikle ilişkiyi hedefle.