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

ModulesOperations Класс

  • Ссылка

МодулиОпераций операций.

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

Конструктор

ModulesOperations(client, config, serializer, deserializer)

Параметры

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

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

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

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

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

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

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

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

Переменные

api_version

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

Методы

create_or_update_identity

Создает или обновляет удостоверение модуля для устройства в Центр Интернета вещей. Пользователь не может обновить moduleId и generationId.
delete_identity

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

Возвращает удостоверение модуля на устройстве.
get_modules_on_device

Возвращает все удостоверения модуля на устройстве.
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

Создает или обновляет удостоверение модуля для устройства в Центр Интернета вещей. Пользователь не может обновить moduleId и generationId.

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

Параметры

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

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

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

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

module
Module
Обязательно

Удостоверение модуля.

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

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

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

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

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

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

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

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

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

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

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

Module,
ClientRawResponse

Исключения

HttpOperationError

delete_identity

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

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

Параметры

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

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

mid
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_identity

Возвращает удостоверение модуля на устройстве.

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

Параметры

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

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

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

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

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

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

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

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

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

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

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

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

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

Module,
ClientRawResponse

Исключения

HttpOperationError

get_modules_on_device

Возвращает все удостоверения модуля на устройстве.

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

Параметры

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

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

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

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

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

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

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

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

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

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

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

list[Module],
ClientRawResponse

Исключения

HttpOperationError

get_twin

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

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

Параметры

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

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

mid
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, module_id, direct_method_request, custom_headers=None, raw=False, **operation_config)

Параметры

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

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

module_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, mid, device_twin_info, if_match=None, custom_headers=None, raw=False, **operation_config)

Параметры

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

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

mid
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, mid, device_twin_info, if_match=None, custom_headers=None, raw=False, **operation_config)

Параметры

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

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

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