ModulesOperations Klasa
ModulesOperations operacje.
- Dziedziczenie
-
builtins.objectModulesOperations
Konstruktor
ModulesOperations(client, config, serializer, deserializer)Parametry
- client
Klient żądań obsługi.
- config
Konfiguracja klienta usługi.
- serializer
Serializator modelu obiektów.
- deserializer
Deserializator modelu obiektów.
Zmienne
- api_version
Wersja interfejsu API. Stała wartość: "2021-04-12".
Metody
| create_or_update_identity |
Tworzy lub aktualizuje tożsamość modułu dla urządzenia w IoT Hub. Użytkownik nie może zaktualizować identyfikatora moduleId i identyfikatora generacji. |
| delete_identity |
Usuwa tożsamość modułu dla urządzenia w IoT Hub. |
| get_identity |
Pobiera tożsamość modułu na urządzeniu. |
| get_modules_on_device |
Pobiera wszystkie tożsamości modułów na urządzeniu. |
| get_twin |
Pobiera bliźniaczą reprezentację modułu. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins. |
| invoke_method |
Wywołuje metodę bezpośrednią w module urządzenia. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods. |
| replace_twin |
Zastępuje tagi i żądane właściwości bliźniaczej reprezentacji modułu. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins. |
| update_twin |
Aktualizacje tagów i żądanych właściwości bliźniaczej reprezentacji modułu. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins. |
create_or_update_identity
Tworzy lub aktualizuje tożsamość modułu dla urządzenia w IoT Hub. Użytkownik nie może zaktualizować identyfikatora moduleId i identyfikatora generacji.
create_or_update_identity(id, mid, module, if_match=None, custom_headers=None, raw=False, **operation_config)Parametry
- if_match
- str
Ciąg reprezentujący słaby element ETag dla modułu zgodnie z RFC7232. Nie należy go ustawiać podczas tworzenia modułu, ale można go ustawić podczas aktualizowania modułu.
- raw
- bool
Metoda zwraca bezpośrednią odpowiedź obok zdeserializowanej odpowiedzi
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
Moduł lub ClientRawResponse, jeśli raw=true
Typ zwracany
Wyjątki
delete_identity
Usuwa tożsamość modułu dla urządzenia w IoT Hub.
delete_identity(id, mid, if_match=None, custom_headers=None, raw=False, **operation_config)Parametry
- if_match
- str
Ciąg reprezentujący słaby element ETag dla modułu zgodnie z RFC7232. Operacja usuwania jest wykonywana tylko wtedy, gdy ten element ETag jest zgodny z wartością obsługiwaną przez serwer, co oznacza, że moduł nie został zmodyfikowany od czasu ostatniego pobrania. Aby wymusić bezwarunkowe usunięcie, ustaw If-Match na symbol wieloznaczny (*).
- raw
- bool
Metoda zwraca bezpośrednią odpowiedź obok zdeserializowanej odpowiedzi
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
Brak lub Wartość ClientRawResponse, jeśli parametr raw=true
Typ zwracany
Wyjątki
get_identity
Pobiera tożsamość modułu na urządzeniu.
get_identity(id, mid, custom_headers=None, raw=False, **operation_config)Parametry
- raw
- bool
Metoda zwraca bezpośrednią odpowiedź obok zdeserializowanej odpowiedzi
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
Moduł lub ClientRawResponse, jeśli raw=true
Typ zwracany
Wyjątki
get_modules_on_device
Pobiera wszystkie tożsamości modułów na urządzeniu.
get_modules_on_device(id, custom_headers=None, raw=False, **operation_config)Parametry
- raw
- bool
Metoda zwraca bezpośrednią odpowiedź obok zdeserializowanej odpowiedzi
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
list lub ClientRawResponse, jeśli raw=true
Typ zwracany
Wyjątki
get_twin
Pobiera bliźniaczą reprezentację modułu. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.
get_twin(id, mid, custom_headers=None, raw=False, **operation_config)Parametry
- raw
- bool
Metoda zwraca bezpośrednią odpowiedź obok zdeserializowanej odpowiedzi
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
Bliźniacza reprezentacja lub elementy ClientRawResponse, jeśli raw=true
Typ zwracany
Wyjątki
invoke_method
Wywołuje metodę bezpośrednią w module urządzenia. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods.
invoke_method(device_id, module_id, direct_method_request, custom_headers=None, raw=False, **operation_config)Parametry
- direct_method_request
- CloudToDeviceMethod
Parametry do wykonania metody bezpośredniej w module.
- raw
- bool
Metoda zwraca bezpośrednią odpowiedź obok zdeserializowanej odpowiedzi
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
CloudToDeviceMethodResult lub ClientRawResponse, jeśli raw=true
Typ zwracany
Wyjątki
replace_twin
Zastępuje tagi i żądane właściwości bliźniaczej reprezentacji modułu. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.
replace_twin(id, mid, device_twin_info, if_match=None, custom_headers=None, raw=False, **operation_config)Parametry
- device_twin_info
- Twin
Informacje o bliźniaczej reprezentacji modułu, które zastąpią istniejące informacje.
- if_match
- str
Ciąg reprezentujący słaby element ETag dla bliźniaczej reprezentacji urządzenia zgodnie z RFC7232. Określa, czy należy wykonać operację zamiany.
- raw
- bool
Metoda zwraca bezpośrednią odpowiedź obok zdeserializowanej odpowiedzi
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
Bliźniacza reprezentacja lub elementy ClientRawResponse, jeśli raw=true
Typ zwracany
Wyjątki
update_twin
Aktualizacje tagów i żądanych właściwości bliźniaczej reprezentacji modułu. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.
update_twin(id, mid, device_twin_info, if_match=None, custom_headers=None, raw=False, **operation_config)Parametry
- device_twin_info
- Twin
Informacje o bliźniaczej reprezentacji modułu zawierające tagi i żądane właściwości do zaktualizowania.
- if_match
- str
Ciąg reprezentujący słaby element ETag dla bliźniaczej reprezentacji urządzenia zgodnie z RFC7232. Określa, czy należy przeprowadzić operację aktualizacji.
- raw
- bool
Metoda zwraca bezpośrednią odpowiedź obok zdeserializowanej odpowiedzi
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
Bliźniacza reprezentacja lub elementy ClientRawResponse, jeśli raw=true
Typ zwracany
Wyjątki
Atrybuty
models
models = <module 'azure.iot.hub.protocol.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\iot\\hub\\protocol\\models\\__init__.py'>
Azure SDK for Python
Opinia
Dostępne już wkrótce: W 2024 r. będziemy stopniowo wycofywać zgłoszenia z serwisu GitHub jako mechanizm przesyłania opinii na temat zawartości i zastępować go nowym systemem opinii. Aby uzyskać więcej informacji, sprawdź: https://aka.ms/ContentUserFeedback.
Prześlij i wyświetl opinię dla