Devices - Get Devices
Obtém as identidades de vários dispositivos do registro de identidade Hub IoT. Não recomendado. Use a API de consulta Hub IoT para recuperar informações de identidade do dispositivo gêmeo e do dispositivo. Consulte https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub e https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language para obter mais informações.
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-12Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Versão da API. |
|
top
|
query |
integer int32 |
O número máximo de identidades de dispositivo retornadas pela consulta. Qualquer valor fora do intervalo de 1-1000 é considerado 1000. |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
Device[] |
OK. |
Definições
| Nome | Description |
|---|---|
|
Authentication |
|
| Device | |
|
Device |
O status de recursos habilitados no dispositivo. |
|
Symmetric |
|
| X509Thumbprint |
AuthenticationMechanism
| Nome | Tipo | Description |
|---|---|---|
| symmetricKey |
As chaves primárias e secundárias usadas para autenticação baseada em SAS. |
|
| type |
enum:
|
O tipo de autenticação usado para se conectar ao serviço. |
| x509Thumbprint |
As impressões digitais x509 primárias e secundárias usadas para autenticação baseada em x509. |
Device
| Nome | Tipo | Description |
|---|---|---|
| authentication |
O mecanismo de autenticação usado pelo dispositivo. |
|
| capabilities |
O conjunto de recursos do dispositivo. Por exemplo, se este dispositivo for um dispositivo de borda ou não. |
|
| cloudToDeviceMessageCount |
integer |
O número de mensagens da nuvem para o dispositivo atualmente enfileiradas para serem enviadas ao dispositivo. |
| connectionState |
enum:
|
O estado do dispositivo. |
| connectionStateUpdatedTime |
string |
A data e a hora em que o estado da conexão foi atualizado pela última vez. |
| deviceId |
string |
O identificador exclusivo do dispositivo. |
| deviceScope |
string |
O escopo do dispositivo. Gerado automaticamente e imutável para dispositivos de borda e modificável em dispositivos folha para criar uma relação filho/pai. |
| etag |
string |
A cadeia de caracteres que representa uma ETag fraca para a identidade do dispositivo, de acordo com RFC7232. |
| generationId |
string |
A cadeia de caracteres com diferenciação de maiúsculas e minúsculas gerada por Hub IoT até 128 caracteres. Esse valor é usado para distinguir os dispositivos com a mesma deviceId quando são excluídos e recriados. |
| lastActivityTime |
string |
A data e a última vez em que o dispositivo se conectou, recebeu ou enviou uma mensagem pela última vez. |
| parentScopes |
string[] |
Os escopos dos dispositivos de borda de nível superior, se aplicável. Disponível somente para dispositivos de borda. |
| status |
enum:
|
O status do dispositivo. Se o status desabilitado, um dispositivo não poderá se conectar ao serviço. |
| statusReason |
string |
A cadeia de caracteres de 128 caracteres que armazena o motivo da identidade do dispositivo status. Todos os caracteres UTF-8 são permitidos. |
| statusUpdatedTime |
string |
A data e a hora em que o campo status foi atualizado pela última vez. |
DeviceCapabilities
O status de recursos habilitados no dispositivo.
| Nome | Tipo | Description |
|---|---|---|
| iotEdge |
boolean |
A propriedade que determina se o dispositivo é um dispositivo de borda ou não. |
SymmetricKey
| Nome | Tipo | Description |
|---|---|---|
| primaryKey |
string |
A chave primária codificada em base64 do dispositivo. |
| secondaryKey |
string |
A chave secundária codificada em base64 do dispositivo. |
X509Thumbprint
| Nome | Tipo | Description |
|---|---|---|
| primaryThumbprint |
string |
A impressão digital primária do certificado do cliente X509. |
| secondaryThumbprint |
string |
A impressão digital secundária do certificado do cliente X509. |