Bagikan melalui

ProvisioningDeviceClient Kelas

  • Referensi

Klien yang dapat digunakan untuk menjalankan pendaftaran perangkat dengan layanan provisi menggunakan Kunci Konten atau autentikasi X509.

Menginisialisasi klien provisi.

CATATAN: Penginisialisasi ini tidak boleh dipanggil secara langsung. Sebaliknya, metode kelas yang dimulai dengan create_from_ harus digunakan untuk membuat objek klien.

Warisan
azure.iot.device.provisioning.abstract_provisioning_device_client.AbstractProvisioningDeviceClient
ProvisioningDeviceClient

Konstruktor

ProvisioningDeviceClient(pipeline)

Parameter

Nama Deskripsi
pipeline
Diperlukan
<xref:azure.iot.device.provisioning.pipeline.MQTTPipeline>

Instans objek alur provisi.

Metode

create_from_symmetric_key

Buat klien yang dapat digunakan untuk menjalankan pendaftaran perangkat dengan layanan provisi menggunakan autentikasi Kunci Simetris.
create_from_x509_certificate

Buat klien yang dapat digunakan untuk menjalankan pendaftaran perangkat dengan layanan provisi menggunakan autentikasi sertifikat X509.
register

Mendaftarkan perangkat dengan layanan provisi

Ini adalah panggilan sinkron, yang berarti bahwa fungsi ini tidak akan kembali sampai proses pendaftaran berhasil diselesaikan atau upaya telah mengakibatkan kegagalan. Sebelum kembali, klien juga akan memutuskan sambungan dari layanan provisi. Jika upaya pendaftaran dilakukan saat pendaftaran sebelumnya sedang berlangsung, itu dapat melemparkan kesalahan.

Setelah perangkat berhasil didaftarkan, klien tidak akan lagi dapat dioperasikan.

create_from_symmetric_key

Buat klien yang dapat digunakan untuk menjalankan pendaftaran perangkat dengan layanan provisi menggunakan autentikasi Kunci Simetris.

create_from_symmetric_key(provisioning_host, registration_id, id_scope, symmetric_key, **kwargs)

Parameter

Nama Deskripsi
provisioning_host
Diperlukan
str

Host yang menjalankan Device Provisioning Service. Dapat ditemukan di portal Azure di tab Gambaran Umum sebagai titik akhir perangkat global string.
registration_id
Diperlukan
str

ID pendaftaran yang digunakan untuk mengidentifikasi perangkat secara unik di Device Provisioning Service. ID pendaftaran adalah string alfanumerik, huruf kecil dan mungkin berisi tanda hubung.
id_scope
Diperlukan
str

Cakupan ID yang digunakan untuk mengidentifikasi layanan provisi tertentu yang akan didaftarkan perangkat secara unik. Cakupan ID ditetapkan ke Device Provisioning Service saat dibuat oleh pengguna dan dihasilkan oleh layanan dan tidak dapat diubah, menjamin keunikan.
symmetric_key
Diperlukan
str

Kunci yang akan digunakan untuk membuat token tanda tangan akses bersama untuk mengautentikasi perangkat dengan Device Provisioning Service. Secara default, Layanan Penyediaan Perangkat membuat kunci simetris baru dengan panjang default 32 byte saat pendaftaran baru disimpan dengan opsi Buat kunci otomatis diaktifkan. Pengguna dapat menyediakan kunci konten mereka sendiri untuk pendaftaran dengan menonaktifkan opsi ini dalam 16 byte dan 64 byte dan dalam format Base64 yang valid.
server_verification_cert
Diperlukan
str

Opsi Konfigurasi. Rantai sertifikat tepercaya. Diperlukan saat menggunakan menyambungkan ke titik akhir yang memiliki akar kepercayaan non-standar, seperti gateway protokol.
gateway_hostname
Diperlukan
str

Opsi Konfigurasi. Nama host gateway untuk perangkat gateway.
websockets
Diperlukan
bool

Opsi Konfigurasi. Defaultnya adalah False. Atur ke true jika menggunakan MQTT melalui websocket.
cipher
Diperlukan
str atau list(str)

Opsi Konfigurasi. Cipher suite untuk TLS/SSL, sebagai string dalam "format daftar sandi OpenSSL" atau sebagai daftar string cipher suite.
proxy_options
Diperlukan
ProxyOptions

Opsi untuk mengirim lalu lintas melalui server proksi.
keepalive
Diperlukan
int

Periode maksimum dalam detik antara komunikasi dengan broker. Jika tidak ada pesan lain yang ditukar, ini mengontrol tingkat di mana klien akan mengirim pesan ping ke broker. Jika tidak disediakan nilai default 60 detik akan digunakan.

Mengembalikan

Jenis Deskripsi

Instans ProvisioningDeviceClient yang dapat mendaftar melalui Kunci Konten.

Pengecualian

Jenis Deskripsi
TypeError if given an unrecognized parameter.

create_from_x509_certificate

Buat klien yang dapat digunakan untuk menjalankan pendaftaran perangkat dengan layanan provisi menggunakan autentikasi sertifikat X509.

create_from_x509_certificate(provisioning_host, registration_id, id_scope, x509, **kwargs)

Parameter

Nama Deskripsi
provisioning_host
Diperlukan
str

Host yang menjalankan Device Provisioning Service. Dapat ditemukan di portal Azure di tab Gambaran Umum sebagai titik akhir perangkat global string.
registration_id
Diperlukan
str

ID pendaftaran yang digunakan untuk mengidentifikasi perangkat secara unik di Device Provisioning Service. ID pendaftaran adalah string alfanumerik, huruf kecil dan mungkin berisi tanda hubung.
id_scope
Diperlukan
str

Cakupan ID digunakan untuk mengidentifikasi layanan provisi tertentu yang akan didaftarkan perangkat secara unik. Cakupan ID ditetapkan ke Device Provisioning Service saat dibuat oleh pengguna dan dihasilkan oleh layanan dan tidak dapat diubah, menjamin keunikan.
x509
Diperlukan
X509

Sertifikat x509, Untuk menggunakan sertifikat, objek pendaftaran perlu berisi sertifikat (baik sertifikat akar atau salah satu sertifikat OS perantara). Jika sertifikasi berasal dari file CER, sertifikat perlu dikodekan base64.
server_verification_cert
Diperlukan
str

Opsi Konfigurasi. Rantai sertifikat tepercaya. Diperlukan saat menggunakan menyambungkan ke titik akhir yang memiliki akar kepercayaan non-standar, seperti gateway protokol.
gateway_hostname
Diperlukan
str

Opsi Konfigurasi. Nama host gateway untuk perangkat gateway.
websockets
Diperlukan
bool

Opsi Konfigurasi. Defaultnya adalah False. Atur ke true jika menggunakan MQTT melalui websocket.
cipher
Diperlukan
str atau list(str)

Opsi Konfigurasi. Cipher suite untuk TLS/SSL, sebagai string dalam "format daftar sandi OpenSSL" atau sebagai daftar string cipher suite.
proxy_options
Diperlukan
ProxyOptions

Opsi untuk mengirim lalu lintas melalui server proksi.
keepalive
Diperlukan
int

Periode maksimum dalam detik antara komunikasi dengan broker. Jika tidak ada pesan lain yang ditukar, ini mengontrol tingkat di mana klien akan mengirim pesan ping ke broker. Jika tidak disediakan nilai default 60 detik akan digunakan.

Mengembalikan

Jenis Deskripsi

ProvisioningDeviceClient yang dapat mendaftar melalui sertifikat klien X509.

Pengecualian

Jenis Deskripsi
TypeError if given an unrecognized parameter.

register

Mendaftarkan perangkat dengan layanan provisi

Ini adalah panggilan sinkron, yang berarti bahwa fungsi ini tidak akan kembali sampai proses pendaftaran berhasil diselesaikan atau upaya telah mengakibatkan kegagalan. Sebelum kembali, klien juga akan memutuskan sambungan dari layanan provisi. Jika upaya pendaftaran dilakukan saat pendaftaran sebelumnya sedang berlangsung, itu dapat melemparkan kesalahan.

Setelah perangkat berhasil didaftarkan, klien tidak akan lagi dapat dioperasikan.

register()

Mengembalikan

Jenis Deskripsi
RegistrationResult

RegistrationResult menunjukkan hasil pendaftaran.

Pengecualian

Jenis Deskripsi
CredentialError

jika kredensial tidak valid dan koneksi tidak dapat dibuat.
ConnectionFailedError

jika membuat koneksi menghasilkan kegagalan.
ConnectionDroppedError

jika koneksi hilang selama eksekusi.
OperationTimeout

jika waktu koneksi habis.
ClientError

jika ada kegagalan yang tidak terduga selama eksekusi.

Atribut

provisioning_payload