你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Devices - Get Devices

从IoT 中心标识注册表中获取多个设备的标识。建议不要使用。使用IoT 中心查询 API 检索设备孪生和设备标识信息。有关更多信息，请参见https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub和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-12

具有可选参数:

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

URI 参数

名称	在	必需	类型	说明
api-version	query	True	string	Api 的版本。
top	query		integer int32	查询返回的最大设备标识数。超出 1-1000 范围的任何值都被视为 1000。

名称	类型	说明
200 OK	Device[]	没问题。

名称	类型	说明
symmetricKey	SymmetricKey	用于基于 SAS 的身份验证的主密钥和辅助密钥。
type	enum: certificateAuthority none sas selfSigned	用于连接到服务的身份验证类型。
x509Thumbprint	X509Thumbprint	用于基于 x509 的身份验证的主要和辅助 x509 指纹。

名称	类型	说明
authentication	AuthenticationMechanism	设备使用的身份验证机制。
capabilities	DeviceCapabilities	设备的功能集。例如，如果此设备是否为边缘设备。
cloudToDeviceMessageCount	integer	当前排队要发送到设备的云到设备消息数。
connectionState	enum: Connected Disconnected	设备的状态。
connectionStateUpdatedTime	string	上次更新连接状态的日期和时间。
deviceId	string	设备的唯一标识符。
deviceScope	string	设备的范围。为边缘设备自动生成且不可变，在叶设备中可修改以创建子/父关系。
etag	string	表示设备标识的弱 ETag 的字符串，根据 RFC7232。
generationId	string	IoT 中心生成的区分大小写的字符串，最长为 128 个字符。在删除并重新创建设备时，此值用于区分具有相同 deviceId的设备。
lastActivityTime	string	设备上次连接、接收或发送消息的日期和时间。
parentScopes	string[]	上层边缘设备的范围（如果适用）。仅适用于边缘设备。
status	enum: disabled enabled	设备的状态。如果状态已禁用，则设备无法连接到服务。
statusReason	string	存储设备标识状态原因的 128 字符长字符串。允许所有 UTF-8 字符。
statusUpdatedTime	string	状态字段上次更新的日期和时间。

设备上启用的功能的状态。

名称	类型	说明
iotEdge	boolean	确定设备是否为边缘设备的属性。

名称	类型	说明
primaryKey	string	设备的 base64 编码主键。
secondaryKey	string	设备的 base64 编码辅助密钥。

名称	类型	说明
primaryThumbprint	string	X509 客户端证书主指纹。
secondaryThumbprint	string	X509 客户端证书辅助指纹。