ProvisioningDeviceClient Sınıf
Simetrik Anahtar veya X509 kimlik doğrulaması kullanılarak sağlama hizmetiyle bir cihazın kaydını çalıştırmak için kullanılabilen istemci.
Sağlama istemcisini başlatır.
NOT: Bu başlatıcı doğrudan çağrılmamalıdır. Bunun yerine, istemci nesnesi oluşturmak için create_from_ ile başlayan sınıf yöntemleri kullanılmalıdır.
- Devralma
-
azure.iot.device.provisioning.abstract_provisioning_device_client.AbstractProvisioningDeviceClientProvisioningDeviceClient
Oluşturucu
ProvisioningDeviceClient(pipeline)
Parametreler
Name | Description |
---|---|
pipeline
Gerekli
|
<xref:azure.iot.device.provisioning.pipeline.MQTTPipeline>
Sağlama işlem hattı nesnesinin örneği. |
Yöntemler
create_from_symmetric_key |
Simetrik Anahtar kimlik doğrulamasını kullanarak sağlama hizmetiyle bir cihazın kaydını çalıştırmak için kullanılabilecek bir istemci oluşturun. |
create_from_x509_certificate |
X509 sertifika kimlik doğrulamasını kullanarak sağlama hizmetiyle bir cihazın kaydını çalıştırmak için kullanılabilecek bir istemci oluşturun. |
register |
Cihazı sağlama hizmetine kaydetme Bu zaman uyumlu bir çağrıdır, yani kayıt işlemi başarıyla tamamlanana veya deneme bir hatayla sonuçlanana kadar bu işlev döndürülmeyecektir. Geri dönmeden önce istemcinin sağlama hizmetiyle bağlantısı da kesilir. Önceki bir kayıt devam ederken bir kayıt girişimi yapılırsa bir hata oluşabilir. Cihaz başarıyla kaydedildikten sonra istemci artık kullanılamaz. |
create_from_symmetric_key
Simetrik Anahtar kimlik doğrulamasını kullanarak sağlama hizmetiyle bir cihazın kaydını çalıştırmak için kullanılabilecek bir istemci oluşturun.
create_from_symmetric_key(provisioning_host, registration_id, id_scope, symmetric_key, **kwargs)
Parametreler
Name | Description |
---|---|
provisioning_host
Gerekli
|
Cihaz Sağlama Hizmeti'ni çalıştıran ana bilgisayar. Genel Bakış sekmesindeki Azure portal Genel cihaz uç noktası dizesi olarak bulunabilir. |
registration_id
Gerekli
|
Cihaz Sağlama Hizmeti'nde bir cihazı benzersiz olarak tanımlamak için kullanılan kayıt kimliği. Kayıt kimliği alfasayısal, küçük harfli dizedir ve kısa çizgi içerebilir. |
id_scope
Gerekli
|
Cihazın kaydedeceği belirli sağlama hizmetini benzersiz olarak tanımlamak için kullanılan kimlik kapsamı. Kimlik kapsamı, kullanıcı tarafından oluşturulduğunda cihaz sağlama hizmetine atanır ve hizmet tarafından oluşturulur ve sabittir ve benzersizliği garanti eder. |
symmetric_key
Gerekli
|
Cihaz Sağlama Hizmeti ile cihazın kimliğini doğrulamak için paylaşılan erişim imzası belirtecini oluşturmak için kullanılacak anahtar. Varsayılan olarak, Yeni kayıtlar Anahtarları otomatik oluştur seçeneği etkin olarak kaydedildiğinde Cihaz Sağlama Hizmeti varsayılan uzunluğu 32 bayt olan yeni simetrik anahtarlar oluşturur. Kullanıcılar, bu seçeneği 16 bayt ve 64 bayt içinde ve geçerli Base64 biçiminde devre dışı bırakarak kayıtlar için kendi simetrik anahtarlarını sağlayabilir. |
server_verification_cert
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
Gerekli
|
Yapılandırma Seçeneği. Ağ geçidi cihazının ağ geçidi ana bilgisayar adı. |
websockets
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
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. |
proxy_options
Gerekli
|
Proxy sunucuları üzerinden trafik gönderme seçenekleri. |
keepalive
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. |
Döndürülenler
Tür | Description |
---|---|
Simetrik Anahtar aracılığıyla kaydedilebilen bir ProvisioningDeviceClient örneği. |
Özel durumlar
Tür | Description |
---|---|
TypeError if given an unrecognized parameter.
|
create_from_x509_certificate
X509 sertifika kimlik doğrulamasını kullanarak sağlama hizmetiyle bir cihazın kaydını çalıştırmak için kullanılabilecek bir istemci oluşturun.
create_from_x509_certificate(provisioning_host, registration_id, id_scope, x509, **kwargs)
Parametreler
Name | Description |
---|---|
provisioning_host
Gerekli
|
Cihaz Sağlama Hizmeti'ni çalıştıran ana bilgisayar. Genel Bakış sekmesindeki Azure portal Genel cihaz uç noktası dizesi olarak bulunabilir. |
registration_id
Gerekli
|
Cihaz Sağlama Hizmeti'nde bir cihazı benzersiz olarak tanımlamak için kullanılan kayıt kimliği. Kayıt kimliği alfasayısal, küçük harfli dizedir ve kısa çizgi içerebilir. |
id_scope
Gerekli
|
Kimlik kapsamı, cihazın kaydedileceği belirli sağlama hizmetini benzersiz olarak tanımlamak için kullanılır. Kimlik kapsamı, kullanıcı tarafından oluşturulduğunda cihaz sağlama hizmetine atanır ve hizmet tarafından oluşturulur ve sabittir ve benzersizliği garanti eder. |
x509
Gerekli
|
x509 sertifikası, 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. |
server_verification_cert
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
Gerekli
|
Yapılandırma Seçeneği. Ağ geçidi cihazının ağ geçidi ana bilgisayar adı. |
websockets
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
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. |
proxy_options
Gerekli
|
Proxy sunucuları üzerinden trafik gönderme seçenekleri. |
keepalive
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. |
Döndürülenler
Tür | Description |
---|---|
X509 istemci sertifikaları aracılığıyla kaydolabilen bir ProvisioningDeviceClient. |
Özel durumlar
Tür | Description |
---|---|
TypeError if given an unrecognized parameter.
|
register
Cihazı sağlama hizmetine kaydetme
Bu zaman uyumlu bir çağrıdır, yani kayıt işlemi başarıyla tamamlanana veya deneme bir hatayla sonuçlanana kadar bu işlev döndürülmeyecektir. Geri dönmeden önce istemcinin sağlama hizmetiyle bağlantısı da kesilir. Önceki bir kayıt devam ederken bir kayıt girişimi yapılırsa bir hata oluşabilir.
Cihaz başarıyla kaydedildikten sonra istemci artık kullanılamaz.
register()
Döndürülenler
Tür | Description |
---|---|
Kaydın sonucunu gösteren RegistrationResult. |
Özel durumlar
Tür | Description |
---|---|
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. |
Öznitelikler
provisioning_payload
Azure SDK for Python