Devices - Create Or Update Identity

Tjänst:

IoT Hub

API-version:

2021-04-12

Skapar eller uppdaterar identiteten för en enhet i identitetsregistret för IoT Hub.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
id	path	True	string	Enhetens unika identifierare.
api-version	query	True	string	Version av API:et.

Begärandehuvud

Name	Obligatorisk	Typ	Description
If-Match		string	Strängen som representerar en svag ETag för enhetsidentiteten enligt RFC7232. Detta bör inte anges när du skapar en enhet, men kan anges när du uppdaterar en enhet.

Begärandetext

Name	Typ	Description
authentication	AuthenticationMechanism	Autentiseringsmekanismen som används av enheten.
capabilities	DeviceCapabilities	Uppsättningen funktioner för enheten. Om den här enheten till exempel är en gränsenhet eller inte.
cloudToDeviceMessageCount	integer	Antalet meddelanden från moln till enhet som för närvarande ska skickas till enheten.
connectionState	enum: Disconnected Connected	Enhetens tillstånd.
connectionStateUpdatedTime	string	Datum och tid då anslutningstillståndet senast uppdaterades.
deviceId	string	Enhetens unika identifierare.
deviceScope	string	Enhetens omfång. Automatiskt genererad och oföränderlig för gränsenheter och kan ändras i lövenheter för att skapa en underordnad/överordnad relation.
etag	string	Strängen som representerar en svag ETag för enhetsidentiteten enligt RFC7232.
generationId	string	Den IoT Hub genererade skiftlägeskänsliga strängen upp till 128 tecken lång. Det här värdet används för att särskilja enheter med samma deviceId när de har tagits bort och återskapats.
lastActivityTime	string	Datum och senaste gången enheten senast anslöt, tog emot eller skickade ett meddelande.
parentScopes	string[]	Omfången för gränsenheterna på den övre nivån om tillämpligt. Endast tillgängligt för gränsenheter.
status	enum: enabled disabled	Enhetens status. Om statusen är inaktiverad kan enheten inte ansluta till tjänsten.
statusReason	string	Den 128 tecken långa strängen som lagrar orsaken till enhetens identitetsstatus. Alla UTF-8 tecken tillåts.
statusUpdatedTime	string	Datum och tid då statusfältet senast uppdaterades.

Svar

Name	Typ	Description
200 OK	Device	OK.

Definitioner

Name	Description
AuthenticationMechanism
Device
DeviceCapabilities	Status för funktioner som är aktiverade på enheten.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Name	Typ	Description
symmetricKey	SymmetricKey	De primära och sekundära nycklarna som används för SAS-baserad autentisering.
type	enum: certificateAuthority none sas selfSigned	Den typ av autentisering som används för att ansluta till tjänsten.
x509Thumbprint	X509Thumbprint	De primära och sekundära x509-tumavtrycken som används för x509-baserad autentisering.

Device

Name	Typ	Description
authentication	AuthenticationMechanism	Autentiseringsmekanismen som används av enheten.
capabilities	DeviceCapabilities	Uppsättningen funktioner för enheten. Om den här enheten till exempel är en gränsenhet eller inte.
cloudToDeviceMessageCount	integer	Antalet meddelanden från moln till enhet som för närvarande ska skickas till enheten.
connectionState	enum: Connected Disconnected	Enhetens tillstånd.
connectionStateUpdatedTime	string	Datum och tid då anslutningstillståndet senast uppdaterades.
deviceId	string	Enhetens unika identifierare.
deviceScope	string	Enhetens omfång. Automatiskt genererad och oföränderlig för gränsenheter och kan ändras i lövenheter för att skapa en underordnad/överordnad relation.
etag	string	Strängen som representerar en svag ETag för enhetsidentiteten enligt RFC7232.
generationId	string	Den IoT Hub genererade skiftlägeskänsliga strängen upp till 128 tecken lång. Det här värdet används för att särskilja enheter med samma deviceId när de har tagits bort och återskapats.
lastActivityTime	string	Datum och senaste gången enheten senast anslöt, tog emot eller skickade ett meddelande.
parentScopes	string[]	Omfången för gränsenheterna på den övre nivån om tillämpligt. Endast tillgängligt för gränsenheter.
status	enum: disabled enabled	Enhetens status. Om statusen är inaktiverad kan enheten inte ansluta till tjänsten.
statusReason	string	Den 128 tecken långa strängen som lagrar orsaken till enhetens identitetsstatus. Alla UTF-8 tecken tillåts.
statusUpdatedTime	string	Datum och tid då statusfältet senast uppdaterades.

DeviceCapabilities

Status för funktioner som är aktiverade på enheten.

Name	Typ	Description
iotEdge	boolean	Egenskapen som avgör om enheten är en gränsenhet eller inte.

SymmetricKey

Name	Typ	Description
primaryKey	string	Enhetens base64-kodade primärnyckel.
secondaryKey	string	Enhetens base64-kodade sekundära nyckel.

X509Thumbprint

Name	Typ	Description
primaryThumbprint	string	X509-klientcertifikatets primära tumavtryck.
secondaryThumbprint	string	Det sekundära tumavtrycket för X509-klientcertifikatet.