Sdílet prostřednictvím

IoTHubConfigurationManager Třída

  • Reference

Třída poskytující pohodlná rozhraní API pro Configuration Manager operace IoTHub založené na automaticky generovaných rozhraních IotHub REST API.

Inicializátor klienta služby Configuration Manager Service.

Po úspěšném vytvoření se třída ověří ve službě IoTHub a je připravená volat členské rozhraní API pro komunikaci s IoTHubem.

Dědičnost
builtins.object
IoTHubConfigurationManager

Konstruktor

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

Parametry

Name Description
connection_string
str

Připojovací řetězec IoTHubu, který se používá k ověření připojení k IoTHubu, pokud používáme connection_str ověřování. Výchozí hodnota: Žádná

výchozí hodnota: None
host
str

Adresa URL služby Azure, pokud používáme ověřování přihlašovacích údajů tokenu. Výchozí hodnota: Žádná

výchozí hodnota: None
auth
str

Objekt ověřování Azure, pokud používáme ověřování přihlašovacích údajů tokenu. Výchozí hodnota: Žádná

výchozí hodnota: None

Metody

apply_configuration_on_edge_device

Použije zadaný obsah konfigurace na zadané hraniční zařízení. Obsah modulů je povinný.
create_configuration

Vytvoří konfiguraci pro zařízení nebo moduly IoTHubu.
delete_configuration

Odstraní konfiguraci z IoTHubu.
from_connection_string

Inicializátor metody třídy pro klienta služby IoTHubConfigurationManager. Vytvoří třídu IoTHubConfigurationManager z připojovacího řetězce.

Po úspěšném vytvoření se třída ověří ve službě IoTHub a je připravená volat členské rozhraní API pro komunikaci s IoTHubem.
from_token_credential

Inicializátor metody třídy pro klienta služby IoTHubConfigurationManager. Vytvoří třídu IoTHubConfigurationManager z adresy URL názvu hostitele a přihlašovacích údajů tokenu Azure.

Po úspěšném vytvoření se třída ověří ve službě IoTHub a je připravená volat členské rozhraní API pro komunikaci s IoTHubem.
get_configuration

Načte konfiguraci IoTHubu pro konkrétní zařízení.
get_configurations

Načte několik konfigurací pro zařízení a moduly IoTHubu. Vrátí zadaný počet konfigurací. Stránkování není podporováno.
test_configuration_queries

Ověří konfiguraci dotazu na cílovou podmínku a dotazy na vlastní metriky.
update_configuration

Aktualizace konfiguraci pro zařízení nebo moduly IoTHubu. Poznámka: UŽIVATEL nemůže aktualizovat ID konfigurace a obsah.

apply_configuration_on_edge_device

Použije zadaný obsah konfigurace na zadané hraniční zařízení. Obsah modulů je povinný.

apply_configuration_on_edge_device(device_id, configuration_content)

Parametry

Name Description
configuration_content
Vyžadováno
ConfigurationContent

Název (ID) hraničního zařízení.
device_id
Vyžadováno

Návraty

Typ Description

Objekt.

Výjimky

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

create_configuration

Vytvoří konfiguraci pro zařízení nebo moduly IoTHubu.

create_configuration(configuration)

Parametry

Name Description
configuration_id
Vyžadováno
str

ID konfigurace.
configuration
Vyžadováno
Configuration

Konfigurace, která se má vytvořit.

Návraty

Typ Description

Objekt konfigurace obsahující vytvořenou konfiguraci.

Výjimky

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

delete_configuration

Odstraní konfiguraci z IoTHubu.

delete_configuration(configuration_id, etag=None)

Parametry

Name Description
configuration_id
Vyžadováno
str

ID konfigurace.
configuration
Vyžadováno
Configuration

Konfigurace, která se má vytvořit.
etag
str

Hodnota etag (if_match), která se má použít pro operaci odstranění.

výchozí hodnota: None

Návraty

Typ Description

Objekt konfigurace obsahující aktualizovanou konfiguraci.

Výjimky

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

from_connection_string

Inicializátor metody třídy pro klienta služby IoTHubConfigurationManager. Vytvoří třídu IoTHubConfigurationManager z připojovacího řetězce.

Po úspěšném vytvoření se třída ověří ve službě IoTHub a je připravená volat členské rozhraní API pro komunikaci s IoTHubem.

from_connection_string(connection_string)

Parametry

Name Description
connection_string
Vyžadováno
str

Připojovací řetězec IoTHubu, který se používá k ověření připojení k IoTHubu.

Návraty

Typ Description
IoTHubConfigurationManager

Výjimky

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

from_token_credential

Inicializátor metody třídy pro klienta služby IoTHubConfigurationManager. Vytvoří třídu IoTHubConfigurationManager z adresy URL názvu hostitele a přihlašovacích údajů tokenu Azure.

Po úspěšném vytvoření se třída ověří ve službě IoTHub a je připravená volat členské rozhraní API pro komunikaci s IoTHubem.

from_token_credential(url, token_credential)

Parametry

Name Description
url
Vyžadováno
str

Adresa URL služby Azure (název hostitele).
token_credential
Vyžadováno
<xref:azure.core.TokenCredential>

Objekt přihlašovacích údajů tokenu Azure

Návraty

Typ Description
IoTHubConfigurationManager

Výjimky

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

get_configuration

Načte konfiguraci IoTHubu pro konkrétní zařízení.

get_configuration(configuration_id)

Parametry

Name Description
configuration_id
Vyžadováno
str

ID konfigurace.

Návraty

Typ Description

Objekt Konfigurace.

Výjimky

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

get_configurations

Načte několik konfigurací pro zařízení a moduly IoTHubu. Vrátí zadaný počet konfigurací. Stránkování není podporováno.

get_configurations(max_count=None)

Parametry

Name Description
max_count
int

Maximální počet požadovaných konfigurací

výchozí hodnota: None

Návraty

Typ Description

Objekt list[Configuration]

Výjimky

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

test_configuration_queries

Ověří konfiguraci dotazu na cílovou podmínku a dotazy na vlastní metriky.

test_configuration_queries(configuration_queries_test_input)

Parametry

Name Description
configuration_queries_test_input
Vyžadováno
ConfigurationQueriesTestInput

Testovací vstup dotazů.

Návraty

Typ Description

Objekt ConfigurationQueriesTestResponse.

Výjimky

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

update_configuration

Aktualizace konfiguraci pro zařízení nebo moduly IoTHubu. Poznámka: UŽIVATEL nemůže aktualizovat ID konfigurace a obsah.

update_configuration(configuration, etag)

Parametry

Name Description
configuration_id
Vyžadováno
str

ID konfigurace.
configuration
Vyžadováno
Configuration

Konfigurace obsahuje aktualizovanou konfiguraci.
etag
Vyžadováno
str

Hodnota etag (if_match), která se má použít pro operaci aktualizace.

Návraty

Typ Description

Objekt konfigurace obsahující aktualizovanou konfiguraci.

Výjimky

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