Devices - Get Devices
Hiermee haalt u de identiteiten van meerdere apparaten op uit het IoT Hub-id-register. Niet aanbevolen. Gebruik de IoT Hub query-API om informatie over apparaatdubbels en apparaat-id's 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
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 apparaatidentiteiten 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 |
---|---|
Authentication |
|
Device | |
Device |
De status van de mogelijkheden die zijn ingeschakeld op het apparaat. |
Symmetric |
|
X509Thumbprint |
AuthenticationMechanism
Name | Type | Description |
---|---|---|
symmetricKey |
De primaire en secundaire sleutels die worden gebruikt voor verificatie op basis van SAS. |
|
type |
enum:
|
Het type verificatie dat wordt gebruikt om verbinding te maken met de service. |
x509Thumbprint |
De primaire en secundaire x509-vingerafdrukken die worden gebruikt voor x509-verificatie. |
Device
Name | Type | Description |
---|---|---|
authentication |
Het verificatiemechanisme dat door het apparaat wordt gebruikt. |
|
capabilities |
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:
|
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:
|
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. |