Devices - Get Devices

Serviço:

IoT Hub

Versão da API:

2021-04-12

Obtém as identidades de vários dispositivos a partir do registo de identidade Hub IoT. Não recomendada. Utilize a API de consulta Hub IoT para obter as informações de identidade do dispositivo duplo 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-12

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessá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 devolvidas pela consulta. Qualquer valor fora do intervalo de 1-1000 é considerado 1000.

Respostas

Name	Tipo	Description
200 OK	Device[]	OK.

Definições

Name	Description
AuthenticationMechanism
Device
DeviceCapabilities	O estado das capacidades ativadas no dispositivo.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Name	Tipo	Description
symmetricKey	SymmetricKey	As chaves primárias e secundárias utilizadas para a autenticação baseada em SAS.
type	enum: certificateAuthority none sas selfSigned	O tipo de autenticação utilizado para ligar ao serviço.
x509Thumbprint	X509Thumbprint	Os thumbprints x509 primários e secundários utilizados para autenticação baseada em x509.

Device

Name	Tipo	Description
authentication	AuthenticationMechanism	O mecanismo de autenticação utilizado pelo dispositivo.
capabilities	DeviceCapabilities	O conjunto de capacidades do dispositivo. Por exemplo, se este dispositivo for ou não um dispositivo edge.
cloudToDeviceMessageCount	integer	O número de mensagens da cloud para o dispositivo atualmente em fila para serem enviadas para o dispositivo.
connectionState	enum: Connected Disconnected	O estado do dispositivo.
connectionStateUpdatedTime	string	A data e hora em que o estado da ligação foi atualizado pela última vez.
deviceId	string	O identificador exclusivo do dispositivo.
deviceScope	string	O âmbito do dispositivo. Gerado automaticamente e imutável para dispositivos edge e modificável em dispositivos de folha para criar uma relação subordinada/principal.
etag	string	A cadeia que representa uma ETag fraca para a identidade do dispositivo, de acordo com RFC7232.
generationId	string	A cadeia Hub IoT gerada e sensível às maiúsculas e minúsculas com até 128 carateres. Este valor é utilizado para distinguir dispositivos com o mesmo deviceId, quando foram eliminados e recriados.
lastActivityTime	string	A data e a última vez que o dispositivo ligou, recebeu ou enviou uma mensagem.
parentScopes	string[]	Os âmbitos dos dispositivos edge de nível superior, se aplicável. Apenas disponível para dispositivos edge.
status	enum: disabled enabled	O estado do dispositivo. Se o estado estiver desativado, um dispositivo não poderá ligar-se ao serviço.
statusReason	string	A cadeia de carateres com 128 carateres que armazena o motivo do estado da identidade do dispositivo. Todos os carateres UTF-8 são permitidos.
statusUpdatedTime	string	A data e hora em que o campo de estado foi atualizado pela última vez.

DeviceCapabilities

O estado das capacidades ativadas no dispositivo.

Name	Tipo	Description
iotEdge	boolean	A propriedade que determina se o dispositivo é ou não um dispositivo edge.

SymmetricKey

Name	Tipo	Description
primaryKey	string	A chave primária codificada em base64 do dispositivo.
secondaryKey	string	A chave secundária codificada base64 do dispositivo.

X509Thumbprint

Name	Tipo	Description
primaryThumbprint	string	O thumbprint primário do certificado de cliente X509.
secondaryThumbprint	string	O thumbprint secundário do certificado de cliente X509.