ProvisioningDeviceClient Osztály
Ügyfél, amely egy eszköz regisztrációjának futtatására használható a kiépítési szolgáltatással szimmetrikus kulcs vagy X509-hitelesítés használatával.
Inicializálja a kiépítési ügyfelet.
MEGJEGYZÉS: Ezt az inicializálót nem szabad közvetlenül meghívni. Ehelyett a create_from_ kezdődő osztálymetódusokat kell használni egy ügyfélobjektum létrehozásához.
- Öröklődés
-
azure.iot.device.provisioning.abstract_provisioning_device_client.AbstractProvisioningDeviceClientProvisioningDeviceClient
Konstruktor
ProvisioningDeviceClient(pipeline)
Paraméterek
Name | Description |
---|---|
pipeline
Kötelező
|
<xref:azure.iot.device.provisioning.pipeline.MQTTPipeline>
A kiépítési folyamat objektumának példánya. |
Metódusok
create_from_symmetric_key |
Hozzon létre egy ügyfelet, amely egy eszköz regisztrációjának futtatására használható a kiépítési szolgáltatással szimmetrikus kulcsos hitelesítéssel. |
create_from_x509_certificate |
Hozzon létre egy ügyfelet, amellyel X509-tanúsítványhitelesítéssel futtathatja egy eszköz regisztrációját a kiépítési szolgáltatással. |
register |
Regisztrálja az eszközt a kiépítési szolgáltatásban. A visszatérés előtt az ügyfél szintén leválasztja a kapcsolatot a kiépítési szolgáltatással. Ha egy korábbi regisztráció során regisztrációs kísérlet történik, az hibát jelezhet. Az eszköz sikeres regisztrálása után az ügyfél többé nem lesz működőképes. |
create_from_symmetric_key
Hozzon létre egy ügyfelet, amely egy eszköz regisztrációjának futtatására használható a kiépítési szolgáltatással szimmetrikus kulcsos hitelesítéssel.
create_from_symmetric_key(provisioning_host, registration_id, id_scope, symmetric_key, **kwargs)
Paraméterek
Name | Description |
---|---|
provisioning_host
Kötelező
|
A Device Provisioning Service-t futtató gazdagép. A globális eszközvégpont sztringként az Áttekintés lap Azure Portal található. |
registration_id
Kötelező
|
Az eszköz egyedi azonosítására használt regisztrációs azonosító a Device Provisioning Service-ben. A regisztrációs azonosító alfanumerikus, kisbetűs sztring, és kötőjeleket tartalmazhat. |
id_scope
Kötelező
|
Az azonosító hatóköre, amellyel egyedileg azonosíthatja az eszköz által regisztrálandó adott kiépítési szolgáltatást. Az azonosító hatóköre akkor van hozzárendelve egy Device Provisioning Service-hez, ha a felhasználó hozza létre, és a szolgáltatás hozza létre, és nem módosítható, ami egyediséget garantál. |
symmetric_key
Kötelező
|
A kulcs, amely a közös hozzáférésű jogosultságkód-jogkivonat létrehozásához lesz felhasználva az eszköz Device Provisioning Service-beli hitelesítéséhez. Alapértelmezés szerint a Device Provisioning Service új szimmetrikus kulcsokat hoz létre, amelyek alapértelmezett hossza 32 bájt, amikor az új regisztrációk mentésekor az Automatikus kulcsok létrehozása beállítás engedélyezve van. A felhasználók saját szimmetrikus kulcsokat adhatnak meg a regisztrációkhoz, ha letiltják ezt a beállítást 16 bájton és 64 bájton belül, érvényes Base64 formátumban. |
server_verification_cert
Kötelező
|
Konfigurációs lehetőség. A megbízható tanúsítványlánc. Olyan végponthoz való csatlakozáshoz szükséges, amely nem szabványos megbízhatósági gyökerű, például protokollátjáróval rendelkezik. |
gateway_hostname
Kötelező
|
Konfigurációs lehetőség. Az átjáróeszköz átjáró-állomásneve. |
websockets
Kötelező
|
Konfigurációs lehetőség. Az alapértelmezett érték Hamis. Állítsa true (igaz) értékre, ha az MQTT-t websocketeken keresztül használja. |
cipher
Kötelező
|
Konfigurációs lehetőség. Titkosítási csomag(ok) TLS/SSL-hez, "OpenSSL titkosítólista-formátum" sztringként vagy titkosítócsomag-sztringek listájaként. |
proxy_options
Kötelező
|
A forgalom proxykiszolgálókon keresztüli küldésének lehetőségei. |
keepalive
Kötelező
|
A közvetítővel folytatott kommunikáció közötti maximális időtartam másodpercben. Ha nincs más üzenetváltás, ez szabályozza, hogy az ügyfél milyen sebességgel küld pingüzeneteket a közvetítőnek. Ha nem adja meg az alapértelmezett 60 másodperces értéket, a rendszer a függvényt fogja használni. |
Válaszok
Típus | Description |
---|---|
Egy ProvisioningDeviceClient-példány, amely szimmetrikus kulccsal regisztrálható. |
Kivételek
Típus | Description |
---|---|
TypeError if given an unrecognized parameter.
|
create_from_x509_certificate
Hozzon létre egy ügyfelet, amellyel X509-tanúsítványhitelesítéssel futtathatja egy eszköz regisztrációját a kiépítési szolgáltatással.
create_from_x509_certificate(provisioning_host, registration_id, id_scope, x509, **kwargs)
Paraméterek
Name | Description |
---|---|
provisioning_host
Kötelező
|
A Device Provisioning Service-t futtató gazdagép. A globális eszközvégpont sztringként az Áttekintés lap Azure Portal található. |
registration_id
Kötelező
|
Az eszköz egyedi azonosítására használt regisztrációs azonosító a Device Provisioning Service-ben. A regisztrációs azonosító alfanumerikus, kisbetűs sztring, és kötőjeleket tartalmazhat. |
id_scope
Kötelező
|
Az azonosító hatóköre annak az adott kiépítési szolgáltatásnak az egyedi azonosítására szolgál, amellyel az eszköz regisztrálva lesz. Az azonosító hatóköre akkor van hozzárendelve egy Device Provisioning Service-hez, ha a felhasználó hozza létre, és a szolgáltatás hozza létre, és nem módosítható, ami egyediséget garantál. |
x509
Kötelező
|
Az x509-tanúsítvány, A tanúsítvány használatához a regisztrációs objektumnak tartalmaznia kell a tanúsítványt (vagy a főtanúsítványt vagy az egyik köztes hitelesítésszolgáltatói tanúsítványt). Ha a tanúsítvány egy CER-fájlból származik, base64 kódolásúnak kell lennie. |
server_verification_cert
Kötelező
|
Konfigurációs lehetőség. A megbízható tanúsítványlánc. Olyan végponthoz való csatlakozáshoz szükséges, amely nem szabványos megbízhatósági gyökerű, például protokollátjáróval rendelkezik. |
gateway_hostname
Kötelező
|
Konfigurációs lehetőség. Az átjáróeszköz átjáró-állomásneve. |
websockets
Kötelező
|
Konfigurációs lehetőség. Az alapértelmezett érték Hamis. Állítsa true (igaz) értékre, ha az MQTT-t websocketeken keresztül használja. |
cipher
Kötelező
|
Konfigurációs lehetőség. Titkosítási csomag(ok) TLS/SSL-hez, "OpenSSL titkosítólista-formátum" sztringként vagy titkosítócsomag-sztringek listájaként. |
proxy_options
Kötelező
|
A forgalom proxykiszolgálókon keresztüli küldésének lehetőségei. |
keepalive
Kötelező
|
A közvetítővel folytatott kommunikáció közötti maximális időtartam másodpercben. Ha nincs más üzenetváltás, ez szabályozza, hogy az ügyfél milyen sebességgel küld pingüzeneteket a közvetítőnek. Ha nem adja meg az alapértelmezett 60 másodperces értéket, a rendszer a függvényt fogja használni. |
Válaszok
Típus | Description |
---|---|
Egy ProvisioningDeviceClient, amely X509-ügyféltanúsítványokon keresztül regisztrálható. |
Kivételek
Típus | Description |
---|---|
TypeError if given an unrecognized parameter.
|
register
Regisztrálja az eszközt a kiépítési szolgáltatásban.
A visszatérés előtt az ügyfél szintén leválasztja a kapcsolatot a kiépítési szolgáltatással. Ha egy korábbi regisztráció során regisztrációs kísérlet történik, az hibát jelezhet.
Az eszköz sikeres regisztrálása után az ügyfél többé nem lesz működőképes.
async register()
Válaszok
Típus | Description |
---|---|
RegistrationResult, amely a regisztráció eredményét jelzi. |
Kivételek
Típus | Description |
---|---|
ha a hitelesítő adatok érvénytelenek, és nem hozható létre kapcsolat. |
|
ha egy kapcsolat létrehozása hibát eredményez. |
|
ha a kapcsolat megszakad a végrehajtás során. |
|
ha a végrehajtás során váratlan hiba történik. |
Attribútumok
provisioning_payload
Azure SDK for Python
Visszajelzés
https://aka.ms/ContentUserFeedback.
Hamarosan elérhető: 2024-ben fokozatosan kivezetjük a GitHub-problémákat a tartalom visszajelzési mechanizmusaként, és lecseréljük egy új visszajelzési rendszerre. További információ:Visszajelzés küldése és megtekintése a következőhöz: