ProvisioningDeviceClient Klas

Client die kan worden gebruikt om de registratie van een apparaat met inrichtingsservice uit te voeren met behulp van symmetrische sleutel of X509-verificatie.

Initialiseert de inrichtingsclient.

OPMERKING: Deze initialisatiefunctie mag niet rechtstreeks worden aangeroepen. In plaats daarvan moeten de klassemethoden die beginnen met create_from_ worden gebruikt om een clientobject te maken.

Overname

azure.iot.device.provisioning.abstract_provisioning_device_client.AbstractProvisioningDeviceClient

ProvisioningDeviceClient

Constructor

ProvisioningDeviceClient(pipeline)

Parameters

Name	Description
pipeline Vereist	<xref:azure.iot.device.provisioning.pipeline.MQTTPipeline> Exemplaar van het inrichtingspijplijnobject.

Methoden

create_from_symmetric_key	Maak een client die kan worden gebruikt om de registratie van een apparaat met de inrichtingsservice uit te voeren met behulp van symmetrische sleutelverificatie.
create_from_x509_certificate	Maak een client die kan worden gebruikt om de registratie van een apparaat met de inrichtingsservice uit te voeren met behulp van X509-certificaatverificatie.
register	Het apparaat registreren bij de inrichtingsservice Dit is een synchrone aanroep, wat betekent dat deze functie pas wordt geretourneerd als het registratieproces is voltooid of de poging heeft geleid tot een fout. Voordat de client wordt geretourneerd, wordt ook de verbinding met de inrichtingsservice verbroken. Als er een registratiepoging wordt uitgevoerd terwijl een eerdere registratie wordt uitgevoerd, kan dit een fout veroorzaken. Zodra het apparaat is geregistreerd, kan de client niet meer worden gebruikt.

create_from_symmetric_key

Maak een client die kan worden gebruikt om de registratie van een apparaat met de inrichtingsservice uit te voeren met behulp van symmetrische sleutelverificatie.

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

Parameters

Name	Description
provisioning_host Vereist	str Host waarop de Device Provisioning Service wordt uitgevoerd. U vindt deze in de Azure Portal op het tabblad Overzicht als de tekenreeks Globaal apparaateindpunt.
registration_id Vereist	str De registratie-id die wordt gebruikt om een apparaat uniek te identificeren in Device Provisioning Service. De registratie-id is alfanumerieke tekenreeks in kleine letters en kan afbreekstreepjes bevatten.
id_scope Vereist	str Het id-bereik dat wordt gebruikt om de specifieke inrichtingsservice te identificeren waarmee het apparaat wordt geregistreerd. Het id-bereik wordt toegewezen aan een Device Provisioning Service wanneer het wordt gemaakt door de gebruiker en wordt gegenereerd door de service en is onveranderbaar, waardoor uniekheid wordt gegarandeerd.
symmetric_key Vereist	str De sleutel die wordt gebruikt om het Shared Access Signature-token te maken om het apparaat te verifiëren bij Device Provisioning Service. De Device Provisioning Service maakt standaard nieuwe symmetrische sleutels met een standaardlengte van 32 bytes wanneer nieuwe inschrijvingen worden opgeslagen met de optie Sleutels automatisch genereren ingeschakeld. Gebruikers kunnen hun eigen symmetrische sleutels opgeven voor inschrijvingen door deze optie uit te schakelen binnen 16 bytes en 64 bytes en in een geldige Base64-indeling.
server_verification_cert Vereist	str Configuratieoptie. De vertrouwde certificaatketen. Dit is nodig wanneer u verbinding maakt met een eindpunt dat een niet-standaardvertrouwensbasis heeft, zoals een protocolgateway.
gateway_hostname Vereist	str Configuratieoptie. De hostnaam van de gateway voor het gatewayapparaat.
websockets Vereist	bool Configuratieoptie. De standaardwaarde is Onwaar. Stel in op true als U MQTT via websockets gebruikt.
cipher Vereist	str of list(str) Configuratieoptie. Coderingssuite(s) voor TLS/SSL, als tekenreeks in 'OpenSSL-coderingslijstindeling' of als een lijst met coderingssuitetekenreeksen.
proxy_options Vereist	ProxyOptions Opties voor het verzenden van verkeer via proxyservers.
keepalive Vereist	int Maximale periode in seconden tussen de communicatie met de broker. Als er geen andere berichten worden uitgewisseld, bepaalt dit de snelheid waarmee de client pingberichten naar de broker verzendt. Indien niet opgegeven, wordt de standaardwaarde van 60 seconden gebruikt.

Retouren

Type	Description
	Een ProvisioningDeviceClient-exemplaar dat kan worden geregistreerd via een symmetrische sleutel.

Uitzonderingen

Type	Description
TypeError if given an unrecognized parameter.

create_from_x509_certificate

Maak een client die kan worden gebruikt om de registratie van een apparaat met de inrichtingsservice uit te voeren met behulp van X509-certificaatverificatie.

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

Parameters

Name	Description
provisioning_host Vereist	str Host waarop de Device Provisioning Service wordt uitgevoerd. U vindt deze in de Azure Portal op het tabblad Overzicht als de tekenreeks Globaal apparaateindpunt.
registration_id Vereist	str De registratie-id die wordt gebruikt om een apparaat uniek te identificeren in Device Provisioning Service. De registratie-id is alfanumerieke tekenreeks in kleine letters en kan afbreekstreepjes bevatten.
id_scope Vereist	str Het id-bereik wordt gebruikt om de specifieke inrichtingsservice te identificeren waarmee het apparaat wordt geregistreerd. Het id-bereik wordt toegewezen aan een Device Provisioning Service wanneer het wordt gemaakt door de gebruiker en wordt gegenereerd door de service en is onveranderbaar, waardoor uniekheid wordt gegarandeerd.
x509 Vereist	X509 Het x509-certificaat: Als u het certificaat wilt gebruiken, moet het inschrijvingsobject een certificaat bevatten (het basiscertificaat of een van de tussenliggende CA-certificaten). Als het certificaat afkomstig is van een CER-bestand, moet het base64-codering hebben.
server_verification_cert Vereist	str Configuratieoptie. De vertrouwde certificaatketen. Dit is nodig wanneer u verbinding maakt met een eindpunt dat een niet-standaardvertrouwensbasis heeft, zoals een protocolgateway.
gateway_hostname Vereist	str Configuratieoptie. De hostnaam van de gateway voor het gatewayapparaat.
websockets Vereist	bool Configuratieoptie. De standaardwaarde is Onwaar. Stel in op true als U MQTT via websockets gebruikt.
cipher Vereist	str of list(str) Configuratieoptie. Coderingssuite(s) voor TLS/SSL, als tekenreeks in 'OpenSSL-coderingslijstindeling' of als een lijst met coderingssuitetekenreeksen.
proxy_options Vereist	ProxyOptions Opties voor het verzenden van verkeer via proxyservers.
keepalive Vereist	int Maximale periode in seconden tussen de communicatie met de broker. Als er geen andere berichten worden uitgewisseld, bepaalt dit de snelheid waarmee de client pingberichten naar de broker verzendt. Indien niet opgegeven, wordt de standaardwaarde van 60 seconden gebruikt.

Retouren

Type	Description
	Een ProvisioningDeviceClient die kan worden geregistreerd via X509-clientcertificaten.

Uitzonderingen

Type	Description
TypeError if given an unrecognized parameter.

register

Het apparaat registreren bij de inrichtingsservice

Dit is een synchrone aanroep, wat betekent dat deze functie pas wordt geretourneerd als het registratieproces is voltooid of de poging heeft geleid tot een fout. Voordat de client wordt geretourneerd, wordt ook de verbinding met de inrichtingsservice verbroken. Als er een registratiepoging wordt uitgevoerd terwijl een eerdere registratie wordt uitgevoerd, kan dit een fout veroorzaken.

Zodra het apparaat is geregistreerd, kan de client niet meer worden gebruikt.

register()

Retouren

Type	Description
RegistrationResult	RegistrationResult waarmee het resultaat van de registratie wordt aangegeven.

Uitzonderingen

Type	Description
CredentialError	als referenties ongeldig zijn en er geen verbinding tot stand kan worden gebracht.
ConnectionFailedError	als het tot stand brengen van een verbinding mislukt.
ConnectionDroppedError	als de verbinding tijdens de uitvoering is verbroken.
OperationTimeout	als er een time-out optreedt voor de verbinding.
ClientError	als er een onverwachte fout optreedt tijdens de uitvoering.

Kenmerken

provisioning_payload