IoTHubConfigurationManager Osztály

Az automatikusan létrehozott IotHub REST API-kon alapuló, az IoTHub Configuration Manager műveleteihez használható kényelmi API-kat biztosító osztály

Inicializáló egy Configuration Manager Service-ügyfélhez.

A sikeres létrehozás után az osztály hitelesítése megtörtént az IoTHubon, és készen áll arra, hogy meghívja a tag API-kat az IoTHubbal való kommunikációhoz.

Öröklődés

builtins.object

IoTHubConfigurationManager

Konstruktor

IoTHubConfigurationManager(connection_string=None, host=None, auth=None)

Paraméterek

Name	Description
connection_string	str Az IoTHub kapcsolati sztring az IoTHubtal való kapcsolat hitelesítésére, ha connection_str hitelesítést használunk. Alapértelmezett érték: Nincs alapértelmezett érték: None
host	str Az Azure-szolgáltatás URL-címe, ha token hitelesítő adatokat használunk. Alapértelmezett érték: Nincs alapértelmezett érték: None
auth	str Az Azure-hitelesítési objektum, ha token hitelesítő adatokat használunk. Alapértelmezett érték: Nincs alapértelmezett érték: None

Metódusok

apply_configuration_on_edge_device	Alkalmazza a megadott konfigurációs tartalmat a megadott peremeszközre. A modulok tartalma kötelező.
create_configuration	Létrehoz egy konfigurációt egy IoTHub-eszközökhöz vagy modulokhoz.
delete_configuration	Egy konfiguráció törlése egy IoTHubról.
from_connection_string	Osztálymethod inicializáló egy IoTHubConfigurationManager Service-ügyfélhez. IoTHubConfigurationManager osztályt hoz létre kapcsolati sztring. A sikeres létrehozás után az osztály hitelesítése megtörtént az IoTHubon, és készen áll arra, hogy meghívja a tag API-kat az IoTHubbal való kommunikációhoz.
from_token_credential	Osztálymethod inicializáló egy IoTHubConfigurationManager Service-ügyfélhez. IoTHubConfigurationManager osztályt hoz létre a gazdagépnév URL-címéből és az Azure token hitelesítő adataiból. A sikeres létrehozás után az osztály hitelesítése megtörtént az IoTHubon, és készen áll arra, hogy meghívja a tag API-kat az IoTHubbal való kommunikációhoz.
get_configuration	Lekéri egy adott eszköz IoTHub-konfigurációját.
get_configurations	Egy IoTHub eszközének és moduljainak több konfigurációját kéri le. A megadott számú konfigurációt adja eredményül. A lapozás nem támogatott.
test_configuration_queries	Ellenőrzi a célfeltétel-lekérdezést és az egyéni metrika-lekérdezéseket egy konfigurációhoz.
update_configuration	Frissítések IoTHub-eszközök vagy -modulok konfigurációját. Megjegyzés: a konfigurációazonosítót és a tartalmat a felhasználó nem tudja frissíteni.

apply_configuration_on_edge_device

Alkalmazza a megadott konfigurációs tartalmat a megadott peremeszközre. A modulok tartalma kötelező.

apply_configuration_on_edge_device(device_id, configuration_content)

Paraméterek

Name	Description
configuration_content Kötelező	ConfigurationContent A peremeszköz neve (azonosítója).
device_id Kötelező

Válaszok

Típus	Description
	Objektum.

Kivételek

Típus	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

create_configuration

Létrehoz egy konfigurációt egy IoTHub-eszközökhöz vagy modulokhoz.

create_configuration(configuration)

Paraméterek

Name	Description
configuration_id Kötelező	str A konfiguráció azonosítója.
configuration Kötelező	Configuration A létrehozandó konfiguráció.

Válaszok

Típus	Description
	A létrehozott konfigurációt tartalmazó konfigurációs objektum.

Kivételek

Típus	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

delete_configuration

Egy konfiguráció törlése egy IoTHubról.

delete_configuration(configuration_id, etag=None)

Paraméterek

Name	Description
configuration_id Kötelező	str A konfiguráció azonosítója.
configuration Kötelező	Configuration A létrehozandó konfiguráció.
etag	str A törlési művelethez használandó etag (if_match) érték. alapértelmezett érték: None

Válaszok

Típus	Description
	A frissített konfigurációt tartalmazó konfigurációs objektum.

Kivételek

Típus	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

from_connection_string

Osztálymethod inicializáló egy IoTHubConfigurationManager Service-ügyfélhez. IoTHubConfigurationManager osztályt hoz létre kapcsolati sztring.

A sikeres létrehozás után az osztály hitelesítése megtörtént az IoTHubon, és készen áll arra, hogy meghívja a tag API-kat az IoTHubbal való kommunikációhoz.

from_connection_string(connection_string)

Paraméterek

Name	Description
connection_string Kötelező	str Az IoTHubtal való kapcsolat hitelesítéséhez használt IoTHub kapcsolati sztring.

Válaszok

Típus	Description
IoTHubConfigurationManager

Kivételek

Típus	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

from_token_credential

Osztálymethod inicializáló egy IoTHubConfigurationManager Service-ügyfélhez. IoTHubConfigurationManager osztályt hoz létre a gazdagépnév URL-címéből és az Azure token hitelesítő adataiból.

A sikeres létrehozás után az osztály hitelesítése megtörtént az IoTHubon, és készen áll arra, hogy meghívja a tag API-kat az IoTHubbal való kommunikációhoz.

from_token_credential(url, token_credential)

Paraméterek

Name	Description
url Kötelező	str Az Azure-szolgáltatás URL-címe (állomásnév).
token_credential Kötelező	<xref:azure.core.TokenCredential> Az Azure-jogkivonat hitelesítőadat-objektuma

Válaszok

Típus	Description
IoTHubConfigurationManager

Kivételek

Típus	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_configuration

Lekéri egy adott eszköz IoTHub-konfigurációját.

get_configuration(configuration_id)

Paraméterek

Name	Description
configuration_id Kötelező	str A konfiguráció azonosítója.

Válaszok

Típus	Description
	A Configuration objektum.

Kivételek

Típus	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_configurations

Egy IoTHub eszközének és moduljainak több konfigurációját kéri le. A megadott számú konfigurációt adja eredményül. A lapozás nem támogatott.

get_configurations(max_count=None)

Paraméterek

Name	Description
max_count	int A kért konfigurációk maximális száma. alapértelmezett érték: None

Válaszok

Típus	Description
	A list[Configuration] objektum.

Kivételek

Típus	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

test_configuration_queries

Ellenőrzi a célfeltétel-lekérdezést és az egyéni metrika-lekérdezéseket egy konfigurációhoz.

test_configuration_queries(configuration_queries_test_input)

Paraméterek

Name	Description
configuration_queries_test_input Kötelező	ConfigurationQueriesTestInput A lekérdezések tesztelik a bemenetet.

Válaszok

Típus	Description
	A ConfigurationQueriesTestResponse objektum.

Kivételek

Típus	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

update_configuration

Frissítések IoTHub-eszközök vagy -modulok konfigurációját. Megjegyzés: a konfigurációazonosítót és a tartalmat a felhasználó nem tudja frissíteni.

update_configuration(configuration, etag)

Paraméterek

Name	Description
configuration_id Kötelező	str A konfiguráció azonosítója.
configuration Kötelező	Configuration A konfiguráció tartalmazza a frissített konfigurációt.
etag Kötelező	str A frissítési művelethez használandó etag (if_match) érték.

Válaszok

Típus	Description
	A frissített konfigurációt tartalmazó konfigurációs objektum.

Kivételek

Típus	Description
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>