ModulesOperations Clase

Operaciones ModulesOperations.

Herencia

builtins.object

ModulesOperations

Constructor

ModulesOperations(client, config, serializer, deserializer)

Parámetros

client

Requerido

Cliente para solicitudes de servicio.

config

Requerido

Configuración del cliente de servicio.

serializer

Requerido

Serializador de modelo de objetos.

deserializer

Requerido

Deserializador de modelo de objetos.

Variables

api_version

Versión de la API. Valor constante: "2021-04-12".

Métodos

create_or_update_identity	Crea o actualiza la identidad del módulo para un dispositivo en el IoT Hub. El usuario no puede actualizar moduleId y generationId.
delete_identity	Elimina la identidad del módulo de un dispositivo en el IoT Hub.
get_identity	Obtiene una identidad de módulo en el dispositivo.
get_modules_on_device	Obtiene todas las identidades del módulo en el dispositivo.
get_twin	Obtiene el módulo gemelo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins para obtener más información.
invoke_method	Invoca un método directo en un módulo de un dispositivo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods para obtener más información.
replace_twin	Reemplaza las etiquetas y las propiedades deseadas de un módulo gemelo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins para obtener más información.
update_twin	Novedades las etiquetas y las propiedades deseadas de un módulo gemelo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins para obtener más información.

create_or_update_identity

Crea o actualiza la identidad del módulo para un dispositivo en el IoT Hub. El usuario no puede actualizar moduleId y generationId.

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

Parámetros

id

str

Requerido

Identificador único del dispositivo.

mid

str

Requerido

Identificador único del módulo.

module

Module

Requerido

Identidad del módulo.

if_match

str

valor predeterminado: None

Cadena que representa una ETag débil para el módulo, según RFC7232. Esto no debe establecerse al crear un módulo, pero se puede establecer al actualizar un módulo.

custom_headers

dict

valor predeterminado: None

encabezados que se agregarán a la solicitud

raw

bool

valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config

Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Module o ClientRawResponse si raw=true

Tipo de valor devuelto

Module,

ClientRawResponse

Excepciones

HttpOperationError

delete_identity

Elimina la identidad del módulo de un dispositivo en el IoT Hub.

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

Parámetros

id

str

Requerido

Identificador único de la deivce.

mid

str

Requerido

Identificador único del módulo.

if_match

str

valor predeterminado: None

Cadena que representa una ETag débil para el módulo, según RFC7232. La operación de eliminación solo se realiza si esta ETag coincide con el valor mantenido por el servidor, lo que indica que el módulo no se ha modificado desde que se recuperó por última vez. Para forzar una eliminación incondicional, establezca If-Match en el carácter comodín (*).

custom_headers

dict

valor predeterminado: None

encabezados que se agregarán a la solicitud

raw

bool

valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config

Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Ninguno o ClientRawResponse si raw=true

Tipo de valor devuelto

None,

ClientRawResponse

Excepciones

HttpOperationError

get_identity

Obtiene una identidad de módulo en el dispositivo.

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

Parámetros

id

str

Requerido

Identificador único del dispositivo.

mid

str

Requerido

Identificador único del módulo.

custom_headers

dict

valor predeterminado: None

encabezados que se agregarán a la solicitud

raw

bool

valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config

Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Module o ClientRawResponse si raw=true

Tipo de valor devuelto

Module,

ClientRawResponse

Excepciones

HttpOperationError

get_modules_on_device

Obtiene todas las identidades del módulo en el dispositivo.

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

Parámetros

id

str

Requerido

Identificador único del dispositivo.

custom_headers

dict

valor predeterminado: None

encabezados que se agregarán a la solicitud

raw

bool

valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config

Requerido

Invalidaciones de configuración de la operación.

Devoluciones

list o ClientRawResponse si raw=true

Tipo de valor devuelto

list[Module],

ClientRawResponse

Excepciones

HttpOperationError

get_twin

Obtiene el módulo gemelo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins para obtener más información.

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

Parámetros

id

str

Requerido

Identificador único del dispositivo.

mid

str

Requerido

Identificador único del módulo.

custom_headers

dict

valor predeterminado: None

encabezados que se agregarán a la solicitud

raw

bool

valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config

Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Twin o ClientRawResponse si raw=true

Tipo de valor devuelto

Twin,

ClientRawResponse

Excepciones

HttpOperationError

invoke_method

Invoca un método directo en un módulo de un dispositivo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods para obtener más información.

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

Parámetros

device_id

str

Requerido

Identificador único del dispositivo.

module_id

str

Requerido

Identificador único del módulo.

direct_method_request

CloudToDeviceMethod

Requerido

Parámetros para ejecutar un método directo en el módulo.

custom_headers

dict

valor predeterminado: None

encabezados que se agregarán a la solicitud

raw

bool

valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config

Requerido

Invalidaciones de configuración de la operación.

Devoluciones

CloudToDeviceMethodResult o ClientRawResponse si raw=true

Tipo de valor devuelto

CloudToDeviceMethodResult,

ClientRawResponse

Excepciones

HttpOperationError

replace_twin

Reemplaza las etiquetas y las propiedades deseadas de un módulo gemelo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins para obtener más información.

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

Parámetros

id

str

Requerido

Identificador único del dispositivo.

mid

str

Requerido

Identificador único del módulo.

device_twin_info

Twin

Requerido

La información del módulo gemelo que reemplazará la información existente.

if_match

str

valor predeterminado: None

Cadena que representa una ETag débil para el dispositivo gemelo, según RFC7232. Determina si se debe llevar a cabo la operación de reemplazo.

custom_headers

dict

valor predeterminado: None

encabezados que se agregarán a la solicitud

raw

bool

valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config

Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Twin o ClientRawResponse si raw=true

Tipo de valor devuelto

Twin,

ClientRawResponse

Excepciones

HttpOperationError

update_twin

Novedades las etiquetas y las propiedades deseadas de un módulo gemelo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins para obtener más información.

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

Parámetros

id

str

Requerido

Identificador único del dispositivo.

mid

str

Requerido

Identificador único del módulo.

device_twin_info

Twin

Requerido

La información del módulo gemelo que contiene las etiquetas y las propiedades deseadas que se van a actualizar.

if_match

str

valor predeterminado: None

Cadena que representa una ETag débil para el dispositivo gemelo, según RFC7232. Determina si se debe llevar a cabo la operación de actualización.

custom_headers

dict

valor predeterminado: None

encabezados que se agregarán a la solicitud

raw

bool

valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config

Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Twin o ClientRawResponse si raw=true

Tipo de valor devuelto

Twin,

ClientRawResponse

Excepciones

HttpOperationError

Atributos

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