Udostępnij za pośrednictwem

IoTHubConfigurationManager Klasa

  • Odwołanie

Klasa zapewniająca wygodne interfejsy API dla operacji Configuration Manager usługi IoTHub na podstawie automatycznie generowanych interfejsów API REST usługi IotHub

Inicjator klienta usługi Configuration Manager.

Po pomyślnym utworzeniu klasa została uwierzytelniona w usłudze IoTHub i jest gotowa do wywołania interfejsów API składowych w celu komunikowania się z usługą IoTHub.

Dziedziczenie
builtins.object
IoTHubConfigurationManager

Konstruktor

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

Parametry

Nazwa Opis
connection_string
str

Parametry połączenia usługi IoTHub używane do uwierzytelniania połączenia z usługą IoTHub, jeśli używamy uwierzytelniania connection_str. Wartość domyślna: Brak

wartość domyślna: None
host
str

Adres URL usługi platformy Azure, jeśli używamy uwierzytelniania poświadczeń tokenu. Wartość domyślna: Brak

wartość domyślna: None
auth
str

Obiekt uwierzytelniania platformy Azure, jeśli używamy uwierzytelniania poświadczeń tokenu. Wartość domyślna: Brak

wartość domyślna: None

Metody

apply_configuration_on_edge_device

Stosuje udostępnioną zawartość konfiguracji do określonego urządzenia brzegowego. Zawartość modułów jest obowiązkowa.
create_configuration

Tworzy konfigurację dla urządzeń lub modułów usługi IoTHub.
delete_configuration

Usuwa konfigurację z usługi IoTHub.
from_connection_string

Inicjator Classmethod dla klienta usługi IoTHubConfigurationManager. Tworzy klasę IoTHubConfigurationManager na podstawie parametrów połączenia.

Po pomyślnym utworzeniu klasa została uwierzytelniona w usłudze IoTHub i jest gotowa do wywołania interfejsów API składowych w celu komunikowania się z usługą IoTHub.
from_token_credential

Inicjator Classmethod dla klienta usługi IoTHubConfigurationManager. Tworzy klasę IoTHubConfigurationManager na podstawie adresu URL nazwy hosta i poświadczeń tokenu platformy Azure.

Po pomyślnym utworzeniu klasa została uwierzytelniona w usłudze IoTHub i jest gotowa do wywołania interfejsów API składowych w celu komunikowania się z usługą IoTHub.
get_configuration

Pobiera konfigurację usługi IoTHub dla określonego urządzenia.
get_configurations

Pobiera wiele konfiguracji dla urządzeń i modułów usługi IoTHub. Zwraca określoną liczbę konfiguracji. Stronicowanie nie jest obsługiwane.
test_configuration_queries

Sprawdza poprawność zapytania warunku docelowego i zapytania dotyczące metryk niestandardowych dla konfiguracji.
update_configuration

Aktualizacje konfiguracji dla urządzeń lub modułów usługi IoTHub. Uwaga: użytkownik nie może zaktualizować identyfikatora konfiguracji i zawartości.

apply_configuration_on_edge_device

Stosuje udostępnioną zawartość konfiguracji do określonego urządzenia brzegowego. Zawartość modułów jest obowiązkowa.

apply_configuration_on_edge_device(device_id, configuration_content)

Parametry

Nazwa Opis
configuration_content
Wymagane
ConfigurationContent

Nazwa (identyfikator) urządzenia brzegowego.
device_id
Wymagane

Zwraca

Typ Opis

Obiekt.

Wyjątki

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

create_configuration

Tworzy konfigurację dla urządzeń lub modułów usługi IoTHub.

create_configuration(configuration)

Parametry

Nazwa Opis
configuration_id
Wymagane
str

Identyfikator konfiguracji.
configuration
Wymagane
Configuration

Konfiguracja do utworzenia.

Zwraca

Typ Opis

Obiekt konfiguracji zawierający utworzoną konfigurację.

Wyjątki

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

delete_configuration

Usuwa konfigurację z usługi IoTHub.

delete_configuration(configuration_id, etag=None)

Parametry

Nazwa Opis
configuration_id
Wymagane
str

Identyfikator konfiguracji.
configuration
Wymagane
Configuration

Konfiguracja do utworzenia.
etag
str

Wartość etag (if_match) do użycia dla operacji usuwania.

wartość domyślna: None

Zwraca

Typ Opis

Obiekt konfiguracji zawierający zaktualizowaną konfigurację.

Wyjątki

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

from_connection_string

Inicjator Classmethod dla klienta usługi IoTHubConfigurationManager. Tworzy klasę IoTHubConfigurationManager na podstawie parametrów połączenia.

Po pomyślnym utworzeniu klasa została uwierzytelniona w usłudze IoTHub i jest gotowa do wywołania interfejsów API składowych w celu komunikowania się z usługą IoTHub.

from_connection_string(connection_string)

Parametry

Nazwa Opis
connection_string
Wymagane
str

Parametry połączenia usługi IoTHub używane do uwierzytelniania połączenia z usługą IoTHub.

Zwraca

Typ Opis
IoTHubConfigurationManager

Wyjątki

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

from_token_credential

Inicjator Classmethod dla klienta usługi IoTHubConfigurationManager. Tworzy klasę IoTHubConfigurationManager na podstawie adresu URL nazwy hosta i poświadczeń tokenu platformy Azure.

Po pomyślnym utworzeniu klasa została uwierzytelniona w usłudze IoTHub i jest gotowa do wywołania interfejsów API składowych w celu komunikowania się z usługą IoTHub.

from_token_credential(url, token_credential)

Parametry

Nazwa Opis
url
Wymagane
str

Adres URL usługi platformy Azure (nazwa hosta).
token_credential
Wymagane
<xref:azure.core.TokenCredential>

Obiekt poświadczeń tokenu platformy Azure

Zwraca

Typ Opis
IoTHubConfigurationManager

Wyjątki

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

get_configuration

Pobiera konfigurację usługi IoTHub dla określonego urządzenia.

get_configuration(configuration_id)

Parametry

Nazwa Opis
configuration_id
Wymagane
str

Identyfikator konfiguracji.

Zwraca

Typ Opis

Obiekt Configuration.

Wyjątki

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

get_configurations

Pobiera wiele konfiguracji dla urządzeń i modułów usługi IoTHub. Zwraca określoną liczbę konfiguracji. Stronicowanie nie jest obsługiwane.

get_configurations(max_count=None)

Parametry

Nazwa Opis
max_count
int

Maksymalna liczba żądanych konfiguracji.

wartość domyślna: None

Zwraca

Typ Opis

Obiekt list[Configuration].

Wyjątki

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

test_configuration_queries

Sprawdza poprawność zapytania warunku docelowego i zapytania dotyczące metryk niestandardowych dla konfiguracji.

test_configuration_queries(configuration_queries_test_input)

Parametry

Nazwa Opis
configuration_queries_test_input
Wymagane
ConfigurationQueriesTestInput

Zapytania testowe danych wejściowych.

Zwraca

Typ Opis

Obiekt ConfigurationQueriesTestResponse.

Wyjątki

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

update_configuration

Aktualizacje konfiguracji dla urządzeń lub modułów usługi IoTHub. Uwaga: użytkownik nie może zaktualizować identyfikatora konfiguracji i zawartości.

update_configuration(configuration, etag)

Parametry

Nazwa Opis
configuration_id
Wymagane
str

Identyfikator konfiguracji.
configuration
Wymagane
Configuration

Konfiguracja zawiera zaktualizowaną konfigurację.
etag
Wymagane
str

Wartość etag (if_match) do użycia dla operacji aktualizacji.

Zwraca

Typ Opis

Obiekt konfiguracji zawierający zaktualizowaną konfigurację.

Wyjątki

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