Partager via

Devices - Create Or Update Identity

  • Référence
Service:
IoT Hub
Version d'API:
2021-04-12

Crée ou met à jour l’identité d’un appareil dans le registre d’identités du IoT Hub.

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

Paramètres URI

Nom Dans Obligatoire Type Description
id
 path True

string

Identificateur unique de l’appareil.
api-version
 query True

string

Version de l’API.

En-tête de la demande

Nom Obligatoire Type Description
If-Match

string

Chaîne représentant un ETag faible pour l’identité de l’appareil, conformément à RFC7232. Cela ne doit pas être défini lors de la création d’un appareil, mais peut l’être lors de la mise à jour d’un appareil.

Corps de la demande

Nom Type Description
authentication

AuthenticationMechanism

Mécanisme d’authentification utilisé par l’appareil.
capabilities

DeviceCapabilities

Ensemble de fonctionnalités de l’appareil. Par exemple, si cet appareil est un appareil de périphérie ou non.
cloudToDeviceMessageCount

integer (int32)

Nombre de messages cloud-à-appareil actuellement en file d’attente pour être envoyés à l’appareil.
connectionState enum:
  • Disconnected
  • Connected

L’état de l’appareil.
connectionStateUpdatedTime

string (date-time)

Date et heure de la dernière mise à jour de l’état de la connexion.
deviceId

string

Identificateur unique de l’appareil.
deviceScope

string

Portée de l’appareil. Généré automatiquement et immuable pour les appareils edge et modifiables dans les appareils feuilles pour créer une relation enfant/parent.
etag

string

Chaîne représentant un ETag faible pour l’identité de l’appareil, conformément à RFC7232.
generationId

string

Chaîne de 128 caractères générée par la IoT Hub et respectant la casse. Cette valeur permet de distinguer les appareils dotés du même deviceIdlorsqu’ils ont été supprimés et recréés.
lastActivityTime

string (date-time)

Date et heure de la dernière connexion, de la réception ou de l’envoi d’un message à l’appareil.
parentScopes

string[]

Étendues des périphériques de niveau supérieur, le cas échéant. Disponible uniquement pour les appareils de périphérie.
status enum:
  • enabled
  • disabled

Status de l’appareil. Si le status désactivé, un appareil ne peut pas se connecter au service.
statusReason

string

Chaîne de 128 caractères qui stocke la raison de l’identité de l’appareil status. Tous les caractères UTF-8 sont autorisés.
statusUpdatedTime

string (date-time)

Date et heure de la dernière mise à jour du champ status.

Réponses

Nom Type Description
200 OK

Device

OK.

Définitions

Nom Description
AuthenticationMechanism
Device
DeviceCapabilities

Status des fonctionnalités activées sur l’appareil.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Object
Nom Type Description
symmetricKey

SymmetricKey

Clés primaires et secondaires utilisées pour l’authentification basée sur SAS.
type enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Type d’authentification utilisé pour se connecter au service.
x509Thumbprint

X509Thumbprint

Empreintes x509 primaires et secondaires utilisées pour l’authentification basée sur x509.

Device

Object
Nom Type Description
authentication

AuthenticationMechanism

Mécanisme d’authentification utilisé par l’appareil.
capabilities

DeviceCapabilities

Ensemble de fonctionnalités de l’appareil. Par exemple, si cet appareil est un appareil de périphérie ou non.
cloudToDeviceMessageCount

integer (int32)

Nombre de messages cloud-à-appareil actuellement en file d’attente pour être envoyés à l’appareil.
connectionState enum:
  • Connected
  • Disconnected

L’état de l’appareil.
connectionStateUpdatedTime

string (date-time)

Date et heure de la dernière mise à jour de l’état de la connexion.
deviceId

string

Identificateur unique de l’appareil.
deviceScope

string

Portée de l’appareil. Généré automatiquement et immuable pour les appareils edge et modifiables dans les appareils feuilles pour créer une relation enfant/parent.
etag

string

Chaîne représentant un ETag faible pour l’identité de l’appareil, conformément à RFC7232.
generationId

string

Chaîne de 128 caractères générée par la IoT Hub et respectant la casse. Cette valeur permet de distinguer les appareils dotés du même deviceIdlorsqu’ils ont été supprimés et recréés.
lastActivityTime

string (date-time)

Date et heure de la dernière connexion, de la réception ou de l’envoi d’un message à l’appareil.
parentScopes

string[]

Étendues des périphériques de niveau supérieur, le cas échéant. Disponible uniquement pour les appareils de périphérie.
status enum:
  • disabled
  • enabled

Status de l’appareil. Si le status désactivé, un appareil ne peut pas se connecter au service.
statusReason

string

Chaîne de 128 caractères qui stocke la raison de l’identité de l’appareil status. Tous les caractères UTF-8 sont autorisés.
statusUpdatedTime

string (date-time)

Date et heure de la dernière mise à jour du champ status.

DeviceCapabilities

Object

Status des fonctionnalités activées sur l’appareil.

Nom Type Description
iotEdge

boolean

Propriété qui détermine si l’appareil est un appareil edge ou non.

SymmetricKey

Object
Nom Type Description
primaryKey

string

Clé primaire encodée en base64 de l’appareil.
secondaryKey

string

Clé secondaire encodée en base64 de l’appareil.

X509Thumbprint

Object
Nom Type Description
primaryThumbprint

string

Empreinte primaire du certificat client X509.
secondaryThumbprint

string

Empreinte secondaire du certificat client X509.