ProvisioningDeviceClient Klasa

Klient, który może służyć do uruchamiania rejestracji urządzenia z usługą aprowizacji przy użyciu klucza symetrycznego lub uwierzytelniania X509.

Inicjuje klienta aprowizacji.

UWAGA: Ten inicjator nie powinien być wywoływany bezpośrednio. Zamiast tego metody klasy rozpoczynające się od create_from_ należy użyć do utworzenia obiektu klienta.

Dziedziczenie

azure.iot.device.provisioning.abstract_provisioning_device_client.AbstractProvisioningDeviceClient

ProvisioningDeviceClient

Konstruktor

ProvisioningDeviceClient(pipeline)

Parametry

Nazwa	Opis
pipeline Wymagane	<xref:azure.iot.device.provisioning.pipeline.MQTTPipeline> Wystąpienie obiektu potoku aprowizacji.

Metody

create_from_symmetric_key	Utwórz klienta, który może służyć do uruchamiania rejestracji urządzenia z usługą aprowizacji przy użyciu uwierzytelniania klucza symetrycznego.
create_from_x509_certificate	Utwórz klienta, który może służyć do uruchamiania rejestracji urządzenia z usługą aprowizacji przy użyciu uwierzytelniania certyfikatu X509.
register	Rejestrowanie urządzenia w usłudze aprowizacji Jest to wywołanie synchroniczne, co oznacza, że ta funkcja nie zostanie zwrócona, dopóki proces rejestracji nie zakończy się pomyślnie lub próba spowodowała niepowodzenie. Przed powrotem klient odłączy się również od usługi aprowizacji. Jeśli podjęto próbę rejestracji podczas poprzedniej rejestracji, może to spowodować wystąpienie błędu. Po pomyślnym zarejestrowaniu urządzenia klient nie będzie już działać.

create_from_symmetric_key

Utwórz klienta, który może służyć do uruchamiania rejestracji urządzenia z usługą aprowizacji przy użyciu uwierzytelniania klucza symetrycznego.

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

Parametry

Nazwa	Opis
provisioning_host Wymagane	str Host z uruchomioną usługą Device Provisioning. Można znaleźć w Azure Portal na karcie Przegląd jako ciąg Globalny punkt końcowy urządzenia.
registration_id Wymagane	str Identyfikator rejestracji używany do unikatowego identyfikowania urządzenia w usłudze Device Provisioning Service. Identyfikator rejestracji to alfanumeryczne, małe litery i mogą zawierać łączniki.
id_scope Wymagane	str Zakres identyfikatorów używany do unikatowego identyfikowania określonej usługi aprowizacji, za pomocą którego urządzenie zostanie zarejestrowane. Zakres identyfikatora jest przypisywany do usługi Device Provisioning Service, gdy jest tworzony przez użytkownika i jest generowany przez usługę i jest niezmienny, co gwarantuje unikatowość.
symmetric_key Wymagane	str Klucz, który zostanie użyty do utworzenia tokenu sygnatury dostępu współdzielonego w celu uwierzytelnienia urządzenia w usłudze Device Provisioning. Domyślnie usługa Device Provisioning Service tworzy nowe klucze symetryczne o domyślnej długości 32 bajtów po zapisaniu nowych rejestracji z włączoną opcją Automatyczne generowanie kluczy. Użytkownicy mogą udostępniać własne klucze symetryczne dla rejestracji, wyłączając tę opcję w ciągu 16 bajtów i 64 bajtów oraz w prawidłowym formacie Base64.
server_verification_cert Wymagane	str Opcja konfiguracji. Łańcuch zaufanych certyfikatów. Konieczne podczas nawiązywania połączenia z punktem końcowym, który ma nietypowy katalog główny zaufania, taki jak brama protokołu.
gateway_hostname Wymagane	str Opcja konfiguracji. Nazwa hosta bramy dla urządzenia bramy.
websockets Wymagane	bool Opcja konfiguracji. Wartość domyślna to Fałsz. Ustaw wartość true, jeśli używasz protokołu MQTT za pośrednictwem obiektów websocket.
cipher Wymagane	str lub list(str) Opcja konfiguracji. Zestawy szyfrowania dla protokołu TLS/SSL jako ciąg w formacie listy szyfrowania OpenSSL lub jako lista ciągów pakietu szyfrowania.
proxy_options Wymagane	ProxyOptions Opcje wysyłania ruchu przez serwery proxy.
keepalive Wymagane	int Maksymalny okres w sekundach między komunikacją z brokerem. Jeśli nie są wymieniane żadne inne komunikaty, steruje to szybkością wysyłania komunikatów ping przez klienta do brokera. Jeśli nie podano wartości domyślnej 60 s, zostanie użyta.

Zwraca

Typ	Opis
	Wystąpienie ProvisioningDeviceClient, które można zarejestrować za pomocą klucza symetrycznego.

Wyjątki

Typ	Opis
TypeError if given an unrecognized parameter.

create_from_x509_certificate

Utwórz klienta, który może służyć do uruchamiania rejestracji urządzenia z usługą aprowizacji przy użyciu uwierzytelniania certyfikatu X509.

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

Parametry

Nazwa	Opis
provisioning_host Wymagane	str Host z uruchomioną usługą Device Provisioning. Można znaleźć w Azure Portal na karcie Przegląd jako ciąg Globalny punkt końcowy urządzenia.
registration_id Wymagane	str Identyfikator rejestracji używany do unikatowego identyfikowania urządzenia w usłudze Device Provisioning Service. Identyfikator rejestracji to alfanumeryczne, małe litery i mogą zawierać łączniki.
id_scope Wymagane	str Zakres identyfikatora służy do unikatowego identyfikowania określonej usługi aprowizacji, za pomocą którego urządzenie zostanie zarejestrowane. Zakres identyfikatora jest przypisywany do usługi Device Provisioning Service, gdy jest tworzony przez użytkownika i jest generowany przez usługę i jest niezmienny, co gwarantuje unikatowość.
x509 Wymagane	X509 Certyfikat x509, aby użyć certyfikatu, obiekt rejestracji musi zawierać certyfikat (certyfikat główny lub jeden z certyfikatów pośredniego urzędu certyfikacji). Jeśli certyfikat pochodzi z pliku CER, musi być zakodowany w formacie base64.
server_verification_cert Wymagane	str Opcja konfiguracji. Łańcuch zaufanych certyfikatów. Konieczne podczas nawiązywania połączenia z punktem końcowym, który ma nietypowy katalog główny zaufania, taki jak brama protokołu.
gateway_hostname Wymagane	str Opcja konfiguracji. Nazwa hosta bramy dla urządzenia bramy.
websockets Wymagane	bool Opcja konfiguracji. Wartość domyślna to Fałsz. Ustaw wartość true, jeśli używasz protokołu MQTT za pośrednictwem obiektów websocket.
cipher Wymagane	str lub list(str) Opcja konfiguracji. Zestawy szyfrowania dla protokołu TLS/SSL jako ciąg w formacie listy szyfrowania OpenSSL lub jako lista ciągów pakietu szyfrowania.
proxy_options Wymagane	ProxyOptions Opcje wysyłania ruchu przez serwery proxy.
keepalive Wymagane	int Maksymalny okres w sekundach między komunikacją z brokerem. Jeśli nie są wymieniane żadne inne komunikaty, steruje to szybkością wysyłania komunikatów ping przez klienta do brokera. Jeśli nie podano wartości domyślnej 60 s, zostanie użyta.

Zwraca

Typ	Opis
	ProvisioningDeviceClient, który może zarejestrować się za pośrednictwem certyfikatów klienta X509.

Wyjątki

Typ	Opis
TypeError if given an unrecognized parameter.

register

Rejestrowanie urządzenia w usłudze aprowizacji

Jest to wywołanie synchroniczne, co oznacza, że ta funkcja nie zostanie zwrócona, dopóki proces rejestracji nie zakończy się pomyślnie lub próba spowodowała niepowodzenie. Przed powrotem klient odłączy się również od usługi aprowizacji. Jeśli podjęto próbę rejestracji podczas poprzedniej rejestracji, może to spowodować wystąpienie błędu.

Po pomyślnym zarejestrowaniu urządzenia klient nie będzie już działać.

register()

Zwraca

Typ	Opis
RegistrationResult	RegistrationResult wskazujący wynik rejestracji.

Wyjątki

Typ	Opis
CredentialError	jeśli poświadczenia są nieprawidłowe i nie można ustanowić połączenia.
ConnectionFailedError	jeśli nawiązanie połączenia spowoduje niepowodzenie.
ConnectionDroppedError	jeśli połączenie zostanie utracone podczas wykonywania.
OperationTimeout	jeśli przekroczono limit czasu połączenia.
ClientError	jeśli podczas wykonywania wystąpi nieoczekiwany błąd.

Atrybuty

provisioning_payload