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 參數

名稱	位於	必要	類型	Description
api-version	query	True	string	Api 的版本。
top	query		integer (int32)	查詢所傳回的裝置身分識別數目上限。超出 1-1000 範圍的任何值都會被視為 1000。

名稱	類型	Description
200 OK	Device[]	正常。

Object

名稱	類型	Description
symmetricKey	SymmetricKey	用於 SAS 型驗證的主要和次要金鑰。
type	enum: certificateAuthority none sas selfSigned	用來連線至服務的驗證類型。
x509Thumbprint	X509Thumbprint	用於 x509 型驗證的主要和次要 x509 指紋。

Object

名稱	類型	Description
authentication	AuthenticationMechanism	裝置所使用的驗證機制。
capabilities	DeviceCapabilities	裝置的功能集。例如，如果此裝置是邊緣裝置，則為。
cloudToDeviceMessageCount	integer (int32)	目前佇列要傳送至裝置的雲端到裝置訊息數目。
connectionState	enum: Connected Disconnected	裝置的狀態。
connectionStateUpdatedTime	string (date-time)	上次更新連線狀態的日期和時間。
deviceId	string	裝置的唯一識別碼。
deviceScope	string	裝置的範圍。針對邊緣裝置自動產生和不可變，並可在分葉裝置中修改，以建立子/父關聯性。
etag	string	根據RFC7232，代表裝置身分識別的弱式 ETag 字串。
generationId	string	IoT 中樞產生的區分大小寫字串，長度上限為 128 個字元。刪除並重新建立具有相同 deviceID 的裝置時，該值用於區分它們。
lastActivityTime	string (date-time)	裝置上次連線、接收或傳送訊息的日期和時間。
parentScopes	string[]	如果適用，則為上層邊緣裝置的範圍。僅適用於邊緣裝置。
status	enum: disabled enabled	裝置的狀態。如果狀態已停用，裝置就無法連線到服務。
statusReason	string	儲存裝置身分識別狀態原因的 128 個字元長字串。允許所有 UTF-8 字元。
statusUpdatedTime	string (date-time)	上次更新狀態欄位的日期和時間。

Object

裝置上啟用的功能狀態。

名稱	類型	Description
iotEdge	boolean	屬性，判斷裝置是否為邊緣裝置。

Object

名稱	類型	Description
primaryKey	string	裝置的base64編碼主鍵。
secondaryKey	string	裝置的base64編碼次要金鑰。

Object

名稱	類型	Description
primaryThumbprint	string	X509 用戶端憑證主要指紋。
secondaryThumbprint	string	X509 用戶端憑證次要指紋。