Devices - Get Devices
Získá identity více zařízení z registru identit IoT Hub. Nedoporučuje se. Pomocí rozhraní API pro dotazy IoT Hub načtěte informace o identitě zařízení a dvojčete zařízení. Další informace najdete v tématu https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub a 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-12GET https://fully-qualified-iothubname.azure-devices.net/devices?top={top}&api-version=2021-04-12Parametry identifikátoru URI
| Name | V | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Verze rozhraní API. |
|
top
|
query |
integer int32 |
Maximální počet identit zařízení vrácených dotazem Jakákoli hodnota mimo rozsah 1–1000 se považuje za 1000. |
Odpovědi
| Name | Typ | Description |
|---|---|---|
| 200 OK |
Device[] |
OK. |
Definice
| Name | Description |
|---|---|
|
Authentication |
|
| Device | |
|
Device |
Stav funkcí povolených v zařízení. |
|
Symmetric |
|
| X509Thumbprint |
AuthenticationMechanism
| Name | Typ | Description |
|---|---|---|
| symmetricKey |
Primární a sekundární klíč používaný pro ověřování na základě SAS. |
|
| type |
enum:
|
Typ ověřování, který se používá pro připojení ke službě. |
| x509Thumbprint |
Primární a sekundární kryptografické otisky x509 používané pro ověřování na základě x509. |
Device
| Name | Typ | Description |
|---|---|---|
| authentication |
Mechanismus ověřování používaný zařízením. |
|
| capabilities |
Sada možností zařízení. Například jestli je toto zařízení hraničním zařízením nebo ne. |
|
| cloudToDeviceMessageCount |
integer |
Počet zpráv typu cloud-zařízení aktuálně zařazených do fronty, které se mají odeslat do zařízení. |
| connectionState |
enum:
|
Stav zařízení. |
| connectionStateUpdatedTime |
string |
Datum a čas poslední aktualizace stavu připojení |
| deviceId |
string |
Jedinečný identifikátor zařízení. |
| deviceScope |
string |
Rozsah zařízení. Automaticky vygenerované a neměnné pro hraniční zařízení a upravitelné v zařízeních typu list za účelem vytvoření vztahu podřízenosti a nadřazenosti |
| etag |
string |
Řetězec představující slabou značku ETag pro identitu zařízení podle RFC7232. |
| generationId |
string |
Řetězec vygenerovaný IoT Hub s rozlišováním velkých a malých písmen o délce až 128 znaků. Tato hodnota se používá k rozlišení zařízení se stejným id zařízení, když byla odstraněna a znovu vytvořena. |
| lastActivityTime |
string |
Datum a čas, kdy se zařízení naposledy připojilo, přijalo nebo odeslalo zprávu. |
| parentScopes |
string[] |
Rozsahy hraničních zařízení horní úrovně, pokud jsou k dispozici. K dispozici pouze pro hraniční zařízení. |
| status |
enum:
|
Stav zařízení. Pokud je stav zakázaný, zařízení se nemůže ke službě připojit. |
| statusReason |
string |
Řetězec dlouhý 128 znaků, ve kterém je uložen důvod stavu identity zařízení. Jsou povoleny všechny znaky UTF-8. |
| statusUpdatedTime |
string |
Datum a čas, kdy bylo pole stavu naposledy aktualizováno. |
DeviceCapabilities
Stav funkcí povolených v zařízení.
| Name | Typ | Description |
|---|---|---|
| iotEdge |
boolean |
Vlastnost, která určuje, jestli je zařízení hraničním zařízením, nebo ne. |
SymmetricKey
| Name | Typ | Description |
|---|---|---|
| primaryKey |
string |
Primární klíč zařízení kódovaný jako base64. |
| secondaryKey |
string |
Sekundární klíč zařízení kódovaný jako base64. |
X509Thumbprint
| Name | Typ | Description |
|---|---|---|
| primaryThumbprint |
string |
Primární kryptografický otisk klientského certifikátu X509. |
| secondaryThumbprint |
string |
Sekundární kryptografický otisk klientského certifikátu X509. |