ProvisioningDeviceClient Osztály

Ügyfél, amely egy eszköz regisztrációjának futtatására használható 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.AbstractProvisioningDeviceClient

ProvisioningDeviceClient

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ó 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	Az eszköz regisztrálása a kiépítési szolgáltatással Ez egy szinkron hívás, ami azt jelenti, hogy ez a függvény csak akkor tér vissza, ha a regisztrációs folyamat sikeresen befejeződött, vagy a kísérlet hibát eredményezett. A visszatérés előtt az ügyfél is leválasztja a kapcsolatot a kiépítési szolgáltatással. Ha egy regisztrációs kísérlet egy korábbi regisztráció közben történik, az hibát jelezhet. Az eszköz sikeres regisztrálása után az ügyfél már 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ó 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ő	str Az Eszközkiépítési szolgáltatást futtató gazdagép. A globális eszközvégpont sztringként az Áttekintés lapon található Azure Portal található.
registration_id Kötelező	str 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 tartalmazhat kötőjeleket.
id_scope Kötelező	str 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 eszközkiépítési szolgáltatáshoz, amikor azt a felhasználó hozza létre, és a szolgáltatás hozza létre, és nem módosítható, garantálva az egyediséget.
symmetric_key Kötelező	str A kulcs, amely a megosztott hozzáférésű jogosultságkód-jogkivonat létrehozásához lesz felhasználva az eszköz Device Provisioning Service-rel való 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 engedélyezve van az Automatikus kulcsok létrehozása beállítás. 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ő	str 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ő	str Konfigurációs lehetőség. Az átjáróeszköz átjáró-állomásneve.
websockets Kötelező	bool Konfigurációs lehetőség. Az alapértelmezett érték Hamis. Állítsa igaz értékre, ha az MQTT-t websocketeken keresztül használja.
cipher Kötelező	str vagy list(str) Konfigurációs lehetőség. Titkosítási csomag(ok) TLS-hez/SSL-hez, "OpenSSL titkosítási listaformátumban" vagy titkosítócsomag-sztringek listájaként.
proxy_options Kötelező	ProxyOptions A proxykiszolgálókon keresztüli forgalom küldésének lehetőségei.
keepalive Kötelező	int 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 a 60 másodperces alapértelmezett értéket, akkor a rendszer az alapértelmezett értéket használja.

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ő	str Az Eszközkiépítési szolgáltatást futtató gazdagép. A globális eszközvégpont sztringként az Áttekintés lapon található Azure Portal található.
registration_id Kötelező	str 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 tartalmazhat kötőjeleket.
id_scope Kötelező	str Az azonosító hatóköre arra szolgál, hogy egyedileg azonosítsa 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 eszközkiépítési szolgáltatáshoz, amikor azt a felhasználó hozza létre, és a szolgáltatás hozza létre, és nem módosítható, garantálva az egyediséget.
x509 Kötelező	X509 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, akkor base64 kódolásúnak kell lennie.
server_verification_cert Kötelező	str 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ő	str Konfigurációs lehetőség. Az átjáróeszköz átjáró-állomásneve.
websockets Kötelező	bool Konfigurációs lehetőség. Az alapértelmezett érték Hamis. Állítsa igaz értékre, ha az MQTT-t websocketeken keresztül használja.
cipher Kötelező	str vagy list(str) Konfigurációs lehetőség. Titkosítási csomag(ok) TLS-hez/SSL-hez, "OpenSSL titkosítási listaformátumban" vagy titkosítócsomag-sztringek listájaként.
proxy_options Kötelező	ProxyOptions A proxykiszolgálókon keresztüli forgalom küldésének lehetőségei.
keepalive Kötelező	int 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 a 60 másodperces alapértelmezett értéket, akkor a rendszer az alapértelmezett értéket használja.

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

Az eszköz regisztrálása a kiépítési szolgáltatással

Ez egy szinkron hívás, ami azt jelenti, hogy ez a függvény csak akkor tér vissza, ha a regisztrációs folyamat sikeresen befejeződött, vagy a kísérlet hibát eredményezett. A visszatérés előtt az ügyfél is leválasztja a kapcsolatot a kiépítési szolgáltatással. Ha egy regisztrációs kísérlet egy korábbi regisztráció közben történik, az hibát jelezhet.

Az eszköz sikeres regisztrálása után az ügyfél már nem lesz működőképes.

register()

Válaszok

Típus	Description
RegistrationResult	RegistrationResult a regisztráció eredményét jelzi.

Kivételek

Típus	Description
CredentialError	ha a hitelesítő adatok érvénytelenek, és nem hozható létre kapcsolat.
ConnectionFailedError	ha a kapcsolat létrehozása sikertelenséget eredményez.
ConnectionDroppedError	ha a kapcsolat megszakad a végrehajtás során.
OperationTimeout	ha a kapcsolat túllépi az időkorlátot.
ClientError	ha a végrehajtás során váratlan hiba történik.

Attribútumok

provisioning_payload