ProvisioningDeviceClient Klass

Klient som kan användas för att köra registreringen av en enhet med etableringstjänsten med symmetrisk nyckel eller X509-autentisering.

Initierar etableringsklienten.

Obs! Den här initieraren bör inte anropas direkt. I stället ska klassmetoderna som börjar med create_from_ användas för att skapa ett klientobjekt.

Arv

azure.iot.device.provisioning.abstract_provisioning_device_client.AbstractProvisioningDeviceClient

ProvisioningDeviceClient

Konstruktor

ProvisioningDeviceClient(pipeline)

Parametrar

Name	Description
pipeline Obligatorisk	<xref:azure.iot.device.provisioning.pipeline.MQTTPipeline> Instans av etableringspipelineobjektet.

Metoder

create_from_symmetric_key	Skapa en klient som kan användas för att köra registreringen av en enhet med etableringstjänsten med symmetrisk nyckelautentisering.
create_from_x509_certificate	Skapa en klient som kan användas för att köra registreringen av en enhet med etableringstjänsten med X509-certifikatautentisering.
register	Registrera enheten med etableringstjänsten Det här är ett synkront anrop, vilket innebär att den här funktionen inte returneras förrän registreringsprocessen har slutförts eller om försöket har resulterat i ett fel. Innan du återvänder kopplar klienten också från etableringstjänsten. Om ett registreringsförsök görs medan en tidigare registrering pågår kan det utlösa ett fel. När enheten har registrerats kommer klienten inte längre att kunna användas.

create_from_symmetric_key

Skapa en klient som kan användas för att köra registreringen av en enhet med etableringstjänsten med symmetrisk nyckelautentisering.

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

Parametrar

Name	Description
provisioning_host Obligatorisk	str Värd som kör enhetsetableringstjänsten. Finns i Azure Portal på fliken Översikt som strängen Global enhetsslutpunkt.
registration_id Obligatorisk	str Registrerings-ID:t som används för att unikt identifiera en enhet i enhetsetableringstjänsten. Registrerings-ID:t är alfanumeriskt, gemener och kan innehålla bindestreck.
id_scope Obligatorisk	str Det ID-omfång som används för att unikt identifiera den specifika etableringstjänst som enheten registreras via. ID-omfånget tilldelas till en enhetsetableringstjänst när den skapas av användaren och genereras av tjänsten och är oföränderlig, vilket garanterar unikhet.
symmetric_key Obligatorisk	str Nyckeln som ska användas för att skapa signaturtoken för delad åtkomst för att autentisera enheten med enhetsetableringstjänsten. Som standard skapar Enhetsetableringstjänsten nya symmetriska nycklar med en standardlängd på 32 byte när nya registreringar sparas med alternativet Autogenerera nycklar aktiverat. Användare kan ange egna symmetriska nycklar för registreringar genom att inaktivera det här alternativet inom 16 byte och 64 byte och i giltigt Base64-format.
server_verification_cert Obligatorisk	str Konfigurationsalternativ. Den betrodda certifikatkedjan. Krävs när du ansluter till en slutpunkt som har en förtroenderot som inte är standard, till exempel en protokollgateway.
gateway_hostname Obligatorisk	str Konfigurationsalternativ. Gatewayens värdnamn för gatewayenheten.
websockets Obligatorisk	bool Konfigurationsalternativ. Standardvärdet är Falskt. Ange till sant om du använder MQTT över websockets.
cipher Obligatorisk	str eller list(str) Konfigurationsalternativ. Chiffersviter för TLS/SSL, som en sträng i formatet OpenSSL-chifferlista eller som en lista över chiffersvitsträngar.
proxy_options Obligatorisk	ProxyOptions Alternativ för att skicka trafik via proxyservrar.
keepalive Obligatorisk	int Maximal period i sekunder mellan kommunikation med asynkron meddelandekö. Om inga andra meddelanden utbyts styr detta hastigheten med vilken klienten skickar pingmeddelanden till den asynkrona meddelandekön. Om det inte anges används standardvärdet 60 sek.

Returer

Typ	Description
	En ProvisioningDeviceClient-instans som kan registreras via symmetrisk nyckel.

Undantag

Typ	Description
TypeError if given an unrecognized parameter.

create_from_x509_certificate

Skapa en klient som kan användas för att köra registreringen av en enhet med etableringstjänsten med X509-certifikatautentisering.

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

Parametrar

Name	Description
provisioning_host Obligatorisk	str Värd som kör enhetsetableringstjänsten. Finns i Azure Portal på fliken Översikt som strängen Global enhetsslutpunkt.
registration_id Obligatorisk	str Registrerings-ID:t som används för att unikt identifiera en enhet i enhetsetableringstjänsten. Registrerings-ID:t är alfanumeriskt, gemener och kan innehålla bindestreck.
id_scope Obligatorisk	str ID-omfånget används för att unikt identifiera den specifika etableringstjänst som enheten registreras via. ID-omfånget tilldelas till en enhetsetableringstjänst när den skapas av användaren och genereras av tjänsten och är oföränderlig, vilket garanterar unikhet.
x509 Obligatorisk	X509 X509-certifikatet: Om du vill använda certifikatet måste registreringsobjektet innehålla certifikat (antingen rotcertifikatet eller något av de mellanliggande CA-certifikaten). Om certifikatet kommer från en CER-fil måste det vara base64-kodat.
server_verification_cert Obligatorisk	str Konfigurationsalternativ. Den betrodda certifikatkedjan. Krävs när du ansluter till en slutpunkt som har en förtroenderot som inte är standard, till exempel en protokollgateway.
gateway_hostname Obligatorisk	str Konfigurationsalternativ. Gatewayens värdnamn för gatewayenheten.
websockets Obligatorisk	bool Konfigurationsalternativ. Standardvärdet är Falskt. Ange till sant om du använder MQTT över websockets.
cipher Obligatorisk	str eller list(str) Konfigurationsalternativ. Chiffersviter för TLS/SSL, som en sträng i formatet OpenSSL-chifferlista eller som en lista över chiffersvitsträngar.
proxy_options Obligatorisk	ProxyOptions Alternativ för att skicka trafik via proxyservrar.
keepalive Obligatorisk	int Maximal period i sekunder mellan kommunikation med asynkron meddelandekö. Om inga andra meddelanden utbyts styr detta hastigheten med vilken klienten skickar pingmeddelanden till den asynkrona meddelandekön. Om det inte anges används standardvärdet 60 sek.

Returer

Typ	Description
	En ProvisioningDeviceClient som kan registreras via X509-klientcertifikat.

Undantag

Typ	Description
TypeError if given an unrecognized parameter.

register

Registrera enheten med etableringstjänsten

Det här är ett synkront anrop, vilket innebär att den här funktionen inte returneras förrän registreringsprocessen har slutförts eller om försöket har resulterat i ett fel. Innan du återvänder kopplar klienten också från etableringstjänsten. Om ett registreringsförsök görs medan en tidigare registrering pågår kan det utlösa ett fel.

När enheten har registrerats kommer klienten inte längre att kunna användas.

register()

Returer

Typ	Description
RegistrationResult	RegistrationResult anger resultatet av registreringen.

Undantag

Typ	Description
CredentialError	om autentiseringsuppgifterna är ogiltiga och det inte går att upprätta en anslutning.
ConnectionFailedError	om upprättande av en anslutning resulterar i fel.
ConnectionDroppedError	om anslutningen går förlorad under körningen.
OperationTimeout	om anslutningen överskrider tidsgränsen.
ClientError	om det uppstår ett oväntat fel under körningen.

Attribut

provisioning_payload