Поделиться через

DevicesOperations Класс

  • Ссылка

УстройстваОпераций операций.

Наследование
builtins.object
DevicesOperations

Конструктор

DevicesOperations(client, config, serializer, deserializer)

Параметры

client
Обязательно

Клиент для запросов на обслуживание.

config
Обязательно

Настройка клиента службы.

serializer
Обязательно

Сериализатор объектной модели.

deserializer
Обязательно

Десериализатор объектной модели.

Переменные

api_version

Версия API. Значение константы: "2021-04-12".

Методы

create_or_update_identity

Создает или обновляет удостоверение устройства в реестре удостоверений Центр Интернета вещей.
delete_identity

Удаляет удостоверение устройства из реестра удостоверений Центр Интернета вещей.
get_devices

Получает удостоверения нескольких устройств из реестра удостоверений Центр Интернета вещей. Не рекомендуется. Используйте API запросов Центр Интернета вещей для получения сведений о двойниках устройства и удостоверениях устройства. Дополнительные сведения см. в разделах https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub и https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language.
get_identity

Возвращает устройство из реестра удостоверений Центр Интернета вещей.
get_twin

Возвращает двойник устройства. Подробнее см. в разделе https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.
invoke_method

Вызывает прямой метод на устройстве. Подробнее см. в разделе https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods.
replace_twin

Заменяет теги и требуемые свойства двойника устройства. Подробнее см. в разделе https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.
update_twin

Обновления теги и требуемые свойства двойника устройства. Подробнее см. в разделе https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.

create_or_update_identity

Создает или обновляет удостоверение устройства в реестре удостоверений Центр Интернета вещей.

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

Параметры

id
str
Обязательно

Уникальный идентификатор устройства.

device
Device
Обязательно

Содержимое удостоверения устройства.

if_match
str
значение по умолчанию: None

Строка, представляющая слабый ETag для удостоверения устройства, согласно RFC7232. Это значение не следует задавать при создании устройства, но может быть задано при обновлении устройства.

custom_headers
dict
значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw
bool
значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом

operation_config
Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Device или ClientRawResponse, если raw=true

Возвращаемый тип

Device,
ClientRawResponse

Исключения

HttpOperationError

delete_identity

Удаляет удостоверение устройства из реестра удостоверений Центр Интернета вещей.

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

Параметры

id
str
Обязательно

Уникальный идентификатор устройства.

if_match
str
значение по умолчанию: None

Строка, представляющая слабый ETag для удостоверения устройства, согласно RFC7232. Операция удаления выполняется только в том случае, если этот ETag соответствует значению, поддерживаемму сервером, указывая, что удостоверение устройства не было изменено с момента последнего извлечения. Чтобы принудительно выполнить безусловное удаление, задайте для If-Match подстановочный знак (*).

custom_headers
dict
значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw
bool
значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом

operation_config
Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

None или ClientRawResponse, если raw=true

Возвращаемый тип

None,
ClientRawResponse

Исключения

HttpOperationError

get_devices

Получает удостоверения нескольких устройств из реестра удостоверений Центр Интернета вещей. Не рекомендуется. Используйте API запросов Центр Интернета вещей для получения сведений о двойниках устройства и удостоверениях устройства. Дополнительные сведения см. в разделах https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub и https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language.

get_devices(top=None, custom_headers=None, raw=False, **operation_config)

Параметры

top
int
значение по умолчанию: None

Максимальное количество удостоверений устройств, возвращаемых запросом. Любое значение за пределами диапазона от 1 до 1000 считается 1000.

custom_headers
dict
значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw
bool
значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом

operation_config
Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

list или ClientRawResponse, если raw=true

Возвращаемый тип

list[Device],
ClientRawResponse

Исключения

HttpOperationError

get_identity

Возвращает устройство из реестра удостоверений Центр Интернета вещей.

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

Параметры

id
str
Обязательно

Уникальный идентификатор устройства.

custom_headers
dict
значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw
bool
значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом

operation_config
Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Device или ClientRawResponse, если raw=true

Возвращаемый тип

Device,
ClientRawResponse

Исключения

HttpOperationError

get_twin

Возвращает двойник устройства. Подробнее см. в разделе https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.

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

Параметры

id
str
Обязательно

Уникальный идентификатор устройства.

custom_headers
dict
значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw
bool
значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом

operation_config
Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Двойник или ClientRawResponse, если raw=true

Возвращаемый тип

Twin,
ClientRawResponse

Исключения

HttpOperationError

invoke_method

Вызывает прямой метод на устройстве. Подробнее см. в разделе 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)

Параметры

device_id
str
Обязательно

Уникальный идентификатор устройства.

direct_method_request
CloudToDeviceMethod
Обязательно

Параметры для выполнения прямого метода на устройстве.

custom_headers
dict
значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw
bool
значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом

operation_config
Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

CloudToDeviceMethodResult или ClientRawResponse, если raw=true

Возвращаемый тип

CloudToDeviceMethodResult,
ClientRawResponse

Исключения

HttpOperationError

replace_twin

Заменяет теги и требуемые свойства двойника устройства. Подробнее см. в разделе 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)

Параметры

id
str
Обязательно

Уникальный идентификатор устройства.

device_twin_info
Twin
Обязательно

Сведения о двойнику устройства, которые заменят существующие сведения.

if_match
str
значение по умолчанию: None

Строка, представляющая слабый ETag для двойника устройства, согласно RFC7232. Он определяет, следует ли выполнять операцию замены.

custom_headers
dict
значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw
bool
значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом

operation_config
Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Двойник или ClientRawResponse, если raw=true

Возвращаемый тип

Twin,
ClientRawResponse

Исключения

HttpOperationError

update_twin

Обновления теги и требуемые свойства двойника устройства. Подробнее см. в разделе 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)

Параметры

id
str
Обязательно

Уникальный идентификатор устройства.

device_twin_info
Twin
Обязательно

Сведения о двойнику устройства, содержащие теги и требуемые свойства для обновления.

if_match
str
значение по умолчанию: None

Строка, представляющая слабый ETag для двойника устройства, согласно RFC7232. Он определяет, следует ли выполнять операцию обновления.

custom_headers
dict
значение по умолчанию: None

заголовки, которые будут добавлены в запрос

raw
bool
значение по умолчанию: False

возвращает прямой ответ вместе с десериализованным ответом

operation_config
Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Двойник или ClientRawResponse, если raw=true

Возвращаемый тип

Twin,
ClientRawResponse

Исключения

HttpOperationError

Атрибуты

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