Devices - Create Or Update Identity

  • Referencia
Service:
IoT Hub
API Version:
2021-04-12

Crea o actualiza la identidad de un dispositivo en el registro de identidades del IoT Hub.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
id
 path True

string

Identificador único del dispositivo.
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 la identidad del dispositivo, según RFC7232. Esto no debe establecerse al crear un dispositivo, pero puede establecerse al actualizar un dispositivo.

Cuerpo de la solicitud

Nombre Tipo Description
authentication

AuthenticationMechanism

Mecanismo de autenticación utilizado por el dispositivo.
capabilities

DeviceCapabilities

Conjunto de funcionalidades del dispositivo. Por ejemplo, si este dispositivo es un dispositivo perimetral o no.
cloudToDeviceMessageCount

integer

Número de mensajes de nube a dispositivo actualmente en cola que se enviarán al dispositivo.
connectionState enum:
  • Disconnected
  • Connected

Estado del dispositivo.
connectionStateUpdatedTime

string

Fecha y hora en que se actualizó por última vez el estado de conexión.
deviceId

string

Identificador único del dispositivo.
deviceScope

string

El ámbito del dispositivo. Generado automáticamente e inmutable para dispositivos perimetrales y modificable en dispositivos hoja para crear una relación secundaria o primaria.
etag

string

Cadena que representa una ETag débil para la identidad del dispositivo, según RFC7232.
generationId

string

Cadena con distinción entre mayúsculas y minúsculas generada por IoT Hub hasta 128 caracteres. Este valor se usa para distinguir dispositivos con el mismo deviceId, cuando se han eliminado y vuelto a crear.
lastActivityTime

string

Fecha y última vez que el dispositivo se ha conectado, recibido o enviado un mensaje por última vez.
parentScopes

string[]

Los ámbitos de los dispositivos perimetrales de nivel superior, si procede. Solo está disponible para dispositivos perimetrales.
status enum:
  • enabled
  • disabled

Estado del dispositivo. Si el estado está deshabilitado, un dispositivo no puede conectarse al servicio.
statusReason

string

Cadena de 128 caracteres de longitud que almacena el motivo del estado de identidad del dispositivo. Se permiten todos los caracteres UTF-8.
statusUpdatedTime

string

Fecha y hora en que se actualizó por última vez el campo de estado.

Respuestas

Nombre Tipo Description
200 OK

Device

Aceptar.

Definiciones

Nombre Description
AuthenticationMechanism
Device
DeviceCapabilities

Estado de las funcionalidades habilitadas en el dispositivo.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Nombre Tipo Description
symmetricKey

SymmetricKey

Claves principales y secundarias usadas para la autenticación basada en SAS.
type enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Tipo de autenticación que se usa para conectarse al servicio.
x509Thumbprint

X509Thumbprint

Las huellas digitales x509 principales y secundarias usadas para la autenticación basada en x509.

Device

Nombre Tipo Description
authentication

AuthenticationMechanism

Mecanismo de autenticación utilizado por el dispositivo.
capabilities

DeviceCapabilities

Conjunto de funcionalidades del dispositivo. Por ejemplo, si este dispositivo es un dispositivo perimetral o no.
cloudToDeviceMessageCount

integer

Número de mensajes de nube a dispositivo actualmente en cola que se enviarán al dispositivo.
connectionState enum:
  • Connected
  • Disconnected

Estado del dispositivo.
connectionStateUpdatedTime

string

Fecha y hora en que se actualizó por última vez el estado de conexión.
deviceId

string

Identificador único del dispositivo.
deviceScope

string

El ámbito del dispositivo. Generado automáticamente e inmutable para dispositivos perimetrales y modificable en dispositivos hoja para crear una relación secundaria o primaria.
etag

string

Cadena que representa una ETag débil para la identidad del dispositivo, según RFC7232.
generationId

string

Cadena con distinción entre mayúsculas y minúsculas generada por IoT Hub hasta 128 caracteres. Este valor se usa para distinguir dispositivos con el mismo deviceId, cuando se han eliminado y vuelto a crear.
lastActivityTime

string

Fecha y última vez que el dispositivo se ha conectado, recibido o enviado un mensaje por última vez.
parentScopes

string[]

Los ámbitos de los dispositivos perimetrales de nivel superior, si procede. Solo está disponible para dispositivos perimetrales.
status enum:
  • disabled
  • enabled

Estado del dispositivo. Si el estado está deshabilitado, un dispositivo no puede conectarse al servicio.
statusReason

string

Cadena de 128 caracteres de longitud que almacena el motivo del estado de identidad del dispositivo. Se permiten todos los caracteres UTF-8.
statusUpdatedTime

string

Fecha y hora en que se actualizó por última vez el campo de estado.

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.

SymmetricKey

Nombre Tipo Description
primaryKey

string

Clave principal codificada en base64 del dispositivo.
secondaryKey

string

Clave secundaria codificada en base64 del dispositivo.

X509Thumbprint

Nombre Tipo Description
primaryThumbprint

string

Huella digital principal del certificado de cliente X509.
secondaryThumbprint

string

Huella digital secundaria del certificado de cliente X509.