ProvisioningDeviceClient Klasse

  • Referenz

Client, der verwendet werden kann, um die Registrierung eines Geräts mit dem Bereitstellungsdienst mithilfe von symmetrischen Schlüsseln oder X509-Authentifizierung auszuführen.

Initialisiert den Bereitstellungsclient.

HINWEIS: Dieser Initialisierer sollte nicht direkt aufgerufen werden. Stattdessen sollten die Klassenmethoden, die mit create_from_ beginnen, verwendet werden, um ein Clientobjekt zu erstellen.

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

Konstruktor

ProvisioningDeviceClient(pipeline)

Parameter

Name Beschreibung
pipeline
Erforderlich
<xref:azure.iot.device.provisioning.pipeline.MQTTPipeline>

Instanz des Bereitstellungspipelineobjekts.

Methoden

create_from_symmetric_key

Erstellen Sie einen Client, mit dem die Registrierung eines Geräts mit dem Bereitstellungsdienst mithilfe der Authentifizierung mit symmetrischen Schlüsseln ausgeführt werden kann.
create_from_x509_certificate

Erstellen Sie einen Client, mit dem die Registrierung eines Geräts beim Bereitstellungsdienst mithilfe der X509-Zertifikatauthentifizierung ausgeführt werden kann.
register

Registrieren des Geräts beim Bereitstellungsdienst

Dies ist ein synchroner Aufruf, d. h. diese Funktion wird erst zurückgegeben, wenn der Registrierungsvorgang erfolgreich abgeschlossen wurde oder der Versuch zu einem Fehler geführt hat. Vor der Rückgabe trennt der Client auch die Verbindung mit dem Bereitstellungsdienst. Wenn ein Registrierungsversuch durchgeführt wird, während eine vorherige Registrierung ausgeführt wird, kann ein Fehler ausgelöst werden.

Nachdem das Gerät erfolgreich registriert wurde, kann der Client nicht mehr verwendet werden.

create_from_symmetric_key

Erstellen Sie einen Client, mit dem die Registrierung eines Geräts mit dem Bereitstellungsdienst mithilfe der Authentifizierung mit symmetrischen Schlüsseln ausgeführt werden kann.

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

Parameter

Name Beschreibung
provisioning_host
Erforderlich
str

Host, auf dem der Device Provisioning-Dienst ausgeführt wird. Befindet sich im Azure-Portal auf der Registerkarte Übersicht als Zeichenfolge Globaler Geräteendpunkt.
registration_id
Erforderlich
str

Die Registrierungs-ID, die verwendet wird, um ein Gerät im Device Provisioning-Dienst eindeutig zu identifizieren. Die Registrierungs-ID ist alphanumerisch, Zeichenfolge in Kleinbuchstaben und kann Bindestriche enthalten.
id_scope
Erforderlich
str

Der ID-Bereich, der verwendet wird, um den spezifischen Bereitstellungsdienst eindeutig zu identifizieren, über den das Gerät registriert wird. Der ID-Bereich wird einem Device Provisioning-Dienst zugewiesen, wenn er vom Benutzer erstellt wird und vom Dienst generiert wird, und ist unveränderlich, was die Eindeutigkeit garantiert.
symmetric_key
Erforderlich
str

Der Schlüssel, der zum Erstellen des Shared Access Signature-Tokens verwendet wird, um das Gerät beim Device Provisioning Service zu authentifizieren. Device Provisioning Service erstellt standardmäßig neue symmetrische Schlüssel mit einer Standardlänge von 32 Byte, wenn neue Registrierungen mit aktivierter Option Schlüssel automatisch generieren gespeichert werden. Benutzer können ihre eigenen symmetrischen Schlüssel für Registrierungen bereitstellen, indem sie diese Option innerhalb von 16 Bytes und 64 Bytes und im gültigen Base64-Format deaktivieren.
server_verification_cert
Erforderlich
str

Konfigurationsoption. Die vertrauenswürdige Zertifikatkette. Erforderlich, wenn Sie eine Verbindung mit einem Endpunkt herstellen, der über einen nicht standardmäßigen Vertrauensstamm verfügt, z. B. ein Protokollgateway.
gateway_hostname
Erforderlich
str

Konfigurationsoption. Der Gatewayhostname für das Gatewaygerät.
websockets
Erforderlich
bool

Konfigurationsoption. Der Standardwert lautet False. Legen Sie bei Verwendung von MQTT über Websockets auf TRUE fest.
cipher
Erforderlich
str oder list(str)

Konfigurationsoption. Verschlüsselungssammlungen für TLS/SSL, als Zeichenfolge im OpenSSL-Verschlüsselungslistenformat oder als Liste von Verschlüsselungssammlungszeichenfolgen.
proxy_options
Erforderlich
ProxyOptions

Optionen zum Senden von Datenverkehr über Proxyserver.
keepalive
Erforderlich
int

Maximaler Zeitraum in Sekunden zwischen der Kommunikation mit dem Broker. Wenn keine anderen Nachrichten ausgetauscht werden, steuert dies die Rate, mit der der Client Pingnachrichten an den Broker sendet. Wenn nicht angegeben, wird der Standardwert von 60 Sekunden verwendet.

Gibt zurück

Typ Beschreibung

Ein ProvisioningDeviceClient-instance, der sich über einen symmetrischen Schlüssel registrieren kann.

Ausnahmen

Typ Beschreibung
TypeError if given an unrecognized parameter.

create_from_x509_certificate

Erstellen Sie einen Client, mit dem die Registrierung eines Geräts beim Bereitstellungsdienst mithilfe der X509-Zertifikatauthentifizierung ausgeführt werden kann.

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

Parameter

Name Beschreibung
provisioning_host
Erforderlich
str

Host, auf dem der Device Provisioning-Dienst ausgeführt wird. Befindet sich im Azure-Portal auf der Registerkarte Übersicht als Zeichenfolge Globaler Geräteendpunkt.
registration_id
Erforderlich
str

Die Registrierungs-ID, die verwendet wird, um ein Gerät im Device Provisioning-Dienst eindeutig zu identifizieren. Die Registrierungs-ID ist alphanumerisch, Zeichenfolge in Kleinbuchstaben und kann Bindestriche enthalten.
id_scope
Erforderlich
str

Der ID-Bereich wird verwendet, um den spezifischen Bereitstellungsdienst eindeutig zu identifizieren, über den das Gerät registriert wird. Der ID-Bereich wird einem Device Provisioning-Dienst zugewiesen, wenn er vom Benutzer erstellt wird und vom Dienst generiert wird, und ist unveränderlich, was die Eindeutigkeit garantiert.
x509
Erforderlich
X509

Das x509-Zertifikat, Um das Zertifikat zu verwenden, muss das Registrierungsobjekt ein Zertifikat (entweder das Stammzertifikat oder eines der Zwischenzertifikate der Zertifizierungsstelle) enthalten. Wenn das Zertifikat aus einer CER-Datei stammt, muss es base64-codiert sein.
server_verification_cert
Erforderlich
str

Konfigurationsoption. Die vertrauenswürdige Zertifikatkette. Erforderlich, wenn Sie eine Verbindung mit einem Endpunkt herstellen, der über einen nicht standardmäßigen Vertrauensstamm verfügt, z. B. ein Protokollgateway.
gateway_hostname
Erforderlich
str

Konfigurationsoption. Der Gatewayhostname für das Gatewaygerät.
websockets
Erforderlich
bool

Konfigurationsoption. Der Standardwert lautet False. Legen Sie bei Verwendung von MQTT über Websockets auf TRUE fest.
cipher
Erforderlich
str oder list(str)

Konfigurationsoption. Verschlüsselungssammlungen für TLS/SSL, als Zeichenfolge im OpenSSL-Verschlüsselungslistenformat oder als Liste von Verschlüsselungssammlungszeichenfolgen.
proxy_options
Erforderlich
ProxyOptions

Optionen zum Senden von Datenverkehr über Proxyserver.
keepalive
Erforderlich
int

Maximaler Zeitraum in Sekunden zwischen der Kommunikation mit dem Broker. Wenn keine anderen Nachrichten ausgetauscht werden, steuert dies die Rate, mit der der Client Pingnachrichten an den Broker sendet. Wenn nicht angegeben, wird der Standardwert von 60 Sekunden verwendet.

Gibt zurück

Typ Beschreibung

Ein ProvisioningDeviceClient, der sich über X509-Clientzertifikate registrieren kann.

Ausnahmen

Typ Beschreibung
TypeError if given an unrecognized parameter.

register

Registrieren des Geräts beim Bereitstellungsdienst

Dies ist ein synchroner Aufruf, d. h. diese Funktion wird erst zurückgegeben, wenn der Registrierungsvorgang erfolgreich abgeschlossen wurde oder der Versuch zu einem Fehler geführt hat. Vor der Rückgabe trennt der Client auch die Verbindung mit dem Bereitstellungsdienst. Wenn ein Registrierungsversuch durchgeführt wird, während eine vorherige Registrierung ausgeführt wird, kann ein Fehler ausgelöst werden.

Nachdem das Gerät erfolgreich registriert wurde, kann der Client nicht mehr verwendet werden.

register()

Gibt zurück

Typ Beschreibung
RegistrationResult

RegistrationResult, das das Ergebnis der Registrierung angibt.

Ausnahmen

Typ Beschreibung
CredentialError

, wenn anmeldeinformationen ungültig sind und keine Verbindung hergestellt werden kann.
ConnectionFailedError

, wenn das Herstellen einer Verbindung zu einem Fehler führt.
ConnectionDroppedError

, wenn die Verbindung während der Ausführung unterbrochen wird.
OperationTimeout

, wenn für die Verbindung ein Timeout besteht.
ClientError

, wenn während der Ausführung ein unerwarteter Fehler auftritt.

Attribute

provisioning_payload