Delen via

Devices - Get Devices

Service:
IoT Hub
API-versie:
2021-04-12

Haalt de identiteiten van meerdere apparaten op uit het IoT Hub-identiteitsregister. Niet aanbevolen. Gebruik de IoT Hub-query-API om apparaatdubbel- en apparaatidentiteitsgegevens op te halen. Zie https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub en https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language voor meer informatie.

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

URI-parameters

Name In Vereist Type Description
api-version
 query True

string

Versie van de API.
top
 query

integer (int32)

Het maximum aantal apparaat-id's dat door de query wordt geretourneerd. Elke waarde buiten het bereik van 1-1000 wordt beschouwd als 1000.

Antwoorden

Name Type Description
200 OK

Device[]

OK.

Definities

Name Description
AuthenticationMechanism
Device
DeviceCapabilities

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

AuthenticationMechanism

Object
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 verificatie op basis van x509.

Device

Object
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 (int32)

Het aantal cloud-naar-apparaat-berichten dat momenteel in de wachtrij wordt geplaatst om naar het apparaat te worden verzonden.
connectionState enum:
  • Connected
  • Disconnected

De status van het apparaat.
connectionStateUpdatedTime

string (date-time)

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 onderliggende/bovenliggende relatie te maken.
etag

string

De tekenreeks die een zwakke ETag vertegenwoordigt voor de apparaat-id, volgens RFC7232.
generationId

string

De door IoT Hub gegenereerde, hoofdlettergevoelige tekenreeks tot 128 tekens lang. Deze waarde wordt gebruikt om apparaten te onderscheiden met dezelfde deviceId wanneer ze zijn verwijderd en opnieuw zijn gemaakt.
lastActivityTime

string (date-time)

De datum en laatste keer dat het apparaat voor het laatst is verbonden, ontvangen of een bericht heeft verzonden.
parentScopes

string[]

De bereiken van de edge-apparaten op het hoogste 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 die de reden voor de status van de apparaat-id opslaat. Alle UTF-8 tekens zijn toegestaan.
statusUpdatedTime

string (date-time)

De datum en tijd waarop het statusveld voor het laatst is bijgewerkt.

DeviceCapabilities

Object

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

Name Type Description
iotEdge

boolean

De eigenschap die bepaalt of het apparaat een edge-apparaat is of niet.

SymmetricKey

Object
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

Object
Name Type Description
primaryThumbprint

string

De primaire vingerafdruk van het X509-clientcertificaat.
secondaryThumbprint

string

De secundaire vingerafdruk van het X509-clientcertificaat.