Devices - Get Devices

Tjänst:

IoT Hub

API-version:

2021-04-12

Hämtar identiteterna för flera enheter från IoT Hub-identitetsregistret. Rekommenderas inte. Använd IoT Hub-fråge-API:et för att hämta information om enhetstvillingar och enhetsidentitet. Mer information finns i https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub och https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language.

GET https://fully-qualified-iothubname.azure-devices.net/devices?api-version=2021-04-12

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
api-version	query	True	string	Version av API:et.
top	query		integer (int32)	Det maximala antalet enhetsidentiteter som returneras av frågan. Alla värden utanför intervallet 1–1 000 anses vara 1 000.

Svar

Name	Typ	Description
200 OK	Device[]	OKEJ.

Definitioner

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

AuthenticationMechanism

Objekt

Name	Typ	Description
symmetricKey	SymmetricKey	De primära och sekundära nycklar 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

Objekt

Name	Typ	Description
authentication	AuthenticationMechanism	Den autentiseringsmekanism som används av enheten.
capabilities	DeviceCapabilities	Enhetens uppsättning funktioner. Om den här enheten till exempel är en gränsenhet eller inte.
cloudToDeviceMessageCount	integer (int32)	Antalet moln-till-enhet-meddelanden som för närvarande placeras i kö för att skickas till enheten.
connectionState	enum: Connected Disconnected	Enhetens tillstånd.
connectionStateUpdatedTime	string (date-time)	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 (date-time)	Datum och sista gången enheten senast anslöt, tog emot eller skickade ett meddelande.
parentScopes	string[]	Omfången för de övre gränsenheterna om tillämpligt. Endast tillgängligt för gränsenheter.
status	enum: disabled enabled	Enhetens status. Om statusen är inaktiverad kan en enhet 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 (date-time)	Datum och tid då statusfältet senast uppdaterades.

DeviceCapabilities

Objekt

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

Objekt

Name	Typ	Description
primaryKey	string	Den base64-kodade primärnyckeln för enheten.
secondaryKey	string	Enhetens base64-kodade sekundära nyckel.

X509Thumbprint

Objekt

Name	Typ	Description
primaryThumbprint	string	X509-klientcertifikatets primära tumavtryck.
secondaryThumbprint	string	X509-klientcertifikatets sekundära tumavtryck.