Udostępnij za pośrednictwem

DevicesOperations Klasa

  • Odwołanie

UrządzeniaOperacje.

Dziedziczenie
builtins.object
DevicesOperations

Konstruktor

DevicesOperations(client, config, serializer, deserializer)

Parametry

client
Wymagane

Klient żądań obsługi.

config
Wymagane

Konfiguracja klienta usługi.

serializer
Wymagane

Serializator modelu obiektów.

deserializer
Wymagane

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ść urządzenia w rejestrze tożsamości IoT Hub.
delete_identity

Usuwa tożsamość urządzenia z rejestru tożsamości IoT Hub.
get_devices

Pobiera tożsamości wielu urządzeń z rejestru tożsamości IoT Hub. Niezalecane. Użyj interfejsu API zapytań IoT Hub, 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_identity

Pobiera urządzenie z rejestru tożsamości IoT Hub.
get_twin

Pobiera bliźniacze reprezentacje urządzenia. 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ą na urządzeniu. 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 urządzenia. 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 urządzenia. 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ść urządzenia w rejestrze tożsamości IoT Hub.

create_or_update_identity(id, device, if_match=None, custom_headers=None, raw=False, **operation_config)

Parametry

id
str
Wymagane

Unikatowy identyfikator urządzenia.

device
Device
Wymagane

Zawartość tożsamości urządzenia.

if_match
str
wartość domyślna: None

Ciąg reprezentujący słaby element ETag dla tożsamości urządzenia zgodnie z specyfikacją RFC7232. Nie należy ustawiać tego ustawienia podczas tworzenia urządzenia, ale można je ustawić podczas aktualizowania urządzenia.

custom_headers
dict
wartość domyślna: None

nagłówki, które zostaną dodane do żądania

raw
bool
wartość domyślna: False

zwraca bezpośrednią odpowiedź obok odpowiedzi deserializowanej

operation_config
Wymagane

Przesłonięcia konfiguracji operacji.

Zwraca

Urządzenie lub klientRawResponse, jeśli wartość raw=true

Typ zwracany

Device,
ClientRawResponse

Wyjątki

HttpOperationError

delete_identity

Usuwa tożsamość urządzenia z rejestru tożsamości IoT Hub.

delete_identity(id, if_match=None, custom_headers=None, raw=False, **operation_config)

Parametry

id
str
Wymagane

Unikatowy identyfikator urządzenia.

if_match
str
wartość domyślna: None

Ciąg reprezentujący słaby element ETag dla tożsamości urządzenia zgodnie z specyfikacją RFC7232. Operacja usuwania jest wykonywana tylko wtedy, gdy ten element ETag jest zgodny z wartością obsługiwaną przez serwer, wskazując, że tożsamość urządzenia nie została zmodyfikowana od czasu ostatniego pobrania. Aby wymusić bezwarunkowe usunięcie, ustaw If-Match na symbol wieloznaczny (*).

custom_headers
dict
wartość domyślna: None

nagłówki, które zostaną dodane do żądania

raw
bool
wartość domyślna: False

zwraca bezpośrednią odpowiedź obok odpowiedzi deserializowanej

operation_config
Wymagane

Przesłonięcia konfiguracji operacji.

Zwraca

Brak lub ClientRawResponse, jeśli wartość raw=true

Typ zwracany

None,
ClientRawResponse

Wyjątki

HttpOperationError

get_devices

Pobiera tożsamości wielu urządzeń z rejestru tożsamości IoT Hub. Niezalecane. Użyj interfejsu API zapytań IoT Hub, 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(top=None, custom_headers=None, raw=False, **operation_config)

Parametry

top
int
wartość domyślna: None

Maksymalna liczba tożsamości urządzeń zwracanych przez zapytanie. Każda wartość spoza zakresu od 1 do 1000 jest uważana za 1000.

custom_headers
dict
wartość domyślna: None

nagłówki, które zostaną dodane do żądania

raw
bool
wartość domyślna: False

zwraca bezpośrednią odpowiedź obok odpowiedzi deserializowanej

operation_config
Wymagane

Przesłonięcia konfiguracji operacji.

Zwraca

list lub ClientRawResponse, jeśli raw=true

Typ zwracany

list[Device],
ClientRawResponse

Wyjątki

HttpOperationError

get_identity

Pobiera urządzenie z rejestru tożsamości IoT Hub.

get_identity(id, custom_headers=None, raw=False, **operation_config)

Parametry

id
str
Wymagane

Unikatowy identyfikator urządzenia.

custom_headers
dict
wartość domyślna: None

nagłówki, które zostaną dodane do żądania

raw
bool
wartość domyślna: False

zwraca bezpośrednią odpowiedź obok odpowiedzi deserializowanej

operation_config
Wymagane

Przesłonięcia konfiguracji operacji.

Zwraca

Urządzenie lub klientRawResponse, jeśli wartość raw=true

Typ zwracany

Device,
ClientRawResponse

Wyjątki

HttpOperationError

get_twin

Pobiera bliźniacze reprezentacje urządzenia. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.

get_twin(id, custom_headers=None, raw=False, **operation_config)

Parametry

id
str
Wymagane

Unikatowy identyfikator urządzenia.

custom_headers
dict
wartość domyślna: None

nagłówki, które zostaną dodane do żądania

raw
bool
wartość domyślna: False

zwraca bezpośrednią odpowiedź obok odpowiedzi deserializowanej

operation_config
Wymagane

Przesłonięcia konfiguracji operacji.

Zwraca

Twin lub ClientRawResponse, jeśli raw=true

Typ zwracany

Twin,
ClientRawResponse

Wyjątki

HttpOperationError

invoke_method

Wywołuje metodę bezpośrednią na urządzeniu. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods.

invoke_method(device_id, direct_method_request, custom_headers=None, raw=False, **operation_config)

Parametry

device_id
str
Wymagane

Unikatowy identyfikator urządzenia.

direct_method_request
CloudToDeviceMethod
Wymagane

Parametry do wykonania metody bezpośredniej na urządzeniu.

custom_headers
dict
wartość domyślna: None

nagłówki, które zostaną dodane do żądania

raw
bool
wartość domyślna: False

zwraca bezpośrednią odpowiedź obok odpowiedzi deserializowanej

operation_config
Wymagane

Przesłonięcia konfiguracji operacji.

Zwraca

CloudToDeviceMethodResult lub ClientRawResponse, jeśli raw=true

Typ zwracany

CloudToDeviceMethodResult,
ClientRawResponse

Wyjątki

HttpOperationError

replace_twin

Zastępuje tagi i żądane właściwości bliźniaczej reprezentacji urządzenia. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.

replace_twin(id, device_twin_info, if_match=None, custom_headers=None, raw=False, **operation_config)

Parametry

id
str
Wymagane

Unikatowy identyfikator urządzenia.

device_twin_info
Twin
Wymagane

Informacje o bliźniaczej reprezentacji urządzenia, które zastąpią istniejące informacje.

if_match
str
wartość domyślna: None

Ciąg reprezentujący słaby element ETag dla bliźniaczej reprezentacji urządzenia zgodnie z specyfikacją RFC7232. Określa, czy należy wykonać operację zamiany.

custom_headers
dict
wartość domyślna: None

nagłówki, które zostaną dodane do żądania

raw
bool
wartość domyślna: False

zwraca bezpośrednią odpowiedź obok odpowiedzi deserializowanej

operation_config
Wymagane

Przesłonięcia konfiguracji operacji.

Zwraca

Twin lub ClientRawResponse, jeśli raw=true

Typ zwracany

Twin,
ClientRawResponse

Wyjątki

HttpOperationError

update_twin

Aktualizacje tagów i żądanych właściwości bliźniaczej reprezentacji urządzenia. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.

update_twin(id, device_twin_info, if_match=None, custom_headers=None, raw=False, **operation_config)

Parametry

id
str
Wymagane

Unikatowy identyfikator urządzenia.

device_twin_info
Twin
Wymagane

Informacje o bliźniaczej reprezentacji urządzenia zawierające tagi i żądane właściwości do zaktualizowania.

if_match
str
wartość domyślna: None

Ciąg reprezentujący słaby element ETag dla bliźniaczej reprezentacji urządzenia zgodnie z specyfikacją RFC7232. Określa, czy należy przeprowadzić operację aktualizacji.

custom_headers
dict
wartość domyślna: None

nagłówki, które zostaną dodane do żądania

raw
bool
wartość domyślna: False

zwraca bezpośrednią odpowiedź obok odpowiedzi deserializowanej

operation_config
Wymagane

Przesłonięcia konfiguracji operacji.

Zwraca

Twin lub ClientRawResponse, jeśli raw=true

Typ zwracany

Twin,
ClientRawResponse

Wyjątki

HttpOperationError

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'>