IoTHubModuleClient Sınıf
bir Azure IoT Hub veya Azure IoT Edge örneğine bağlanan zaman uyumlu modül istemcisi.
IoTHubModuleClient başlatıcısı.
Bu başlatıcı doğrudan çağrılmamalıdır. Bunun yerine, örneği başlatmak için '>>create_from_<<' classmethods'lardan birini kullanın
- Devralma
-
azure.iot.device.iothub.sync_clients.GenericIoTHubClientIoTHubModuleClientazure.iot.device.iothub.abstract_clients.AbstractIoTHubModuleClientIoTHubModuleClient
Oluşturucu
IoTHubModuleClient(mqtt_pipeline, http_pipeline)Parametreler
- mqtt_pipeline
- <xref:azure.iot.device.iothub.pipeline.MQTTPipeline>
IoTHub uç noktasına bağlanmak için kullanılan işlem hattı.
- http_pipeline
- <xref:azure.iot.device.iothub.pipeline.HTTPPipeline>
HTTP aracılığıyla IoTHub uç noktasına bağlanmak için kullanılan işlem hattı.
Yöntemler
| connect |
İstemciyi bir Azure IoT Hub veya Azure IoT Edge Hub örneğine bağlar. Hedef, bu nesne başlatıldığında sağlanan auth_provider parametresi aracılığıyla geçirilen kimlik bilgilerine göre seçilir. Bu zaman uyumlu bir çağrıdır, yani hizmet bağlantısı tamamen kurulana kadar bu işlev döndürülmeyecektir. |
| create_from_connection_string |
IoTHub cihazından veya modül bağlantı dizesinden istemcinin örneğini oluşturun. |
| create_from_edge_environment |
İstemcinin örneğini IoT Edge ortamından oluşturun. Bu yöntem yalnızca bir IoT Edge kapsayıcısından veya Edge geliştirmesi için yapılandırılmış bir hata ayıklama ortamında çalıştırılabilir (örneğin, Visual Studio, Visual Studio Code) |
| create_from_sastoken |
önceden oluşturulmuş bir SAS Belirteci dizesinden istemci örneği oluşturma |
| create_from_x509_certificate |
X509 sertifika kimlik doğrulamayı kullanarak bir istemci örneği oluşturun. |
| disconnect |
İstemcinin Azure IoT Hub veya Azure IoT Edge Hub örneğinin bağlantısını kesin. İstemci örneğinizle tamamen işiniz bittiğinde bu işlevi çağırdığınızdan emin olmanız önerilir. Bu zaman uyumlu bir çağrıdır, yani hizmet bağlantısı tamamen kapatılana kadar bu işlev döndürülmeyecektir. |
| get_twin |
cihazı veya modül ikizini Azure IoT Hub veya Azure IoT Edge Hub hizmetinden alır. Bu zaman uyumlu bir çağrıdır, yani ikiz hizmetten alınana kadar bu işlev döndürülmeyecektir. |
| invoke_method |
İstemcinizden bir cihaz veya modül istemcisine bir yöntem çağırın ve yöntem çağrısının yanıtını alın. |
| patch_twin_reported_properties |
Bildirilen özellikleri Azure IoT Hub veya Azure IoT Edge Hub hizmetiyle güncelleştirin. Bu zaman uyumlu bir çağrıdır, yani düzeltme eki hizmete gönderilene ve onaylanana kadar bu işlev döndürülmeyecektir. Hizmet düzeltme eki işlemiyle ilgili bir hata döndürürse, bu işlev uygun hatayı oluşturur. |
| receive_message_on_input |
Başka bir Modülden belirli bir girişe gönderilen bir giriş iletisi alın. Sürüm 2.3.0'dan bu yana kullanım dışı: bunun yerine işleyici ayarlamak için .on_message_received özelliğini kullanmanızı öneririz |
| receive_method_request |
Azure IoT Hub veya Azure IoT Edge Hub aracılığıyla bir yöntem isteği alın. Sürüm 2.3.0'dan bu yana kullanım dışı: bunun yerine işleyici ayarlamak için .on_method_request_received özelliğini kullanmanızı öneririz |
| receive_twin_desired_properties_patch |
Azure IoT Hub veya Azure IoT Edge Hub aracılığıyla istenen özellik düzeltme ekini alın. Bu zaman uyumlu bir çağrıdır ve şu anlama gelir:
Sürüm 2.3.0'dan bu yana kullanım dışı: bunun yerine bir işleyici ayarlamak için .on_twin_desired_properties_patch_received özelliğini kullanmanızı öneririz |
| send_message |
Azure IoT Hub veya Azure IoT Edge Hub örneğindeki varsayılan olaylar uç noktasına bir ileti gönderir. Bu zaman uyumlu bir olaydır, yani olay hizmete gönderilene ve hizmet olayın alındığını onaylayana kadar bu işlevin döndürülmeyeceğini belirtir. Hizmet bağlantısı daha önce bağlanma çağrısı tarafından açılmadıysa, bu işlev olayı göndermeden önce bağlantıyı açar. |
| send_message_to_output |
Verilen modül çıkışına bir olay/ileti gönderir. Bunlar giden olaylardır ve "çıkış olayları" olması amaçlanmıştır. Bu zaman uyumlu bir olaydır, yani olay hizmete gönderilene ve hizmet olayın alındığını onaylayana kadar bu işlevin döndürülmeyeceğini belirtir. Hizmet bağlantısı daha önce bağlanma çağrısı tarafından açılmadıysa, bu işlev olayı göndermeden önce bağlantıyı açar. |
| send_method_response |
Azure IoT Hub veya Azure IoT Edge Hub aracılığıyla yöntem isteğine yanıt gönderin. Bu zaman uyumlu bir olaydır, yani olay hizmete gönderilene ve hizmet olayın alındığını onaylayana kadar bu işlevin döndürülmeyeceğini belirtir. Hizmet bağlantısı daha önce bağlanma çağrısı tarafından açılmadıysa, bu işlev olayı göndermeden önce bağlantıyı açar. |
| shutdown |
Düzgün çıkış için istemciyi kapatın. Bu yöntem çağrıldıktan sonra, başka istemci çağrılarına yönelik tüm girişimler bir ClientError'ın tetiklenmesine neden olur |
| update_sastoken |
Kimlik doğrulaması için kullanılan istemcinin SAS Belirtecini güncelleştirin, ardından bağlantıyı yeniden yetkilandırır. Bu API yalnızca istemci başlangıçta bir SAS Belirteci ile oluşturulduysa kullanılabilir. |
connect
İstemciyi bir Azure IoT Hub veya Azure IoT Edge Hub örneğine bağlar.
Hedef, bu nesne başlatıldığında sağlanan auth_provider parametresi aracılığıyla geçirilen kimlik bilgilerine göre seçilir.
Bu zaman uyumlu bir çağrıdır, yani hizmet bağlantısı tamamen kurulana kadar bu işlev döndürülmeyecektir.
connect()Özel durumlar
kimlik bilgileri geçersizse ve bağlantı kurulamıyorsa.
bağlantı kurulması hatayla sonuçlanırsa.
yürütme sırasında bağlantı kesilirse.
bağlantı zaman aşımına uğradıysa.
yürütme sırasında beklenmeyen bir hata varsa.
create_from_connection_string
IoTHub cihazından veya modül bağlantı dizesinden istemcinin örneğini oluşturun.
create_from_connection_string(connection_string, **kwargs)Parametreler
- server_verification_cert
- str
Yapılandırma Seçeneği. Güvenilen sertifika zinciri. Protokol ağ geçidi gibi standart olmayan bir güven köküne sahip bir uç noktaya bağlanırken gereklidir.
- websockets
- bool
Yapılandırma Seçeneği. Varsayılan değer False'tur. Web yuvaları üzerinden MQTT kullanıyorsanız true olarak ayarlayın.
Yapılandırma Seçeneği. TLS/SSL için şifre paketi, "OpenSSL şifreleme listesi biçiminde" bir dize veya şifre paketi dizelerinin listesi olarak.
- product_info
- str
Yapılandırma Seçeneği. Varsayılan boş dizedir. Dize, kullanıcı aracısı dizesine eklenen rastgele ürün bilgilerini içerir.
- sastoken_ttl
- int
Kimlik doğrulaması için kullanılan oluşturulan SasToken için yaşam süresi (saniye cinsinden). Varsayılan değer 3600 saniyedir (1 saat).
- keep_alive
- int
Aracıyla yapılan iletişimler arasındaki en uzun süre (saniye cinsinden). Başka ileti alışverişi yapılmazsa, istemcinin aracıya ping iletileri gönderme hızını denetler. Sağlanmadıysa varsayılan değer olan 60 saniye kullanılır.
- auto_connect
- bool
Bağlantı kurulmasını gerektiren bir yöntem çağrıldığında istemciyi IoTHub'a otomatik olarak bağlayın. (Varsayılan: True)
- connection_retry_interval
- int
Bırakılan bağlantıyı yeniden kurma girişimleri arasındaki saniye cinsinden aralık (Varsayılan: 10)
- ensure_desired_properties
- bool
Yeniden bağlantılarda en son istenen özellikler düzeltme ekinin alındığından emin olun (Default:True)
Döndürülenler
Kimlik doğrulaması için bağlantı dizesi kullanan bir IoTHub istemcisi örneği.
Özel durumlar
create_from_edge_environment
İstemcinin örneğini IoT Edge ortamından oluşturun.
Bu yöntem yalnızca bir IoT Edge kapsayıcısından veya Edge geliştirmesi için yapılandırılmış bir hata ayıklama ortamında çalıştırılabilir (örneğin, Visual Studio, Visual Studio Code)
create_from_edge_environment(**kwargs)Parametreler
- websockets
- bool
Yapılandırma Seçeneği. Varsayılan değer False'tur. Web yuvaları üzerinden MQTT kullanıyorsanız true olarak ayarlayın.
Yapılandırma Seçeneği. TLS/SSL için şifre paketi, "OpenSSL şifreleme listesi biçiminde" bir dize veya şifre paketi dizelerinin listesi olarak.
- product_info
- str
Yapılandırma Seçeneği. Varsayılan boş dizedir. Dize, kullanıcı aracısı dizesine eklenen rastgele ürün bilgilerini içerir.
- sastoken_ttl
- int
Kimlik doğrulaması için kullanılan oluşturulan SasToken için yaşam süresi (saniye cinsinden). Varsayılan değer 3600 saniyedir (1 saat)
- keep_alive
- int
Aracıyla yapılan iletişimler arasındaki en uzun süre (saniye cinsinden). Başka ileti alışverişi yapılmazsa, istemcinin aracıya ping iletileri gönderme hızını denetler. Sağlanmadıysa varsayılan değer olan 60 saniye kullanılır.
- auto_connect
- bool
Bağlantı kurulmasını gerektiren bir yöntem çağrıldığında istemciyi IoTHub'a otomatik olarak bağlayın. (Varsayılan: True)
- connection_retry_interval
- int
Bırakılan bağlantıyı yeniden kurma girişimleri arasındaki saniye cinsinden aralık (Varsayılan: 10)
Döndürülenler
Kimlik doğrulaması için IoT Edge ortamını kullanan bir IoTHub istemcisi örneği.
Özel durumlar
create_from_sastoken
önceden oluşturulmuş bir SAS Belirteci dizesinden istemci örneği oluşturma
create_from_sastoken(sastoken, **kwargs)Parametreler
- server_verification_cert
- str
Yapılandırma Seçeneği. Güvenilen sertifika zinciri. Protokol ağ geçidi gibi standart olmayan bir güven köküne sahip bir uç noktaya bağlanırken gereklidir.
- gateway_hostname
- str
Yapılandırma Seçeneği. Ağ geçidi cihazının ağ geçidi ana bilgisayar adı.
- websockets
- bool
Yapılandırma Seçeneği. Varsayılan değer False'tur. Web yuvaları üzerinden MQTT kullanıyorsanız true olarak ayarlayın.
Yapılandırma Seçeneği. TLS/SSL için şifre paketi, "OpenSSL şifreleme listesi biçiminde" bir dize veya şifre paketi dizelerinin listesi olarak.
- product_info
- str
Yapılandırma Seçeneği. Varsayılan boş dizedir. Dize, kullanıcı aracısı dizesine eklenen rastgele ürün bilgilerini içerir.
- keep_alive
- int
Aracıyla yapılan iletişimler arasındaki en uzun süre (saniye cinsinden). Başka ileti alışverişi yapılmazsa, istemcinin aracıya ping iletileri gönderme hızını denetler. Sağlanmadıysa varsayılan değer olan 60 saniye kullanılır.
- auto_connect
- bool
Bağlantı kurulmasını gerektiren bir yöntem çağrıldığında istemciyi IoTHub'a otomatik olarak bağlayın. (Varsayılan: True)
- connection_retry_interval
- int
Bırakılan bağlantıyı yeniden kurma girişimleri arasındaki saniye cinsinden aralık (Varsayılan: 10)
- ensure_desired_properties
- bool
Yeniden bağlantılarda en son istenen özellikler düzeltme ekinin alındığından emin olun (Default:True)
Özel durumlar
create_from_x509_certificate
X509 sertifika kimlik doğrulamayı kullanarak bir istemci örneği oluşturun.
create_from_x509_certificate(x509, hostname, device_id, module_id, **kwargs)Parametreler
- hostname
- str
IotHub'ı çalıştıran konak. Genel Bakış sekmesindeki Azure portal dize ana bilgisayar adı olarak bulunabilir.
- x509
- X509
Tam x509 sertifika nesnesi. Sertifikayı kullanmak için kayıt nesnesinin sertifika içermesi gerekir (kök sertifika veya ara CA sertifikalarından biri). Sertifika bir CER dosyasından geliyorsa base64 kodlanmış olması gerekir.
- module_id
- str
IoTHub'da bir cihazdaki modülü benzersiz olarak tanımlamak için kullanılan kimlik.
- server_verification_cert
- str
Yapılandırma Seçeneği. Güvenilen sertifika zinciri. Protokol ağ geçidi gibi standart olmayan bir güven köküne sahip bir uç noktaya bağlanırken gereklidir.
- gateway_hostname
- str
Yapılandırma Seçeneği. Ağ geçidi cihazının ağ geçidi ana bilgisayar adı.
- websockets
- bool
Yapılandırma Seçeneği. Varsayılan değer False'tur. Web yuvaları üzerinden MQTT kullanıyorsanız true olarak ayarlayın.
Yapılandırma Seçeneği. TLS/SSL için şifre paketi, "OpenSSL şifreleme listesi biçiminde" bir dize veya şifre paketi dizelerinin listesi olarak.
- product_info
- str
Yapılandırma Seçeneği. Varsayılan boş dizedir. Dize, kullanıcı aracısı dizesine eklenen rastgele ürün bilgilerini içerir.
- keep_alive
- int
Aracıyla yapılan iletişimler arasındaki en uzun süre (saniye cinsinden). Başka ileti alışverişi yapılmazsa, istemcinin aracıya ping iletileri gönderme hızını denetler. Sağlanmadıysa varsayılan değer olan 60 saniye kullanılır.
- auto_connect
- bool
Bağlantı kurulmasını gerektiren bir yöntem çağrıldığında istemciyi IoTHub'a otomatik olarak bağlayın. (Varsayılan: True)
- connection_retry_interval
- int
Bırakılan bağlantıyı yeniden kurma girişimleri arasındaki saniye cinsinden aralık (Varsayılan: 10)
- ensure_desired_properties
- bool
Yeniden bağlantılarda en son istenen özellikler düzeltme ekinin alındığından emin olun (Default:True)
Döndürülenler
Kimlik doğrulaması için X509 sertifikası kullanan bir IoTHub istemcisi örneği.
Özel durumlar
disconnect
İstemcinin Azure IoT Hub veya Azure IoT Edge Hub örneğinin bağlantısını kesin.
İstemci örneğinizle tamamen işiniz bittiğinde bu işlevi çağırdığınızdan emin olmanız önerilir.
Bu zaman uyumlu bir çağrıdır, yani hizmet bağlantısı tamamen kapatılana kadar bu işlev döndürülmeyecektir.
disconnect()Özel durumlar
yürütme sırasında beklenmeyen bir hata varsa.
get_twin
cihazı veya modül ikizini Azure IoT Hub veya Azure IoT Edge Hub hizmetinden alır.
Bu zaman uyumlu bir çağrıdır, yani ikiz hizmetten alınana kadar bu işlev döndürülmeyecektir.
get_twin()Döndürülenler
JSON diktesi olarak Complete İkizi
Dönüş türü
Özel durumlar
kimlik bilgileri geçersizse ve bağlantı kurulamıyorsa.
bağlantı kurulması hatayla sonuçlanırsa.
yürütme sırasında bağlantı kesilirse.
bağlantı girişimi zaman aşımına uğradıysa
istemci bağlı değilse (ve otomatik bağlantı etkin değilse)
yürütme sırasında beklenmeyen bir hata varsa.
invoke_method
İstemcinizden bir cihaz veya modül istemcisine bir yöntem çağırın ve yöntem çağrısının yanıtını alın.
invoke_method(method_params, device_id, module_id=None)Parametreler
- method_params
- dict
methodName (str), payload (str), connectTimeoutInSeconds (int), responseTimeoutInSeconds (int) içermelidir.
- module_id
- str
Yöntemin çağrılacağı hedef modülün modül kimliği. (İsteğe bağlı)
Döndürülenler
method_result bir durum ve yük içermelidir
Dönüş türü
Özel durumlar
kimlik bilgileri geçersizse ve bağlantı kurulamıyorsa.
bağlantı kurulması hatayla sonuçlanırsa.
yürütme sırasında bağlantı kesilirse.
bağlantı zaman aşımına uğradıysa.
yürütme sırasında beklenmeyen bir hata varsa.
patch_twin_reported_properties
Bildirilen özellikleri Azure IoT Hub veya Azure IoT Edge Hub hizmetiyle güncelleştirin.
Bu zaman uyumlu bir çağrıdır, yani düzeltme eki hizmete gönderilene ve onaylanana kadar bu işlev döndürülmeyecektir.
Hizmet düzeltme eki işlemiyle ilgili bir hata döndürürse, bu işlev uygun hatayı oluşturur.
patch_twin_reported_properties(reported_properties_patch)Parametreler
Özel durumlar
kimlik bilgileri geçersizse ve bağlantı kurulamıyorsa.
bağlantı kurulması hatayla sonuçlanırsa.
yürütme sırasında bağlantı kesilirse.
bağlantı girişimi zaman aşımına uğradıysa
istemci bağlı değilse (ve otomatik bağlantı etkin değilse)
yürütme sırasında beklenmeyen bir hata varsa.
receive_message_on_input
Başka bir Modülden belirli bir girişe gönderilen bir giriş iletisi alın.
Sürüm 2.3.0'dan bu yana kullanım dışı: bunun yerine işleyici ayarlamak için .on_message_received özelliğini kullanmanızı öneririz
receive_message_on_input(input_name, block=True, timeout=None)Parametreler
Döndürülenler
Belirtilen girişe gönderilen ileti veya engelleme döneminin sonunda yöntem isteği alınmadıysa Hiçbiri.
Özel durumlar
kimlik bilgileri geçersizse ve bağlantı kurulamıyorsa.
bağlantı kurulması hatayla sonuçlanırsa.
yürütme sırasında bağlantı kesilirse.
bağlantı zaman aşımına uğradıysa.
yürütme sırasında beklenmeyen bir hata varsa.
receive_method_request
Azure IoT Hub veya Azure IoT Edge Hub aracılığıyla bir yöntem isteği alın.
Sürüm 2.3.0'dan bu yana kullanım dışı: bunun yerine işleyici ayarlamak için .on_method_request_received özelliğini kullanmanızı öneririz
receive_method_request(method_name=None, block=True, timeout=None)Parametreler
- method_name
- str
İsteğe bağlı olarak istekleri almak için yönteminin adını belirtin. Bu parametre verilmezse, receive_method farklı bir istek tarafından özel olarak hedeflenmemiş tüm yöntemler alınır.
- block
- bool
bir istek alınana kadar işlemin engellenip engellenmediğini gösterir.
- timeout
- int
İsteğe bağlı olarak engelleme zaman aşımına kadar birkaç saniye sağlayın.
Döndürülenler
Alınan yöntem isteğini temsil eden MethodRequest nesnesi veya engelleme döneminin sonunda hiçbir yöntem isteği alınmadıysa Hiçbiri.
Özel durumlar
kimlik bilgileri geçersizse ve bağlantı kurulamıyorsa.
bağlantı kurulması hatayla sonuçlanırsa.
yürütme sırasında bağlantı kesilirse.
bağlantı zaman aşımına uğradıysa.
yürütme sırasında beklenmeyen bir hata varsa.
receive_twin_desired_properties_patch
Azure IoT Hub veya Azure IoT Edge Hub aracılığıyla istenen özellik düzeltme ekini alın.
Bu zaman uyumlu bir çağrıdır ve şu anlama gelir:
block=True ise, aşağıdakilerden biri gerçekleşene kadar bu işlev engellenir:
Azure IoT Hub veya Azure IoT Edge Hub'dan istenen özellik düzeltme eki alınır.
zaman aşımı süresi (sağlandıysa) geçen süre. Zaman aşımı oluşursa, bu işlev Bir InboxEmpty özel durumu oluşturur
block=False ise, bu işlev işlem hattı tarafından alınmış ancak henüz uygulamaya döndürülmemiş olabilecek istenen özellik düzeltme eklerini döndürür. İşlem hattı tarafından istenen özellik düzeltme ekleri alınmadıysa, bu işlev bir InboxEmpty özel durumu oluşturur
Sürüm 2.3.0'dan bu yana kullanım dışı: bunun yerine bir işleyici ayarlamak için .on_twin_desired_properties_patch_received özelliğini kullanmanızı öneririz
receive_twin_desired_properties_patch(block=True, timeout=None)Parametreler
- block
- bool
bir istek alınana kadar işlemin engellenip engellenmediğini gösterir.
- timeout
- int
İsteğe bağlı olarak engelleme zaman aşımına kadar birkaç saniye sağlayın.
Döndürülenler
JSON diktesi olarak İkiz İstenen Özellikler düzeltme eki veya engelleme döneminin sonuna kadar herhangi bir düzeltme eki alınmadıysa Hiçbiri
Dönüş türü
Özel durumlar
kimlik bilgileri geçersizse ve bağlantı kurulamıyorsa.
bağlantı kurulması hatayla sonuçlanırsa.
yürütme sırasında bağlantı kesilirse.
bağlantı zaman aşımına uğradıysa.
yürütme sırasında beklenmeyen bir hata varsa.
send_message
Azure IoT Hub veya Azure IoT Edge Hub örneğindeki varsayılan olaylar uç noktasına bir ileti gönderir.
Bu zaman uyumlu bir olaydır, yani olay hizmete gönderilene ve hizmet olayın alındığını onaylayana kadar bu işlevin döndürülmeyeceğini belirtir.
Hizmet bağlantısı daha önce bağlanma çağrısı tarafından açılmadıysa, bu işlev olayı göndermeden önce bağlantıyı açar.
send_message(message)Parametreler
- message
- Message
Gönderilecek gerçek ileti. İleti sınıfının bir örneği olmayan geçirilen her şey İleti nesnesine dönüştürülür.
Özel durumlar
kimlik bilgileri geçersizse ve bağlantı kurulamıyorsa.
bağlantı kurulması hatayla sonuçlanırsa.
yürütme sırasında bağlantı kesilirse.
bağlantı girişimi zaman aşımına uğradıysa
istemci bağlı değilse (ve otomatik bağlantı etkin değilse)
yürütme sırasında beklenmeyen bir hata varsa.
send_message_to_output
Verilen modül çıkışına bir olay/ileti gönderir.
Bunlar giden olaylardır ve "çıkış olayları" olması amaçlanmıştır.
Bu zaman uyumlu bir olaydır, yani olay hizmete gönderilene ve hizmet olayın alındığını onaylayana kadar bu işlevin döndürülmeyeceğini belirtir.
Hizmet bağlantısı daha önce bağlanma çağrısı tarafından açılmadıysa, bu işlev olayı göndermeden önce bağlantıyı açar.
send_message_to_output(message, output_name)Parametreler
- message
- Message
Verilen çıkışa gönderilecek ileti. İleti sınıfının bir örneği olmayan geçirilen her şey İleti nesnesine dönüştürülür.
Özel durumlar
kimlik bilgileri geçersizse ve bağlantı kurulamıyorsa.
bağlantı kurulması hatayla sonuçlanırsa.
yürütme sırasında bağlantı kesilirse.
bağlantı girişimi zaman aşımına uğradıysa
istemci bağlı değilse (ve otomatik bağlantı etkin değilse)
yürütme sırasında beklenmeyen bir hata varsa.
send_method_response
Azure IoT Hub veya Azure IoT Edge Hub aracılığıyla yöntem isteğine yanıt gönderin.
Bu zaman uyumlu bir olaydır, yani olay hizmete gönderilene ve hizmet olayın alındığını onaylayana kadar bu işlevin döndürülmeyeceğini belirtir.
Hizmet bağlantısı daha önce bağlanma çağrısı tarafından açılmadıysa, bu işlev olayı göndermeden önce bağlantıyı açar.
send_method_response(method_response)Parametreler
Özel durumlar
kimlik bilgileri geçersizse ve bağlantı kurulamıyorsa.
bağlantı kurulması hatayla sonuçlanırsa.
yürütme sırasında bağlantı kesilirse.
bağlantı girişimi zaman aşımına uğradıysa
istemci bağlı değilse (ve otomatik bağlantı etkin değilse)
yürütme sırasında beklenmeyen bir hata varsa.
shutdown
Düzgün çıkış için istemciyi kapatın.
Bu yöntem çağrıldıktan sonra, başka istemci çağrılarına yönelik tüm girişimler bir ClientError'ın tetiklenmesine neden olur
shutdown()Özel durumlar
yürütme sırasında beklenmeyen bir hata varsa.
update_sastoken
Kimlik doğrulaması için kullanılan istemcinin SAS Belirtecini güncelleştirin, ardından bağlantıyı yeniden yetkilandırır.
Bu API yalnızca istemci başlangıçta bir SAS Belirteci ile oluşturulduysa kullanılabilir.
update_sastoken(sastoken)Parametreler
Özel durumlar
kimlik bilgileri geçersizse ve bağlantı yeniden kurulamıyorsa.
bağlantının yeniden kurulması hatayla sonuçlanırsa.
yürütme sırasında bağlantı kesilirse.
yeniden kimlik doğrulama girişimi zaman aşımına uğradıysa.
istemci başlangıçta bir SAS belirteci ile oluşturulmadıysa.
yürütme sırasında beklenmeyen bir hata varsa.
Öznitelikler
connected
Taşımanın bağlı olup olmadığını belirtmek için salt okunur özellik.
on_background_exception
Arka plan özel durumu oluştuğunda işleyici işlevi veya eş yordam çağrılır.
İşlev veya eş yordam tanımı bir konumsal bağımsız değişken (özel durum nesnesi) almalıdır
on_connection_state_change
Bağlantı durumu değiştiğinde çağrılacak işleyici işlevi veya eş yordam.
İşlev veya eş yordam tanımı konumsal bağımsız değişken almamalıdır.
on_message_received
Giriş iletisi alındığında çağrılacak işleyici işlevi veya eş yordam.
İşlev tanımı veya eş yordam bir konumsal bağımsız değişken ( Message nesne) almalıdır
on_method_request_received
Bir yöntem isteği alındığında çağrılacak işleyici işlevi veya eş yordam.
İstemcinin .send_method_response() yöntemini kullanarak işlevinizdeki veya eş yordamdaki yöntem isteğini onaylamayı unutmayın.
İşlev veya eş yordam tanımı bir konumsal bağımsız değişken ( MethodRequest nesne) almalıdır
on_new_sastoken_required
İstemci yeni bir SAS belirteci gerektirdiğinde çağrılacak işleyici işlevi veya eş yordam. Bu, SAS Belirtecinin süresi dolmadan yaklaşık 2 dakika önce gerçekleşir. Windows platformlarında, kullanım ömrü yaklaşık 49 günü aşarsa SAS ömrünün ne kadar olduğuna bakılmaksızın bu 49 günden sonra yeni bir belirteç gerekir.
Bu işleyicinin YALNIZCA .create_from_sastoken() yöntemiyle oluşturulan bir istemci kullanılırken gerekli olduğunu unutmayın.
Yeni belirteç, istemcinin .update_sastoken() yöntemi kullanılarak işlevinizde veya eş yordamda sağlanabilir.
İşlev veya eş yordam tanımı konumsal bağımsız değişken almamalıdır.
on_twin_desired_properties_patch_received
İkiz istenen özellikler düzeltme eki alındığında çağrılacak işleyici işlevi veya eş yordam.
İşlev veya eş yordam tanımı bir konumsal bağımsız değişken almalıdır (JSON sözlük nesnesi biçiminde ikiz düzeltme eki)
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