Modules - Update Twin

Referencia

Servicio:: IoT Hub

Versión de la API:: 2021-04-12

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.

PATCH https://fully-qualified-iothubname.azure-devices.net/twins/{id}/modules/{mid}?api-version=2021-04-12

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
id	path	True	string	Identificador único del dispositivo.
mid	path	True	string	Identificador único del módulo.
api-version	query	True	string	Versión de la API.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
If-Match		string	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.

Cuerpo de la solicitud

Nombre	Tipo	Description
authenticationType	enum: sas selfSigned certificateAuthority none	Tipo de autenticación usado por el dispositivo.
capabilities	DeviceCapabilities	Estado de las funcionalidades habilitadas en el dispositivo.
cloudToDeviceMessageCount	integer	Número de mensajes de nube a dispositivo enviados.
connectionState	enum: Disconnected Connected	Estado de conexión del dispositivo.
deviceEtag	string	Cadena que representa una ETag para el dispositivo, según RFC7232.
deviceId	string	Identificador único del dispositivo en el registro de identidad del IoT Hub. Es una cadena que distingue mayúsculas de minúsculas (hasta 128 caracteres) de caracteres alfanuméricos de ASCII de 7 bits, y los siguientes caracteres especiales {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
deviceScope	string	El ámbito del dispositivo.
etag	string	Cadena que representa un ETag para el dispositivo gemelo, según RFC7232.
lastActivityTime	string	Fecha y hora en que el dispositivo se conectó por última vez o recibió o envió un mensaje. La fecha y hora se especifican en ISO8601 formato datetime en UTC, por ejemplo, 2015-01-28T16:24:48.789Z. Este valor no se actualiza si el dispositivo usa el protocolo HTTP/1 para realizar operaciones de mensajería.
moduleId	string	Identificador único del módulo en el registro de identidad del IoT Hub. Es una cadena que distingue mayúsculas de minúsculas (hasta 128 caracteres) de caracteres alfanuméricos de ASCII de 7 bits, y los siguientes caracteres especiales {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
parentScopes	string[]	Los ámbitos de los dispositivos perimetrales de nivel superior, si procede. Solo está disponible para dispositivos perimetrales.
properties	TwinProperties	Las propiedades deseadas y notificadas del gemelo.
status	enum: enabled disabled	Estado habilitado del dispositivo. Si está deshabilitado, el dispositivo no puede conectarse al servicio.
statusReason	string	Motivo del estado actual del dispositivo, si existe.
statusUpdateTime	string	Fecha y hora en que se actualizó por última vez el estado del dispositivo.
tags	object	Colección de pares clave-valor leídos y escritos por el back-end de la solución. No son visibles para las aplicaciones de dispositivo. Las claves están codificadas con UTF-8, distinguen mayúsculas de minúsculas y tienen una longitud de hasta 1 KB. Los caracteres permitidos excluyen caracteres de control UNICODE (segmentos C0 y C1), ".", "$" y espacio. Los valores son objetos JSON, de hasta 4 KB de longitud.
version	integer	La versión del dispositivo gemelo, incluidas las etiquetas y las propiedades deseadas
x509Thumbprint	X509Thumbprint	Huella digital X509 del dispositivo.

Respuestas

Nombre	Tipo	Description
200 OK	Twin	Aceptar.

Definiciones

Nombre	Description
DeviceCapabilities	Estado de las funcionalidades habilitadas en el dispositivo.
Twin	Información de estado de un dispositivo o módulo. Esto se crea y elimina implícitamente cuando se crea o elimina la identidad del dispositivo o módulo correspondiente en el IoT Hub.
TwinProperties	Las propiedades deseadas y notificadas del gemelo. La profundidad máxima del objeto es 10.
X509Thumbprint

DeviceCapabilities

Estado de las funcionalidades habilitadas en el dispositivo.

Nombre	Tipo	Description
iotEdge	boolean	Propiedad que determina si el dispositivo es un dispositivo perimetral o no.

Twin

Información de estado de un dispositivo o módulo. Esto se crea y elimina implícitamente cuando se crea o elimina la identidad del dispositivo o módulo correspondiente en el IoT Hub.

Nombre	Tipo	Description
authenticationType	enum: certificateAuthority none sas selfSigned	Tipo de autenticación usado por el dispositivo.
capabilities	DeviceCapabilities	Estado de las funcionalidades habilitadas en el dispositivo.
cloudToDeviceMessageCount	integer	Número de mensajes de nube a dispositivo enviados.
connectionState	enum: Connected Disconnected	Estado de conexión del dispositivo.
deviceEtag	string	Cadena que representa una ETag para el dispositivo, según RFC7232.
deviceId	string	Identificador único del dispositivo en el registro de identidad del IoT Hub. Es una cadena que distingue mayúsculas de minúsculas (hasta 128 caracteres) de caracteres alfanuméricos de ASCII de 7 bits, y los siguientes caracteres especiales {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
deviceScope	string	El ámbito del dispositivo.
etag	string	Cadena que representa un ETag para el dispositivo gemelo, según RFC7232.
lastActivityTime	string	Fecha y hora en que el dispositivo se conectó por última vez o recibió o envió un mensaje. La fecha y hora se especifican en ISO8601 formato datetime en UTC, por ejemplo, 2015-01-28T16:24:48.789Z. Este valor no se actualiza si el dispositivo usa el protocolo HTTP/1 para realizar operaciones de mensajería.
moduleId	string	Identificador único del módulo en el registro de identidad del IoT Hub. Es una cadena que distingue mayúsculas de minúsculas (hasta 128 caracteres) de caracteres alfanuméricos de ASCII de 7 bits, y los siguientes caracteres especiales {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
parentScopes	string[]	Los ámbitos de los dispositivos perimetrales de nivel superior, si procede. Solo está disponible para dispositivos perimetrales.
properties	TwinProperties	Las propiedades deseadas y notificadas del gemelo.
status	enum: disabled enabled	Estado habilitado del dispositivo. Si está deshabilitado, el dispositivo no puede conectarse al servicio.
statusReason	string	Motivo del estado actual del dispositivo, si existe.
statusUpdateTime	string	Fecha y hora en que se actualizó por última vez el estado del dispositivo.
tags	object	Colección de pares clave-valor leídos y escritos por el back-end de la solución. No son visibles para las aplicaciones de dispositivo. Las claves están codificadas con UTF-8, distinguen mayúsculas de minúsculas y tienen una longitud de hasta 1 KB. Los caracteres permitidos excluyen caracteres de control UNICODE (segmentos C0 y C1), ".", "$" y espacio. Los valores son objetos JSON, de hasta 4 KB de longitud.
version	integer	La versión del dispositivo gemelo, incluidas las etiquetas y las propiedades deseadas
x509Thumbprint	X509Thumbprint	Huella digital X509 del dispositivo.

TwinProperties

Las propiedades deseadas y notificadas del gemelo. La profundidad máxima del objeto es 10.

Nombre	Tipo	Description
desired	object	Colección de pares clave-valor de propiedad deseada. Las claves están codificadas con UTF-8, distinguen mayúsculas de minúsculas y tienen una longitud de hasta 1 KB. Los caracteres permitidos excluyen caracteres de control UNICODE (segmentos C0 y C1), ".", "$" y espacio. Los valores de porperty deseados son objetos JSON, de hasta 4 KB de longitud.
reported	object	Colección de pares clave-valor de propiedad notificados. Las claves están codificadas con UTF-8, distinguen mayúsculas de minúsculas y tienen una longitud de hasta 1 KB. Los caracteres permitidos excluyen caracteres de control UNICODE (segmentos C0 y C1), ".", "$" y espacio. Los valores de propiedad notificados son objetos JSON, de hasta 4 KB de longitud.

X509Thumbprint

Nombre	Tipo	Description
primaryThumbprint	string	Huella digital principal del certificado de cliente X509.
secondaryThumbprint	string	Huella digital secundaria del certificado de cliente X509.

Compartir a través de