Aracılığıyla paylaş


IoTHubDeviceClient Sınıf

bir Azure IoT Hub örneğine bağlanan zaman uyumlu cihaz istemcisi.

IoTHubDeviceClient 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.GenericIoTHubClient
IoTHubDeviceClient
azure.iot.device.iothub.abstract_clients.AbstractIoTHubDeviceClient
IoTHubDeviceClient

Oluşturucu

IoTHubDeviceClient(mqtt_pipeline, http_pipeline)

Parametreler

mqtt_pipeline
<xref:azure.iot.device.iothub.pipeline.MQTTPipeline>
Gerekli

IoTHub uç noktasına bağlanmak için kullanılan işlem hattı.

http_pipeline
Gerekli

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_sastoken

önceden oluşturulmuş bir SAS Belirteci dizesinden istemci örneği oluşturma

create_from_symmetric_key

Simetrik anahtar kimlik doğrulaması kullanarak bir istemci örneği oluşturun.

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_storage_info_for_blob

Http üzerinden bir IoTHub uç noktasına, cihazınızın bağlı olduğu IoTHub'a bağlı Azure Depolama Hesabı aracılığıyla karşıya yükleme bilgilerini döndürecek bir POST isteği gönderir.

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.

notify_blob_upload_status

Karşıya yükleme tamamlandığında cihaz IoT Hub uç noktasına bloba yükleme girişiminin durumuyla ilgili bilgiler içeren bir POST isteği gönderir. Bu, IoT Hub tarafından dinleyen istemcileri bilgilendirmek için kullanılır.

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

Azure IoT Hub gönderilen bir ileti 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:

  1. 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

  2. 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

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_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ı kuruluyorsa 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

connection_string
str
Gerekli

Bağlanmak istediğiniz IoTHub için bağlantı dizesi.

server_verification_cert
str
Gerekli

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
Gerekli

Yapılandırma Seçeneği. Varsayılan değer False'tur. Web yuvaları üzerinden MQTT kullanıyorsanız true olarak ayarlayın.

cipher
str veya list(str)
Gerekli

Yapılandırma Seçeneği. TLS/SSL için şifre paketlerini, "OpenSSL şifreleme listesi biçiminde" bir dize olarak veya şifre paketi dizelerinin listesi olarak.

product_info
str
Gerekli

Yapılandırma Seçeneği. Varsayılan boş dizedir. Dize, kullanıcı aracısı dizesine eklenen rastgele ürün bilgilerini içerir.

proxy_options
ProxyOptions
Gerekli

Ara sunucular üzerinden trafik gönderme seçenekleri.

sastoken_ttl
int
Gerekli

Kimlik doğrulaması için kullanılan oluşturulan SasToken için yaşam süresi (saniye). Varsayılan değer 3600 saniyedir (1 saat).

keep_alive
int
Gerekli

Aracıyla iletişim arasındaki saniye cinsinden maksimum süre. Başka ileti alışverişi yapılmazsa, istemcinin aracıya ping iletileri gönderme hızını denetler. Sağlanmadıysa 60 saniyelik varsayılan değer kullanılır.

auto_connect
bool
Gerekli

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
bool
Gerekli

Bırakılan bağlantıyı yeniden kurmaya çalışma (Varsayılan: True)

connection_retry_interval
int
Gerekli

Bırakılan bağlantıyı yeniden kurma girişimleri arasındaki saniye cinsinden aralık (Varsayılan: 10)

ensure_desired_properties
bool
Gerekli

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

ValueError if given an invalid connection_string.
TypeError if given an unsupported parameter.

create_from_sastoken

önceden oluşturulmuş bir SAS Belirteci dizesinden istemci örneği oluşturma

create_from_sastoken(sastoken, **kwargs)

Parametreler

sastoken
str
Gerekli

SAS Belirteci dizesi

server_verification_cert
str
Gerekli

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
Gerekli

Yapılandırma Seçeneği. Ağ geçidi cihazının ağ geçidi ana bilgisayar adı.

websockets
bool
Gerekli

Yapılandırma Seçeneği. Varsayılan değer False'tur. Web yuvaları üzerinden MQTT kullanıyorsanız true olarak ayarlayın.

cipher
str veya list(str)
Gerekli

Yapılandırma Seçeneği. TLS/SSL için şifre paketlerini, "OpenSSL şifreleme listesi biçiminde" bir dize olarak veya şifre paketi dizelerinin listesi olarak.

product_info
str
Gerekli

Yapılandırma Seçeneği. Varsayılan boş dizedir. Dize, kullanıcı aracısı dizesine eklenen rastgele ürün bilgilerini içerir.

proxy_options
ProxyOptions
Gerekli

Ara sunucular üzerinden trafik gönderme seçenekleri.

keep_alive
int
Gerekli

Aracıyla iletişim arasındaki saniye cinsinden maksimum süre. Başka ileti alışverişi yapılmazsa, istemcinin aracıya ping iletileri gönderme hızını denetler. Sağlanmadıysa 60 saniyelik varsayılan değer kullanılır.

auto_connect
bool
Gerekli

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
bool
Gerekli

Bırakılan bağlantıyı yeniden kurmaya çalışma (Varsayılan: True)

connection_retry_interval
int
Gerekli

Bırakılan bağlantıyı yeniden kurma girişimleri arasındaki saniye cinsinden aralık (Varsayılan: 10)

ensure_desired_properties
bool
Gerekli

Yeniden bağlantılarda en son istenen özellikler düzeltme ekinin alındığından emin olun (Default:True)

Özel durumlar

TypeError if given an unsupported parameter.
ValueError if the sastoken parameter is invalid.

create_from_symmetric_key

Simetrik anahtar kimlik doğrulaması kullanarak bir istemci örneği oluşturun.

create_from_symmetric_key(symmetric_key, hostname, device_id, **kwargs)

Parametreler

symmetric_key
Gerekli

Simetrik anahtar.

hostname
str
Gerekli

IotHub'ı çalıştıran konak. Genel Bakış sekmesindeki Azure portal dize ana bilgisayar adı olarak bulunabilir.

device_id
Gerekli

Cihaz kimliği

server_verification_cert
str
Gerekli

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
Gerekli

Yapılandırma Seçeneği. Ağ geçidi cihazının ağ geçidi ana bilgisayar adı.

websockets
bool
Gerekli

Yapılandırma Seçeneği. Varsayılan değer False'tur. Web yuvaları üzerinden MQTT kullanıyorsanız true olarak ayarlayın.

cipher
str veya list(str)
Gerekli

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
Gerekli

Yapılandırma Seçeneği. Varsayılan boş dizedir. Dize, kullanıcı aracısı dizesine eklenen rastgele ürün bilgilerini içerir.

proxy_options
ProxyOptions
Gerekli

Proxy sunucuları üzerinden trafik gönderme seçenekleri.

sastoken_ttl
int
Gerekli

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
Gerekli

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
Gerekli

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
bool
Gerekli

Bırakılan bağlantıyı yeniden kurmaya çalışma (Varsayılan: True)

connection_retry_interval
int
Gerekli

Bırakılan bağlantıyı yeniden kurma girişimleri arasındaki saniye cinsinden aralık (Varsayılan: 10)

ensure_desired_properties
bool
Gerekli

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 simetrik anahtar kullanan bir IoTHub istemcisi örneği.

Özel durumlar

TypeError if given an unsupported parameter.
ValueError if the provided parameters are invalid.

create_from_x509_certificate

X509 sertifika kimlik doğrulamayı kullanarak bir istemci örneği oluşturun.

create_from_x509_certificate(x509, hostname, device_id, **kwargs)

Parametreler

hostname
str
Gerekli

IotHub'ı çalıştıran konak. Genel Bakış sekmesindeki Azure portal dize ana bilgisayar adı olarak bulunabilir.

x509
X509
Gerekli

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.

device_id
str
Gerekli

IoTHub'da bir cihazı benzersiz olarak tanımlamak için kullanılan kimlik

server_verification_cert
str
Gerekli

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
Gerekli

Yapılandırma Seçeneği. Ağ geçidi cihazının ağ geçidi ana bilgisayar adı.

websockets
bool
Gerekli

Yapılandırma Seçeneği. Varsayılan değer False'tur. Web yuvaları üzerinden MQTT kullanıyorsanız true olarak ayarlayın.

cipher
str veya list(str)
Gerekli

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
Gerekli

Yapılandırma Seçeneği. Varsayılan boş dizedir. Dize, kullanıcı aracısı dizesine eklenen rastgele ürün bilgilerini içerir.

proxy_options
ProxyOptions
Gerekli

Proxy sunucuları üzerinden trafik gönderme seçenekleri.

keep_alive
int
Gerekli

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
Gerekli

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
bool
Gerekli

Bırakılan bağlantıyı yeniden kurmaya çalışma (Varsayılan: True)

connection_retry_interval
int
Gerekli

Bırakılan bağlantıyı yeniden kurma girişimleri arasındaki saniye cinsinden aralık (Varsayılan: 10)

ensure_desired_properties
bool
Gerekli

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

TypeError if given an unsupported parameter.

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_storage_info_for_blob

Http üzerinden bir IoTHub uç noktasına, cihazınızın bağlı olduğu IoTHub'a bağlı Azure Depolama Hesabı aracılığıyla karşıya yükleme bilgilerini döndürecek bir POST isteği gönderir.

get_storage_info_for_blob(blob_name)

Parametreler

blob_name
str
Gerekli

Depolama API'sini kullanarak karşıya yüklenecek blobun dize biçimindeki adı. Bu ad, Depolama için uygun kimlik bilgilerini oluşturmak için kullanılır ve blob karşıya yükleme işlemini gerçekleştirmek için Azure Depolama SDK'sı ile kullanılacak kimlik bilgileriyle eşleşmesi gerekir.

Döndürülenler

IoT Hub JSON benzeri (sözlük) nesnesi correlationId, hostName, containerName, blobName, sasToken gibi ilgili bilgileri içerir.

Özel durumlar

kimlik bilgileri geçersizse ve bağlantı kurulamıyorsa.

bağlantı kuruluyorsa 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.

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.

notify_blob_upload_status

Karşıya yükleme tamamlandığında cihaz IoT Hub uç noktasına bloba yükleme girişiminin durumuyla ilgili bilgiler içeren bir POST isteği gönderir. Bu, IoT Hub tarafından dinleyen istemcileri bilgilendirmek için kullanılır.

notify_blob_upload_status(correlation_id, is_success, status_code, status_description)

Parametreler

correlation_id
str
Gerekli

get_storage_info_for_blob isteğinde IoT Hub tarafından sağlanır.

is_success
bool
Gerekli

Dosyanın başarıyla karşıya yüklenip yüklenmediğini gösteren boole değeri.

status_code
int
Gerekli

Dosyanın depolama alanına yüklenmesinin durumu olan sayısal durum kodu.

status_description
str
Gerekli

status_code karşılık gelen bir açıklama.

Özel durumlar

kimlik bilgileri geçersizse ve bağlantı kurulamıyorsa.

bağlantı kuruluyorsa 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

reported_properties_patch
dict
Gerekli

JSON diktesi olarak İkiz Bildirilen Özellikler düzeltme eki

Ö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

Azure IoT Hub gönderilen bir ileti 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(block=True, timeout=None)

Parametreler

block
bool
Gerekli

İleti alınana kadar işlemin engellenip engellenmediğini gösterir.

timeout
int
Gerekli

İsteğe bağlı olarak engelleme zaman aşımına kadar birkaç saniye sağlayın.

Döndürülenler

Azure IoT Hub gönderilen ileti veya engelleme döneminin sonunda yöntem isteği alınmadıysa Hiçbiri.

Dönüş türü

Özel durumlar

kimlik bilgileri geçersizse ve bağlantı kurulamıyorsa.

bağlantı kuruluyorsa 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
varsayılan değer: None

İ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
varsayılan değer: True

bir istek alınana kadar işlemin engellenip engellenmediğini gösterir.

timeout
int
varsayılan değer: None

İ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ı kuruluyorsa 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:

  1. 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

  2. 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
varsayılan değer: True

bir istek alınana kadar işlemin engellenip engellenmediğini gösterir.

timeout
int
varsayılan değer: None

İ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ü

dict,

Özel durumlar

kimlik bilgileri geçersizse ve bağlantı kurulamıyorsa.

bağlantı kuruluyorsa 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
Gerekli

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.

ValueError if the message fails size validation.

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

method_response
MethodResponse
Gerekli

Gönderilecek MethodResponse.

Ö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

sastoken
str
Gerekli

İstemcinin kullanması için yeni SAS Belirteci dizesi

Özel durumlar

ValueError if the sastoken parameter is invalid

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ı belirten 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

İleti 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 ( 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 coroutine'nizdeki 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

bir ikiz 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 ikizi düzeltme eki)