ProvisioningDeviceClient Třída
Klient, který lze použít ke spuštění registrace zařízení se službou zřizování pomocí symetrického klíče nebo ověřování X509.
Inicializuje zřizovacího klienta.
POZNÁMKA: Tento inicializátor by neměl být volána přímo. Místo toho by se k vytvoření objektu klienta měly použít metody třídy, které začínají na create_from_ .
- Dědičnost
-
azure.iot.device.provisioning.abstract_provisioning_device_client.AbstractProvisioningDeviceClientProvisioningDeviceClient
Konstruktor
ProvisioningDeviceClient(pipeline)Parametry
| Name | Description |
|---|---|
|
pipeline
Vyžadováno
|
<xref:azure.iot.device.provisioning.pipeline.MQTTPipeline>
Instance objektu zřizovacího kanálu. |
Metody
| create_from_symmetric_key |
Vytvořte klienta, který se dá použít ke spuštění registrace zařízení se službou zřizování pomocí ověřování symetrickým klíčem. |
| create_from_x509_certificate |
Vytvořte klienta, který se dá použít ke spuštění registrace zařízení se službou zřizování pomocí ověřování certifikátů X509. |
| register |
Registrace zařízení ve službě zřizování Jedná se o synchronní volání, což znamená, že tato funkce se nevrátí, dokud se úspěšně nedokončil proces registrace nebo dokud pokus nezístane neúspěšný. Před vrácením se klient také odpojí od služby zřizování. Pokud se pokus o registraci provede v době, kdy probíhá předchozí registrace, může dojít k chybě. Jakmile se zařízení úspěšně zaregistruje, přestane být klient funkční. |
create_from_symmetric_key
Vytvořte klienta, který se dá použít ke spuštění registrace zařízení se službou zřizování pomocí ověřování symetrickým klíčem.
create_from_symmetric_key(provisioning_host, registration_id, id_scope, symmetric_key, **kwargs)Parametry
| Name | Description |
|---|---|
|
provisioning_host
Vyžadováno
|
Hostitel se spuštěnou službou Device Provisioning. Najdete ho v Azure Portal na kartě Přehled jako řetězec Globální koncový bod zařízení. |
|
registration_id
Vyžadováno
|
ID registrace použité k jedinečné identifikaci zařízení ve službě Device Provisioning. ID registrace je alfanumerický řetězec s malými písmeny a může obsahovat spojovníky. |
|
id_scope
Vyžadováno
|
Obor ID použitý k jedinečné identifikaci konkrétní služby zřizování, přes které se zařízení zaregistruje. Obor ID se přiřadí službě Device Provisioning, když ho uživatel vytvoří a služba ho vygeneruje a je neměnný, takže zaručuje jedinečnost. |
|
symmetric_key
Vyžadováno
|
Klíč, který se použije k vytvoření tokenu sdíleného přístupového podpisu pro ověření zařízení ve službě Device Provisioning. Služba Device Provisioning ve výchozím nastavení vytvoří nové symetrické klíče s výchozí délkou 32 bajtů, když jsou nové registrace uloženy s povolenou možností Automaticky generovat klíče. Uživatelé můžou pro registrace zadat vlastní symetrické klíče zakázáním této možnosti v rozsahu 16 bajtů a 64 bajtů a v platném formátu Base64. |
|
server_verification_cert
Vyžadováno
|
Možnost konfigurace. Řetěz důvěryhodných certifikátů. Je to nezbytné při připojování ke koncovému bodu, který má nestandardní kořen důvěryhodnosti, například bránu protokolu. |
|
gateway_hostname
Vyžadováno
|
Možnost konfigurace. Název hostitele brány pro zařízení brány. |
|
websockets
Vyžadováno
|
Možnost konfigurace. Výchozí hodnota je False. Pokud používáte MQTT přes websockety, nastavte na hodnotu true. |
|
cipher
Vyžadováno
|
Možnost konfigurace. Šifrovací sady pro PROTOKOL TLS/SSL jako řetězec ve formátu seznamu šifer OpenSSL nebo jako seznam řetězců šifrovací sady. |
|
proxy_options
Vyžadováno
|
Možnosti odesílání provozu přes proxy servery |
|
keepalive
Vyžadováno
|
Maximální doba v sekundách mezi komunikací se zprostředkovatelem. Pokud se nevyměňují žádné další zprávy, určuje rychlost, s jakou klient bude zprostředkovateli odesílat zprávy ping. Pokud nezadáte výchozí hodnotu 60 sekund, použije se. |
Návraty
| Typ | Description |
|---|---|
|
Instance ProvisioningDeviceClient, která se může zaregistrovat prostřednictvím symetrického klíče. |
Výjimky
| Typ | Description |
|---|---|
|
TypeError if given an unrecognized parameter.
|
create_from_x509_certificate
Vytvořte klienta, který se dá použít ke spuštění registrace zařízení se službou zřizování pomocí ověřování certifikátů X509.
create_from_x509_certificate(provisioning_host, registration_id, id_scope, x509, **kwargs)Parametry
| Name | Description |
|---|---|
|
provisioning_host
Vyžadováno
|
Hostitel se spuštěnou službou Device Provisioning. Najdete ho v Azure Portal na kartě Přehled jako řetězec Globální koncový bod zařízení. |
|
registration_id
Vyžadováno
|
ID registrace použité k jedinečné identifikaci zařízení ve službě Device Provisioning. ID registrace je alfanumerický řetězec s malými písmeny a může obsahovat spojovníky. |
|
id_scope
Vyžadováno
|
Obor ID se používá k jedinečné identifikaci konkrétní služby zřizování, přes které se zařízení zaregistruje. Obor ID se přiřadí službě Device Provisioning, když ho uživatel vytvoří a služba ho vygeneruje a je neměnný, takže zaručuje jedinečnost. |
|
x509
Vyžadováno
|
Certifikát x509: Pokud chcete certifikát použít, musí objekt zápisu obsahovat certifikát (kořenový certifikát nebo jeden z certifikátů zprostředkující certifikační autority). Pokud certifikát pochází ze souboru CER, musí být kódovaný base64. |
|
server_verification_cert
Vyžadováno
|
Možnost konfigurace. Řetěz důvěryhodných certifikátů. Je to nezbytné při připojování ke koncovému bodu, který má nestandardní kořen důvěryhodnosti, například bránu protokolu. |
|
gateway_hostname
Vyžadováno
|
Možnost konfigurace. Název hostitele brány pro zařízení brány. |
|
websockets
Vyžadováno
|
Možnost konfigurace. Výchozí hodnota je False. Pokud používáte MQTT přes websockety, nastavte na hodnotu true. |
|
cipher
Vyžadováno
|
Možnost konfigurace. Šifrovací sady pro PROTOKOL TLS/SSL jako řetězec ve formátu seznamu šifer OpenSSL nebo jako seznam řetězců šifrovací sady. |
|
proxy_options
Vyžadováno
|
Možnosti odesílání provozu přes proxy servery |
|
keepalive
Vyžadováno
|
Maximální doba v sekundách mezi komunikací se zprostředkovatelem. Pokud se nevyměňují žádné další zprávy, určuje rychlost, s jakou klient bude zprostředkovateli odesílat zprávy ping. Pokud nezadáte výchozí hodnotu 60 sekund, použije se. |
Návraty
| Typ | Description |
|---|---|
|
ProvisioningDeviceClient, který se může zaregistrovat prostřednictvím klientských certifikátů X509. |
Výjimky
| Typ | Description |
|---|---|
|
TypeError if given an unrecognized parameter.
|
register
Registrace zařízení ve službě zřizování
Jedná se o synchronní volání, což znamená, že tato funkce se nevrátí, dokud se úspěšně nedokončil proces registrace nebo dokud pokus nezístane neúspěšný. Před vrácením se klient také odpojí od služby zřizování. Pokud se pokus o registraci provede v době, kdy probíhá předchozí registrace, může dojít k chybě.
Jakmile se zařízení úspěšně zaregistruje, přestane být klient funkční.
register()Návraty
| Typ | Description |
|---|---|
|
RegistrationResult označující výsledek registrace. |
Výjimky
| Typ | Description |
|---|---|
|
pokud jsou přihlašovací údaje neplatné a nelze navázat připojení. |
|
|
pokud navázání připojení vede k selhání. |
|
|
pokud během provádění dojde ke ztrátě připojení. |
|
|
pokud vyprší časový limit připojení. |
|
|
pokud během provádění dojde k neočekávanému selhání. |
Atributy
provisioning_payload
Azure SDK for Python
Váš názor
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu: https://aka.ms/ContentUserFeedback.
Odeslat a zobrazit názory pro