DevicesOperations Clase

Operaciones DevicesOperations.

Herencia

builtins.object

DevicesOperations

Constructor

DevicesOperations(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 de un dispositivo en el registro de identidades del IoT Hub.
delete_identity	Elimina la identidad de un dispositivo del registro de identidades del IoT Hub.
get_devices	Obtiene las identidades de varios dispositivos del registro de identidad de IoT Hub. No se recomienda. Use la API de consulta de IoT Hub para recuperar la información de identidad del dispositivo gemelo y del dispositivo. Para obtener más información, vea https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub y https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language.
get_identity	Obtiene un dispositivo del registro de identidades del IoT Hub.
get_twin	Obtiene el dispositivo 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 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 dispositivo 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 dispositivo 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 de un dispositivo en el registro de identidades del IoT Hub.

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

Parámetros

id

str

Requerido

Identificador único del dispositivo.

device

Device

Requerido

El contenido de la identidad del dispositivo.

if_match

str

valor predeterminado: None

Cadena que representa una ETag débil para la identidad del dispositivo, según RFC7232. Esto no debe establecerse al crear un dispositivo, pero puede establecerse al actualizar un 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

Device o ClientRawResponse si raw=true

Tipo de valor devuelto

Device,

ClientRawResponse

Excepciones

HttpOperationError

delete_identity

Elimina la identidad de un dispositivo del registro de identidades del IoT Hub.

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

Parámetros

id

str

Requerido

Identificador único del dispositivo.

if_match

str

valor predeterminado: None

Cadena que representa una ETag débil para la identidad del dispositivo, 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 la identidad del dispositivo 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_devices

Obtiene las identidades de varios dispositivos del registro de identidad de IoT Hub. No se recomienda. Use la API de consulta de IoT Hub para recuperar la información de identidad del dispositivo gemelo y del dispositivo. Para obtener más información, vea https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub y 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)

Parámetros

top

int

valor predeterminado: None

Número máximo de identidades de dispositivo devueltas por la consulta. Cualquier valor fuera del intervalo de 1 a 1000 se considera 1000.

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[Device],

ClientRawResponse

Excepciones

HttpOperationError

get_identity

Obtiene un dispositivo del registro de identidades del IoT Hub.

get_identity(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

Device o ClientRawResponse si raw=true

Tipo de valor devuelto

Device,

ClientRawResponse

Excepciones

HttpOperationError

get_twin

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

get_twin(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

Twin o ClientRawResponse si raw=true

Tipo de valor devuelto

Twin,

ClientRawResponse

Excepciones

HttpOperationError

invoke_method

Invoca un método directo en 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, direct_method_request, custom_headers=None, raw=False, **operation_config)

Parámetros

device_id

str

Requerido

Identificador único del dispositivo.

direct_method_request

CloudToDeviceMethod

Requerido

Parámetros para ejecutar un método directo en el 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

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 dispositivo gemelo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins para obtener más información.

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

Parámetros

id

str

Requerido

Identificador único del dispositivo.

device_twin_info

Twin

Requerido

Información del dispositivo 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 dispositivo gemelo. Consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins para obtener más información.

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

Parámetros

id

str

Requerido

Identificador único del dispositivo.

device_twin_info

Twin

Requerido

Información del dispositivo 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'>