Udostępnij za pośrednictwem

IoTHubRegistryManager Klasa

  • Odwołanie

Klasa zapewniająca wygodne interfejsy API dla operacji menedżera rejestru usługi IoTHub na podstawie automatycznie generowanych interfejsów API REST usługi IotHub

Inicjator klienta usługi Menedżera rejestru.

Użytkownicy nie powinni wywoływać tego bezpośrednio. Zamiast tego powinny mieć metody fabryki from_connection_string() lub from_token_credential().

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
IoTHubRegistryManager

Konstruktor

IoTHubRegistryManager(connection_string=None, host=None, token_credential=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
Wymagane
str

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

Metody

bulk_create_or_update_devices

Tworzenie, aktualizowanie lub usuwanie tożsamości wielu urządzeń z rejestru tożsamości usługi IoTHub.

Tworzenie, aktualizowanie lub usuwanie tożsamości wielu urządzeń z rejestru tożsamości usługi IoTHub. Tożsamość urządzenia można określić tylko raz na liście. Różne operacje (tworzenie, aktualizowanie, usuwanie) na różnych urządzeniach są dozwolone. Maksymalnie 100 urządzeń można określić na wywołanie. W przypadku operacji na dużą skalę rozważ użycie funkcji importowania przy użyciu usługi Blob Storage(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities).
create_device_with_certificate_authority

Tworzy tożsamość urządzenia w usłudze IoTHub przy użyciu urzędu certyfikacji.
create_device_with_sas

Tworzy tożsamość urządzenia w usłudze IoTHub przy użyciu uwierzytelniania SAS.
create_device_with_x509

Tworzy tożsamość urządzenia w usłudze IoTHub przy użyciu uwierzytelniania X509.
create_module_with_certificate_authority

Tworzy tożsamość modułu dla urządzenia w usłudze IoTHub przy użyciu urzędu certyfikacji.
create_module_with_sas

Tworzy tożsamość modułu dla urządzenia w usłudze IoTHub przy użyciu uwierzytelniania SAS.
create_module_with_x509

Tworzy tożsamość modułu dla urządzenia w usłudze IoTHub przy użyciu uwierzytelniania X509.
delete_device

Usuwa tożsamość urządzenia z usługi IoTHub.
delete_module

Usuwa tożsamość modułu dla urządzenia z usługi IoTHub.
from_connection_string

Inicjator klasymethod dla klienta usługi Menedżera rejestru. Tworzy klasę Menedżera rejestru na podstawie parametrów połączenia.

Po pomyślnym utworzeniu klasy 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 klasymethod dla klienta usługi Menedżera rejestru. Tworzy klasę Menedżera rejestru na podstawie adresu URL nazwy hosta i poświadczeń tokenu platformy Azure.

Po pomyślnym utworzeniu klasy 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_device

Pobiera tożsamość urządzenia z usługi IoTHub.
get_device_registry_statistics

Pobiera statystyki rejestru urządzeń usługi IoTHub.
get_devices

Pobierz tożsamości wielu urządzeń z rejestru tożsamości usługi IoTHub. Niezalecane. Użyj języka zapytań usługi IoTHub, aby pobrać informacje o bliźniaczej reprezentacji urządzenia i tożsamości urządzenia. Zobacz https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub i https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language , aby uzyskać więcej informacji.
get_module

Pobiera tożsamość modułu dla urządzenia z usługi IoTHub.
get_module_twin

Pobiera bliźniaczą reprezentację modułu.
get_modules

Pobiera wszystkie tożsamości modułów na urządzeniu.
get_service_statistics

Pobiera statystyki usługi IoTHub.
get_twin

Pobiera bliźniacze reprezentacje urządzenia.
invoke_device_method

Wywołaj metodę bezpośrednią na urządzeniu.
invoke_device_module_method

Wywołaj metodę bezpośrednią na urządzeniu.
query_iot_hub

Wykonaj zapytanie względem usługi IoTHub, aby pobrać informacje dotyczące bliźniaczych reprezentacji urządzeń przy użyciu języka przypominającego język SQL. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Stronicowanie wyników jest obsługiwane. Zwraca to tylko informacje o bliźniaczych reprezentacjach urządzeń.
replace_module_twin

Zastępuje tagi i żądane właściwości bliźniaczej reprezentacji modułu.
replace_twin

Zastępuje tagi i żądane właściwości bliźniaczej reprezentacji urządzenia.
send_c2d_message

Wyślij komunikat C2D do urządzenia usługi IoTHub.
update_device_with_certificate_authority

Aktualizacje tożsamości urządzenia w usłudze IoTHub przy użyciu urzędu certyfikacji.
update_device_with_sas

Aktualizacje tożsamość urządzenia w usłudze IoTHub przy użyciu uwierzytelniania SAS.
update_device_with_x509

Aktualizacje tożsamość urządzenia w usłudze IoTHub przy użyciu uwierzytelniania X509.
update_module_twin

Aktualizacje tagów i żądanych właściwości bliźniaczej reprezentacji modułu.
update_module_with_certificate_authority

Aktualizacje tożsamość modułu dla urządzenia w usłudze IoTHub przy użyciu urzędu certyfikacji.
update_module_with_sas

Aktualizacje tożsamość modułu dla urządzenia w usłudze IoTHub przy użyciu uwierzytelniania SAS.
update_module_with_x509

Aktualizacje tożsamość modułu dla urządzenia w usłudze IoTHub przy użyciu uwierzytelniania X509.
update_twin

Aktualizacje tagów i żądanych właściwości bliźniaczej reprezentacji urządzenia.

bulk_create_or_update_devices

Tworzenie, aktualizowanie lub usuwanie tożsamości wielu urządzeń z rejestru tożsamości usługi IoTHub.

Tworzenie, aktualizowanie lub usuwanie tożsamości wielu urządzeń z rejestru tożsamości usługi IoTHub. Tożsamość urządzenia można określić tylko raz na liście. Różne operacje (tworzenie, aktualizowanie, usuwanie) na różnych urządzeniach są dozwolone. Maksymalnie 100 urządzeń można określić na wywołanie. W przypadku operacji na dużą skalę rozważ użycie funkcji importowania przy użyciu usługi Blob Storage(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities).

bulk_create_or_update_devices(devices)

Parametry

Nazwa Opis
devices
Wymagane
list[ExportImportDevice]

Lista obiektów urządzeń do działania.

Zwraca

Typ Opis

Obiekt BulkRegistryOperationResult.

Wyjątki

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

create_device_with_certificate_authority

Tworzy tożsamość urządzenia w usłudze IoTHub przy użyciu urzędu certyfikacji.

create_device_with_certificate_authority(device_id, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

Parametry

Nazwa Opis
device_id
Wymagane
str

Nazwa (identyfikator) urządzenia.
status
Wymagane
str

Początkowy stan utworzonego urządzenia. (Możliwe wartości: "włączone" lub "wyłączone").
iot_edge
bool

Określa, czy utworzone urządzenie jest urządzeniem IoT Edge. Wartość domyślna: Fałsz

wartość domyślna: False
status_reason
str

Przyczyna stanu tożsamości urządzenia. Wartość domyślna: Brak

wartość domyślna: None
device_scope
str

Zakres urządzenia. Wartość domyślna: Brak generowane automatycznie i niezmienne dla urządzeń brzegowych i modyfikowalne na urządzeniach liści w celu utworzenia relacji podrzędnej/nadrzędnej. W przypadku urządzeń liścia wartość ustawiania nadrzędnego urządzenia brzegowego można pobrać z właściwości device_scope urządzenia nadrzędnego brzegowego.

wartość domyślna: None
parent_scopes
Union[list[str], str]

Zakresy urządzeń brzegowych wyższego poziomu, jeśli ma to zastosowanie. Wartość domyślna: Brak w przypadku urządzeń brzegowych wartość ustawiania nadrzędnego urządzenia brzegowego można pobrać z właściwości device_scope urządzenia nadrzędnego brzegowego. W przypadku urządzeń liścia można ustawić tę samą wartość co device_scope lub pozostawić usługę do skopiowania.

wartość domyślna: None

Zwraca

Typ Opis

Obiekt urządzenia zawierający utworzone urządzenie.

Wyjątki

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

create_device_with_sas

Tworzy tożsamość urządzenia w usłudze IoTHub przy użyciu uwierzytelniania SAS.

create_device_with_sas(device_id, primary_key, secondary_key, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

Parametry

Nazwa Opis
device_id
Wymagane
str

Nazwa (identyfikator) urządzenia.
primary_key
Wymagane
str

Podstawowy klucz uwierzytelniania.
secondary_key
Wymagane
str

Pomocniczy klucz uwierzytelniania.
status
Wymagane
str

Początkowy stan utworzonego urządzenia. (Możliwe wartości: "włączone" lub "wyłączone")
iot_edge
bool

Określa, czy utworzone urządzenie jest urządzeniem IoT Edge. Wartość domyślna: Fałsz

wartość domyślna: False
status_reason
str

Przyczyna stanu tożsamości urządzenia. Wartość domyślna: Brak

wartość domyślna: None
device_scope
str

Zakres urządzenia. Wartość domyślna: Brak generowane automatycznie i niezmienne dla urządzeń brzegowych i modyfikowalne na urządzeniach liści w celu utworzenia relacji podrzędnej/nadrzędnej. W przypadku urządzeń liścia wartość ustawiania nadrzędnego urządzenia brzegowego można pobrać z właściwości device_scope urządzenia nadrzędnego brzegowego.

wartość domyślna: None
parent_scopes
Union[list[str], str]

Zakresy urządzeń brzegowych wyższego poziomu, jeśli ma to zastosowanie. Wartość domyślna: Brak w przypadku urządzeń brzegowych wartość ustawiania nadrzędnego urządzenia brzegowego można pobrać z właściwości device_scope urządzenia nadrzędnego brzegowego. W przypadku urządzeń liścia można ustawić tę samą wartość co device_scope lub pozostawić usługę do skopiowania.

wartość domyślna: None

Zwraca

Typ Opis

Obiekt urządzenia zawierający utworzone urządzenie.

Wyjątki

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

create_device_with_x509

Tworzy tożsamość urządzenia w usłudze IoTHub przy użyciu uwierzytelniania X509.

create_device_with_x509(device_id, primary_thumbprint, secondary_thumbprint, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

Parametry

Nazwa Opis
device_id
Wymagane
str

Nazwa (identyfikator) urządzenia.
primary_thumbprint
Wymagane
str

Podstawowy odcisk palca X509.
secondary_thumbprint
Wymagane
str

Pomocniczy odcisk palca X509.
status
Wymagane
str

Początkowy stan utworzonego urządzenia. (Możliwe wartości: "włączone" lub "wyłączone")
iot_edge
bool

Określa, czy utworzone urządzenie jest urządzeniem IoT Edge. Wartość domyślna: Fałsz

wartość domyślna: False
status_reason
str

Przyczyna stanu tożsamości urządzenia. Wartość domyślna: Brak

wartość domyślna: None
device_scope
str

Zakres urządzenia. Wartość domyślna: Brak generowane automatycznie i niezmienne dla urządzeń brzegowych i modyfikowalne na urządzeniach liści w celu utworzenia relacji podrzędnej/nadrzędnej. W przypadku urządzeń liścia wartość ustawiania nadrzędnego urządzenia brzegowego można pobrać z właściwości device_scope urządzenia nadrzędnego brzegowego.

wartość domyślna: None
parent_scopes
Union[list[str], str]

Zakresy urządzeń brzegowych wyższego poziomu, jeśli ma to zastosowanie. Wartość domyślna: Brak w przypadku urządzeń brzegowych wartość ustawiania nadrzędnego urządzenia brzegowego można pobrać z właściwości device_scope urządzenia nadrzędnego brzegowego. W przypadku urządzeń liścia można ustawić tę samą wartość co device_scope lub pozostawić usługę do skopiowania.

wartość domyślna: None

Zwraca

Typ Opis

Obiekt urządzenia zawierający utworzone urządzenie.

Wyjątki

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

create_module_with_certificate_authority

Tworzy tożsamość modułu dla urządzenia w usłudze IoTHub przy użyciu urzędu certyfikacji.

create_module_with_certificate_authority(device_id, module_id, managed_by)

Parametry

Nazwa Opis
device_id
Wymagane
str

Nazwa (identyfikator) urządzenia.
module_id
Wymagane
str

Nazwa (identyfikator) modułu.
managed_by
Wymagane
str

Nazwa urządzenia menedżera (krawędź).

Zwraca

Typ Opis

Obiekt modułu zawierający utworzony moduł.

Wyjątki

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

create_module_with_sas

Tworzy tożsamość modułu dla urządzenia w usłudze IoTHub przy użyciu uwierzytelniania SAS.

create_module_with_sas(device_id, module_id, managed_by, primary_key, secondary_key)

Parametry

Nazwa Opis
device_id
Wymagane
str

Nazwa (identyfikator) urządzenia.
module_id
Wymagane
str

Nazwa (identyfikator) modułu.
managed_by
Wymagane
str

Nazwa urządzenia menedżera (krawędź).
primary_key
Wymagane
str

Podstawowy klucz uwierzytelniania.
secondary_key
Wymagane
str

Pomocniczy klucz uwierzytelniania.

Zwraca

Typ Opis

Obiekt modułu zawierający utworzony moduł.

Wyjątki

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

create_module_with_x509

Tworzy tożsamość modułu dla urządzenia w usłudze IoTHub przy użyciu uwierzytelniania X509.

create_module_with_x509(device_id, module_id, managed_by, primary_thumbprint, secondary_thumbprint)

Parametry

Nazwa Opis
device_id
Wymagane
str

Nazwa (identyfikator) urządzenia.
module_id
Wymagane
str

Nazwa (identyfikator) modułu.
managed_by
Wymagane
str

Nazwa urządzenia menedżera (krawędź).
primary_thumbprint
Wymagane
str

Podstawowy odcisk palca X509.
secondary_thumbprint
Wymagane
str

Pomocniczy odcisk palca X509.

Zwraca

Typ Opis

Obiekt modułu zawierający utworzony moduł.

Wyjątki

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

delete_device

Usuwa tożsamość urządzenia z usługi IoTHub.

delete_device(device_id, etag=None)

Parametry

Nazwa Opis
device_id
Wymagane
str

Nazwa (identyfikator) urządzenia.
etag
str

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

wartość domyślna: None

Zwraca

Typ Opis

Brak.

Wyjątki

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

delete_module

Usuwa tożsamość modułu dla urządzenia z usługi IoTHub.

delete_module(device_id, module_id, etag=None)

Parametry

Nazwa Opis
device_id
Wymagane
str

Nazwa (identyfikator) urządzenia.
module_id
Wymagane
str

Nazwa (identyfikator) modułu.
etag
str

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

wartość domyślna: None

Zwraca

Typ Opis

Brak.

Wyjątki

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

from_connection_string

Inicjator klasymethod dla klienta usługi Menedżera rejestru. Tworzy klasę Menedżera rejestru na podstawie parametrów połączenia.

Po pomyślnym utworzeniu klasy 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
IoTHubRegistryManager

Wyjątki

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

from_token_credential

Inicjator klasymethod dla klienta usługi Menedżera rejestru. Tworzy klasę Menedżera rejestru na podstawie adresu URL nazwy hosta i poświadczeń tokenu platformy Azure.

Po pomyślnym utworzeniu klasy 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
IoTHubRegistryManager

Wyjątki

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

get_device

Pobiera tożsamość urządzenia z usługi IoTHub.

get_device(device_id)

Parametry

Nazwa Opis
device_id
Wymagane
str

Nazwa (identyfikator) urządzenia.

Zwraca

Typ Opis

Obiekt Urządzenie zawierający żądane urządzenie.

Wyjątki

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

get_device_registry_statistics

Pobiera statystyki rejestru urządzeń usługi IoTHub.

get_device_registry_statistics()

Zwraca

Typ Opis

Obiekt RegistryStatistics.

Wyjątki

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

get_devices

Pobierz tożsamości wielu urządzeń z rejestru tożsamości usługi IoTHub. Niezalecane. Użyj języka zapytań usługi IoTHub, aby pobrać informacje o bliźniaczej reprezentacji urządzenia i tożsamości urządzenia. Zobacz https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub i https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language , aby uzyskać więcej informacji.

get_devices(max_number_of_devices=None)

Parametry

Nazwa Opis
max_number_of_devices
int

Ten parametr po określeniu definiuje maksymalną liczbę zwracanych tożsamości urządzeń. Każda wartość spoza zakresu od 1 do 1000 jest uważana za 1000

wartość domyślna: None

Zwraca

Typ Opis

Lista informacji o urządzeniu.

Wyjątki

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

get_module

Pobiera tożsamość modułu dla urządzenia z usługi IoTHub.

get_module(device_id, module_id)

Parametry

Nazwa Opis
device_id
Wymagane
str

Nazwa (identyfikator) urządzenia.
module_id
Wymagane
str

Nazwa (identyfikator) modułu.

Zwraca

Typ Opis

Obiekt Module zawierający żądany moduł.

Wyjątki

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

get_module_twin

Pobiera bliźniaczą reprezentację modułu.

get_module_twin(device_id, module_id)

Parametry

Nazwa Opis
device_id
Wymagane
str

Nazwa (identyfikator) urządzenia.
module_id
Wymagane
str

Nazwa (identyfikator) modułu.

Zwraca

Typ Opis

Obiekt Bliźniacza reprezentacja.

Wyjątki

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

get_modules

Pobiera wszystkie tożsamości modułów na urządzeniu.

get_modules(device_id)

Parametry

Nazwa Opis
device_id
Wymagane
str

Nazwa (identyfikator) urządzenia.

Zwraca

Typ Opis

Lista[Module] zawierająca wszystkie moduły na urządzeniu.

Wyjątki

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

get_service_statistics

Pobiera statystyki usługi IoTHub.

get_service_statistics()

Zwraca

Typ Opis

Obiekt ServiceStatistics.

Wyjątki

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

get_twin

Pobiera bliźniacze reprezentacje urządzenia.

get_twin(device_id)

Parametry

Nazwa Opis
device_id
Wymagane
str

Nazwa (identyfikator) urządzenia.

Zwraca

Typ Opis

Obiekt Bliźniacza reprezentacja.

Wyjątki

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

invoke_device_method

Wywołaj metodę bezpośrednią na urządzeniu.

invoke_device_method(device_id, direct_method_request)

Parametry

Nazwa Opis
device_id
Wymagane
str

Nazwa (identyfikator) urządzenia.
direct_method_request
Wymagane
CloudToDeviceMethod

Żądanie metody.

Zwraca

Typ Opis

Obiekt CloudToDeviceMethodResult.

Wyjątki

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

invoke_device_module_method

Wywołaj metodę bezpośrednią na urządzeniu.

invoke_device_module_method(device_id, module_id, direct_method_request)

Parametry

Nazwa Opis
device_id
Wymagane
str

Nazwa (identyfikator) urządzenia.
module_id
Wymagane
str

Nazwa (identyfikator) modułu.
direct_method_request
Wymagane
CloudToDeviceMethod

Żądanie metody.

Zwraca

Typ Opis

Obiekt CloudToDeviceMethodResult.

Wyjątki

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

query_iot_hub

Wykonaj zapytanie względem usługi IoTHub, aby pobrać informacje dotyczące bliźniaczych reprezentacji urządzeń przy użyciu języka przypominającego język SQL. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Stronicowanie wyników jest obsługiwane. Zwraca to tylko informacje o bliźniaczych reprezentacjach urządzeń.

query_iot_hub(query_specification, continuation_token=None, max_item_count=None)

Parametry

Nazwa Opis
query
Wymagane
QuerySpecification

Specyfikacja zapytania.
continuation_token
str

Token kontynuacji stronicowania

wartość domyślna: None
max_item_count
str

Maksymalna liczba żądanych bliźniaczych reprezentacji urządzeń

wartość domyślna: None
query_specification
Wymagane

Zwraca

Typ Opis

Obiekt QueryResult.

Wyjątki

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

replace_module_twin

Zastępuje tagi i żądane właściwości bliźniaczej reprezentacji modułu.

replace_module_twin(device_id, module_id, module_twin, etag=None)

Parametry

Nazwa Opis
device_id
Wymagane
str

Nazwa (identyfikator) urządzenia.
module_id
Wymagane
str

Nazwa (identyfikator) modułu.
module_twin
Wymagane
Twin

Informacje o bliźniaczej reprezentacji modułu.
etag
str

Wartość etag (if_match), która ma być używana dla operacji zastępowania.

wartość domyślna: None

Zwraca

Typ Opis

Obiekt Bliźniacza reprezentacja.

Wyjątki

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

replace_twin

Zastępuje tagi i żądane właściwości bliźniaczej reprezentacji urządzenia.

replace_twin(device_id, device_twin, etag=None)

Parametry

Nazwa Opis
device_id
Wymagane
str

Nazwa (identyfikator) urządzenia.
device_twin
Wymagane
Twin

Informacje o bliźniaczej reprezentacji urządzenia.
etag
str

Wartość etag (if_match), która ma być używana dla operacji zastępowania.

wartość domyślna: None

Zwraca

Typ Opis

Obiekt Bliźniacza reprezentacja.

Wyjątki

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

send_c2d_message

Wyślij komunikat C2D do urządzenia usługi IoTHub.

send_c2d_message(device_id, message, properties={})

Parametry

Nazwa Opis
device_id
Wymagane
str

Nazwa (identyfikator) urządzenia.
message
Wymagane
str

Komunikat, który ma zostać dostarczony do urządzenia.
properties
dict

Właściwości, które mają być wysyłane za pomocą komunikatu. Może zawierać właściwości aplikacji i właściwości systemu

wartość domyślna: {}

Wyjątki

Typ Opis
Exception if the Send command is not able to send the message

update_device_with_certificate_authority

Aktualizacje tożsamości urządzenia w usłudze IoTHub przy użyciu urzędu certyfikacji.

update_device_with_certificate_authority(device_id, etag, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

Parametry

Nazwa Opis
device_id
Wymagane
str

Nazwa (identyfikator) urządzenia.
etag
Wymagane
str

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

Początkowy stan utworzonego urządzenia. (Możliwe wartości: "włączone" lub "wyłączone").
iot_edge
bool

Niezależnie od tego, czy utworzone urządzenie jest urządzeniem IoT Edge. Wartość domyślna: Fałsz

wartość domyślna: False
status_reason
str

Przyczyna stanu tożsamości urządzenia. Wartość domyślna: Brak

wartość domyślna: None
device_scope
str

Zakres urządzenia. Wartość domyślna: Brak automatycznie generowanych i niezmiennych dla urządzeń brzegowych i modyfikowalnych na urządzeniach liścia w celu utworzenia relacji podrzędnej/nadrzędnej. W przypadku urządzeń liścia wartość ustawiania nadrzędnego urządzenia brzegowego można pobrać z właściwości device_scope urządzenia nadrzędnego brzegowego.

wartość domyślna: None
parent_scopes
Union[list[str], str]

Zakresy urządzeń brzegowych najwyższego poziomu, jeśli ma to zastosowanie. Wartość domyślna: Brak dla urządzeń brzegowych, wartość ustawiania nadrzędnego urządzenia brzegowego można pobrać z właściwości device_scope urządzenia nadrzędnego brzegowego. W przypadku urządzeń liścia można ustawić tę samą wartość co device_scope lub pozostawić usługę do skopiowania.

wartość domyślna: None

Zwraca

Typ Opis

Zaktualizowany obiekt Urządzenie zawierający utworzone urządzenie.

Wyjątki

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

update_device_with_sas

Aktualizacje tożsamość urządzenia w usłudze IoTHub przy użyciu uwierzytelniania SAS.

update_device_with_sas(device_id, etag, primary_key, secondary_key, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

Parametry

Nazwa Opis
device_id
Wymagane
str

Nazwa (identyfikator) urządzenia.
etag
Wymagane
str

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

Podstawowy klucz uwierzytelniania.
secondary_key
Wymagane
str

Pomocniczy klucz uwierzytelniania.
status
Wymagane
str

Początkowy stan utworzonego urządzenia. (Możliwe wartości: "włączone" lub "wyłączone").
iot_edge
bool

Niezależnie od tego, czy utworzone urządzenie jest urządzeniem IoT Edge. Wartość domyślna: Fałsz

wartość domyślna: False
status_reason
str

Przyczyna stanu tożsamości urządzenia. Wartość domyślna: Brak

wartość domyślna: None
device_scope
str

Zakres urządzenia. Wartość domyślna: Brak generowane automatycznie i niezmienne dla urządzeń brzegowych i modyfikowalne na urządzeniach liści w celu utworzenia relacji podrzędnej/nadrzędnej. W przypadku urządzeń liścia wartość ustawiania nadrzędnego urządzenia brzegowego można pobrać z właściwości device_scope urządzenia nadrzędnego brzegowego.

wartość domyślna: None
parent_scopes
Union[list[str], str]

Zakresy urządzeń brzegowych wyższego poziomu, jeśli ma to zastosowanie. Wartość domyślna: Brak w przypadku urządzeń brzegowych wartość ustawiania nadrzędnego urządzenia brzegowego można pobrać z właściwości device_scope urządzenia nadrzędnego brzegowego. W przypadku urządzeń liścia można ustawić tę samą wartość co device_scope lub pozostawić usługę do skopiowania.

wartość domyślna: None

Zwraca

Typ Opis

Zaktualizowany obiekt Device zawierający utworzone urządzenie.

Wyjątki

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

update_device_with_x509

Aktualizacje tożsamość urządzenia w usłudze IoTHub przy użyciu uwierzytelniania X509.

update_device_with_x509(device_id, etag, primary_thumbprint, secondary_thumbprint, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

Parametry

Nazwa Opis
device_id
Wymagane
str

Nazwa (identyfikator) urządzenia.
etag
Wymagane
str

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

Podstawowy odcisk palca X509.
secondary_thumbprint
Wymagane
str

Pomocniczy odcisk palca X509.
status
Wymagane
str

Początkowy stan utworzonego urządzenia. (Możliwe wartości: "włączone" lub "wyłączone").
iot_edge
bool

Określa, czy utworzone urządzenie jest urządzeniem IoT Edge. Wartość domyślna: Fałsz

wartość domyślna: False
status_reason
str

Przyczyna stanu tożsamości urządzenia. Wartość domyślna: Brak

wartość domyślna: None
device_scope
str

Zakres urządzenia. Wartość domyślna: Brak generowane automatycznie i niezmienne dla urządzeń brzegowych i modyfikowalne na urządzeniach liści w celu utworzenia relacji podrzędnej/nadrzędnej. W przypadku urządzeń liścia wartość ustawiania nadrzędnego urządzenia brzegowego można pobrać z właściwości device_scope urządzenia nadrzędnego brzegowego.

wartość domyślna: None
parent_scopes
Union[list[str], str]

Zakresy urządzeń brzegowych wyższego poziomu, jeśli ma to zastosowanie. Wartość domyślna: Brak w przypadku urządzeń brzegowych wartość ustawiania nadrzędnego urządzenia brzegowego można pobrać z właściwości device_scope urządzenia nadrzędnego brzegowego. W przypadku urządzeń liścia można ustawić tę samą wartość co device_scope lub pozostawić usługę do skopiowania.

wartość domyślna: None

Zwraca

Typ Opis

Zaktualizowany obiekt Device zawierający utworzone urządzenie.

Wyjątki

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

update_module_twin

Aktualizacje tagów i żądanych właściwości bliźniaczej reprezentacji modułu.

update_module_twin(device_id, module_id, module_twin, etag=None)

Parametry

Nazwa Opis
device_id
Wymagane
str

Nazwa (identyfikator) urządzenia.
module_id
Wymagane
str

Nazwa (identyfikator) modułu.
module_twin
Wymagane
Twin

Informacje o bliźniaczej reprezentacji modułu.
etag
str

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

wartość domyślna: None

Zwraca

Typ Opis

Obiekt bliźniaczej reprezentacji.

Wyjątki

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

update_module_with_certificate_authority

Aktualizacje tożsamość modułu dla urządzenia w usłudze IoTHub przy użyciu urzędu certyfikacji.

update_module_with_certificate_authority(device_id, module_id, managed_by, etag)

Parametry

Nazwa Opis
device_id
Wymagane
str

Nazwa (identyfikator) urządzenia.
module_id
Wymagane
str

Nazwa (identyfikator) modułu.
managed_by
Wymagane
str

Nazwa urządzenia menedżera (krawędź).
etag
Wymagane
str

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

Zwraca

Typ Opis

Zaktualizowany obiekt Moduł zawierający utworzony moduł.

Wyjątki

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

update_module_with_sas

Aktualizacje tożsamość modułu dla urządzenia w usłudze IoTHub przy użyciu uwierzytelniania SAS.

update_module_with_sas(device_id, module_id, managed_by, etag, primary_key, secondary_key)

Parametry

Nazwa Opis
device_id
Wymagane
str

Nazwa (identyfikator) urządzenia.
module_id
Wymagane
str

Nazwa (identyfikator) modułu.
managed_by
Wymagane
str

Nazwa urządzenia menedżera (krawędź).
etag
Wymagane
str

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

Podstawowy klucz uwierzytelniania.
secondary_key
Wymagane
str

Pomocniczy klucz uwierzytelniania.

Zwraca

Typ Opis

Zaktualizowany obiekt Moduł zawierający utworzony moduł.

Wyjątki

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

update_module_with_x509

Aktualizacje tożsamość modułu dla urządzenia w usłudze IoTHub przy użyciu uwierzytelniania X509.

update_module_with_x509(device_id, module_id, managed_by, etag, primary_thumbprint, secondary_thumbprint)

Parametry

Nazwa Opis
device_id
Wymagane
str

Nazwa (identyfikator) urządzenia.
module_id
Wymagane
str

Nazwa (identyfikator) modułu.
managed_by
Wymagane
str

Nazwa urządzenia menedżera (krawędź).
etag
Wymagane
str

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

Podstawowy odcisk palca X509.
secondary_thumbprint
Wymagane
str

Pomocniczy odcisk palca X509.

Zwraca

Typ Opis

Zaktualizowany obiekt Moduł zawierający utworzony moduł.

Wyjątki

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

update_twin

Aktualizacje tagów i żądanych właściwości bliźniaczej reprezentacji urządzenia.

update_twin(device_id, device_twin, etag=None)

Parametry

Nazwa Opis
device_id
Wymagane
str

Nazwa (identyfikator) urządzenia.
device_twin
Wymagane
Twin

Informacje o bliźniaczej reprezentacji urządzenia.
etag
str

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

wartość domyślna: None

Zwraca

Typ Opis

Obiekt bliźniaczej reprezentacji.

Wyjątki

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