DigitalTwinClient Sınıf
Otomatik olarak oluşturulan IotHub REST API'lerini temel alarak DigitalTwin işlemleri için kolay API'ler sağlayan bir sınıf
DigitalTwinClient başlatıcısı.
Başarılı bir oluşturma işleminden sonra sınıfın kimliği IoTHub ile doğrulanır ve IoTHub ile iletişim kurmak için üye API'leri çağırmaya hazır olur.
- Devralma
-
builtins.objectDigitalTwinClient
Oluşturucu
DigitalTwinClient(connection_string=None, host=None, auth=None)Parametreler
| Name | Description |
|---|---|
|
connection_string
|
connection_str kimlik doğrulaması kullanıyorsak IoTHub ile bağlantının kimliğini doğrulamak için kullanılan IoTHub bağlantı dizesi. Varsayılan değer: Yok varsayılan değer: None
|
|
host
|
Belirteç kimlik bilgisi kimlik doğrulaması kullanıyorsak Azure hizmeti URL'si. Varsayılan değer: Yok varsayılan değer: None
|
|
auth
|
Belirteç kimlik bilgisi kimlik doğrulaması kullanıyorsak Azure kimlik doğrulama nesnesi. Varsayılan değer: Yok varsayılan değer: None
|
Yöntemler
| from_connection_string |
DigitalTwinClient Hizmeti istemcisi için Classmethod başlatıcısı. Bağlantı dizesinden DigitalTwinClient sınıfı oluşturur. Başarılı bir oluşturma işleminden sonra sınıfın kimliği IoTHub ile doğrulanır ve IoTHub ile iletişim kurmak için üye API'leri çağırmaya hazır olur. |
| from_token_credential |
DigitalTwinClient Hizmeti istemcisi için Classmethod başlatıcısı. Ana bilgisayar adı URL'sinden ve Azure belirteci kimlik bilgisinden DigitalTwinClient sınıfı oluşturur. Başarılı bir oluşturma işleminden sonra sınıfın kimliği IoTHub ile doğrulanır ve IoTHub ile iletişim kurmak için üye API'leri çağırmaya hazır olur. |
| get_digital_twin |
Belirli bir cihazın Dijital İkizini alın. :p aram str digital_twin__id: Verilen cihazın dijital ikiz kimliği. |
| invoke_command |
Belirli bir cihazda bir komut çağırın ve bunun sonucunu alın. :p aram str digital_twin__id: Verilen cihazın dijital ikiz kimliği. :p aram str command_name: Komutun adı. :p aram str yükü: Komutun bağımsız değişkeni. :p aram int connect_timeout_in_seconds: Dijital ikiz komutunun yanıtı bekleyeceği en uzun zaman aralığı (saniye cinsinden). :p aram int response_timeout_in_seconds: Dijital ikiz komutunun yanıtı bekleyeceği en uzun zaman aralığı (saniye cinsinden). Değer 5-300 içinde olmalıdır. |
| invoke_component_command |
Belirli bir cihazın bileşeninde bir komut çağırın ve bunun sonucunu alın. :p aram str digital_twin__id: Verilen cihazın dijital ikiz kimliği. :p aram str component_path: Bileşenin adı. :p aram str command_name: Komutun adı. :p aram str yükü: Komutun bağımsız değişkeni. :p aram int connect_timeout_in_seconds: Dijital ikiz komutunun yanıtı bekleyeceği en uzun zaman aralığı (saniye cinsinden). :p aram int response_timeout_in_seconds: Dijital ikiz komutunun yanıtı bekleyeceği en uzun zaman aralığı (saniye cinsinden). Değer 5-300 içinde olmalıdır. :type response_timeout_in_seconds: int |
| update_digital_twin |
Bir düzeltme eki nesnesi kullanarak belirli bir cihazın Dijital İkiz Bileşenini güncelleştirin. :p aram str digital_twin__id: Verilen cihazın dijital ikiz kimliği. :p aram list[object]: Digital Twin'i güncelleştirmek için json-patch nesnesi. :p aram str etag: Güncelleştirme işlemi için kullanılacak etag (if_match) değeri. |
from_connection_string
DigitalTwinClient Hizmeti istemcisi için Classmethod başlatıcısı. Bağlantı dizesinden DigitalTwinClient sınıfı oluşturur.
Başarılı bir oluşturma işleminden sonra sınıfın kimliği IoTHub ile doğrulanır ve IoTHub ile iletişim kurmak için üye API'leri çağırmaya hazır olur.
from_connection_string(connection_string)Parametreler
| Name | Description |
|---|---|
|
connection_string
Gerekli
|
IoTHub ile bağlantı kimliğini doğrulamak için kullanılan IoTHub bağlantı dizesi. |
Döndürülenler
| Tür | Description |
|---|---|
from_token_credential
DigitalTwinClient Hizmeti istemcisi için Classmethod başlatıcısı. Ana bilgisayar adı URL'sinden ve Azure belirteci kimlik bilgisinden DigitalTwinClient sınıfı oluşturur.
Başarılı bir oluşturma işleminden sonra sınıfın kimliği IoTHub ile doğrulanır ve IoTHub ile iletişim kurmak için üye API'leri çağırmaya hazır olur.
from_token_credential(url, token_credential)Parametreler
| Name | Description |
|---|---|
|
url
Gerekli
|
Azure hizmet URL'si (ana bilgisayar adı). |
|
token_credential
Gerekli
|
<xref:azure.core.TokenCredential>
Azure belirteci kimlik bilgisi nesnesi |
Döndürülenler
| Tür | Description |
|---|---|
get_digital_twin
Belirli bir cihazın Dijital İkizini alın. :p aram str digital_twin__id: Verilen cihazın dijital ikiz kimliği.
get_digital_twin(digital_twin_id)Parametreler
| Name | Description |
|---|---|
|
digital_twin_id
Gerekli
|
|
Döndürülenler
| Tür | Description |
|---|---|
|
Digital Twin'i içeren dönüş nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
invoke_command
Belirli bir cihazda bir komut çağırın ve bunun sonucunu alın. :p aram str digital_twin__id: Verilen cihazın dijital ikiz kimliği. :p aram str command_name: Komutun adı. :p aram str yükü: Komutun bağımsız değişkeni. :p aram int connect_timeout_in_seconds: Dijital ikiz komutunun yanıtı bekleyeceği en uzun zaman aralığı (saniye cinsinden). :p aram int response_timeout_in_seconds: Dijital ikiz komutunun yanıtı bekleyeceği en uzun zaman aralığı (saniye cinsinden). Değer 5-300 içinde olmalıdır.
invoke_command(digital_twin_id, command_name, payload, connect_timeout_in_seconds=None, response_timeout_in_seconds=None)Parametreler
| Name | Description |
|---|---|
|
digital_twin_id
Gerekli
|
|
|
command_name
Gerekli
|
|
|
payload
Gerekli
|
|
|
connect_timeout_in_seconds
|
varsayılan değer: None
|
|
response_timeout_in_seconds
|
varsayılan değer: None
|
Döndürülenler
| Tür | Description |
|---|---|
|
Çağrılan komutun sonucu. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
invoke_component_command
Belirli bir cihazın bileşeninde bir komut çağırın ve bunun sonucunu alın. :p aram str digital_twin__id: Verilen cihazın dijital ikiz kimliği. :p aram str component_path: Bileşenin adı. :p aram str command_name: Komutun adı. :p aram str yükü: Komutun bağımsız değişkeni. :p aram int connect_timeout_in_seconds: Dijital ikiz komutunun yanıtı bekleyeceği en uzun zaman aralığı (saniye cinsinden). :p aram int response_timeout_in_seconds: Dijital ikiz komutunun yanıtı bekleyeceği en uzun zaman aralığı (saniye cinsinden). Değer 5-300 içinde olmalıdır. :type response_timeout_in_seconds: int
invoke_component_command(digital_twin_id, component_path, command_name, payload, connect_timeout_in_seconds=None, response_timeout_in_seconds=None)Parametreler
| Name | Description |
|---|---|
|
digital_twin_id
Gerekli
|
|
|
component_path
Gerekli
|
|
|
command_name
Gerekli
|
|
|
payload
Gerekli
|
|
|
connect_timeout_in_seconds
|
varsayılan değer: None
|
|
response_timeout_in_seconds
|
varsayılan değer: None
|
Döndürülenler
| Tür | Description |
|---|---|
|
Çağrılan komutun sonucu. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
update_digital_twin
Bir düzeltme eki nesnesi kullanarak belirli bir cihazın Dijital İkiz Bileşenini güncelleştirin. :p aram str digital_twin__id: Verilen cihazın dijital ikiz kimliği. :p aram list[object]: Digital Twin'i güncelleştirmek için json-patch nesnesi. :p aram str etag: Güncelleştirme işlemi için kullanılacak etag (if_match) değeri.
update_digital_twin(digital_twin_id, digital_twin_patch, etag=None)Parametreler
| Name | Description |
|---|---|
|
digital_twin_id
Gerekli
|
|
|
digital_twin_patch
Gerekli
|
|
|
etag
|
varsayılan değer: None
|
Döndürülenler
| Tür | Description |
|---|---|
|
Güncelleştirilmiş Digital Twin'i içeren dönüş nesnesi. |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>
|
Azure SDK for Python
Geri Bildirim
Çok yakında: 2024 boyunca, içerik için geri bildirim mekanizması olarak GitHub Sorunları’nı kullanımdan kaldıracak ve yeni bir geri bildirim sistemiyle değiştireceğiz. Daha fazla bilgi için bkz. https://aka.ms/ContentUserFeedback.
Gönderin ve geri bildirimi görüntüleyin