Devices - Create Or Update Identity

Service:

IoT Hub

API-versie:

2021-04-12

Hiermee wordt de identiteit van een apparaat gemaakt of bijgewerkt in het identiteitsregister van de IoT Hub.

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

URI-parameters

Name	In	Vereist	Type	Description
id	path	True	string	De unieke id van het apparaat.
api-version	query	True	string	Versie van de API.

Aanvraagkoptekst

Name	Vereist	Type	Description
If-Match		string	De tekenreeks die een zwakke ETag voor de apparaat-id vertegenwoordigt, volgens RFC7232. Dit moet niet worden ingesteld bij het maken van een apparaat, maar kan worden ingesteld bij het bijwerken van een apparaat.

Aanvraagbody

Name	Type	Description
authentication	AuthenticationMechanism	Het verificatiemechanisme dat door het apparaat wordt gebruikt.
capabilities	DeviceCapabilities	De set mogelijkheden van het apparaat. Als dit apparaat bijvoorbeeld een edge-apparaat is of niet.
cloudToDeviceMessageCount	integer	Het aantal cloud-naar-apparaat-berichten dat momenteel in de wachtrij staat om naar het apparaat te worden verzonden.
connectionState	enum: Disconnected Connected	De status van het apparaat.
connectionStateUpdatedTime	string	De datum en tijd waarop de verbindingsstatus voor het laatst is bijgewerkt.
deviceId	string	De unieke id van het apparaat.
deviceScope	string	Het bereik van het apparaat. Automatisch gegenereerd en onveranderbaar voor edge-apparaten en kan worden gewijzigd in leaf-apparaten om een onderliggende/bovenliggende relatie te maken.
etag	string	De tekenreeks die een zwakke ETag voor de apparaat-id vertegenwoordigt, volgens RFC7232.
generationId	string	De IoT Hub gegenereerde, hoofdlettergevoelige tekenreeks met een lengte van maximaal 128 tekens. Deze waarde wordt gebruikt om apparaten met dezelfde deviceId te onderscheiden wanneer ze zijn verwijderd en opnieuw zijn gemaakt.
lastActivityTime	string	De datum en laatste keer dat het apparaat voor het laatst verbinding heeft gemaakt, een bericht heeft ontvangen of verzonden.
parentScopes	string[]	De bereiken van de edge-apparaten op het bovenste niveau, indien van toepassing. Alleen beschikbaar voor edge-apparaten.
status	enum: enabled disabled	De status van het apparaat. Als de status is uitgeschakeld, kan een apparaat geen verbinding maken met de service.
statusReason	string	De tekenreeks van 128 tekens lang waarin de reden voor de status van de apparaat-id wordt opgeslagen. Alle UTF-8-tekens zijn toegestaan.
statusUpdatedTime	string	De datum en tijd waarop het statusveld voor het laatst is bijgewerkt.

Antwoorden

Name	Type	Description
200 OK	Device	OK.

Definities

Name	Description
AuthenticationMechanism
Device
DeviceCapabilities	De status van de mogelijkheden die zijn ingeschakeld op het apparaat.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Name	Type	Description
symmetricKey	SymmetricKey	De primaire en secundaire sleutels die worden gebruikt voor verificatie op basis van SAS.
type	enum: certificateAuthority none sas selfSigned	Het type verificatie dat wordt gebruikt om verbinding te maken met de service.
x509Thumbprint	X509Thumbprint	De primaire en secundaire x509-vingerafdrukken die worden gebruikt voor x509-verificatie.

Device

Name	Type	Description
authentication	AuthenticationMechanism	Het verificatiemechanisme dat door het apparaat wordt gebruikt.
capabilities	DeviceCapabilities	De set mogelijkheden van het apparaat. Als dit apparaat bijvoorbeeld een edge-apparaat is of niet.
cloudToDeviceMessageCount	integer	Het aantal cloud-naar-apparaat-berichten dat momenteel in de wachtrij staat om naar het apparaat te worden verzonden.
connectionState	enum: Connected Disconnected	De status van het apparaat.
connectionStateUpdatedTime	string	De datum en tijd waarop de verbindingsstatus voor het laatst is bijgewerkt.
deviceId	string	De unieke id van het apparaat.
deviceScope	string	Het bereik van het apparaat. Automatisch gegenereerd en onveranderbaar voor edge-apparaten en kan worden gewijzigd in leaf-apparaten om een onderliggende/bovenliggende relatie te maken.
etag	string	De tekenreeks die een zwakke ETag voor de apparaat-id vertegenwoordigt, volgens RFC7232.
generationId	string	De IoT Hub gegenereerde, hoofdlettergevoelige tekenreeks met een lengte van maximaal 128 tekens. Deze waarde wordt gebruikt om apparaten met dezelfde deviceId te onderscheiden wanneer ze zijn verwijderd en opnieuw zijn gemaakt.
lastActivityTime	string	De datum en laatste keer dat het apparaat voor het laatst verbinding heeft gemaakt, een bericht heeft ontvangen of verzonden.
parentScopes	string[]	De bereiken van de edge-apparaten op het bovenste niveau, indien van toepassing. Alleen beschikbaar voor edge-apparaten.
status	enum: disabled enabled	De status van het apparaat. Als de status is uitgeschakeld, kan een apparaat geen verbinding maken met de service.
statusReason	string	De tekenreeks van 128 tekens lang waarin de reden voor de status van de apparaat-id wordt opgeslagen. Alle UTF-8-tekens zijn toegestaan.
statusUpdatedTime	string	De datum en tijd waarop het statusveld voor het laatst is bijgewerkt.

DeviceCapabilities

De status van de mogelijkheden die zijn ingeschakeld op het apparaat.

Name	Type	Description
iotEdge	boolean	De eigenschap die bepaalt of het apparaat een edge-apparaat is of niet.

SymmetricKey

Name	Type	Description
primaryKey	string	De met base64 gecodeerde primaire sleutel van het apparaat.
secondaryKey	string	De met base64 gecodeerde secundaire sleutel van het apparaat.

X509Thumbprint

Name	Type	Description
primaryThumbprint	string	De primaire vingerafdruk van het X509-clientcertificaat.
secondaryThumbprint	string	De secundaire vingerafdruk van het X509-clientcertificaat.