Devices - Get Devices
IoT Hub ID レジストリから複数のデバイスの ID を取得します。 非推奨。 IoT Hub クエリ API を使用して、デバイス ツインとデバイス ID 情報を取得します。 詳細については、「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 |
クエリによって返されるデバイス ID の最大数。 1 から 1000 の範囲外の値は 1000 と見なされます。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
Device[] |
OK です。 |
定義
名前 | 説明 |
---|---|
Authentication |
|
Device | |
Device |
デバイスで有効になっている機能の状態。 |
Symmetric |
|
X509Thumbprint |
AuthenticationMechanism
名前 | 型 | 説明 |
---|---|---|
symmetricKey |
SAS ベースの認証に使用されるプライマリ キーとセカンダリ キー。 |
|
type |
enum:
|
サービスへの接続に使用される認証の種類。 |
x509Thumbprint |
x509 ベースの認証に使用されるプライマリとセカンダリの x509 拇印。 |
Device
名前 | 型 | 説明 |
---|---|---|
authentication |
デバイスで使用される認証メカニズム。 |
|
capabilities |
デバイスの一連の機能。 たとえば、このデバイスがエッジ デバイスであるかどうかを示します。 |
|
cloudToDeviceMessageCount |
integer |
デバイスに送信される現在キューに登録されているクラウドからデバイスへのメッセージの数。 |
connectionState |
enum:
|
デバイスの状態。 |
connectionStateUpdatedTime |
string |
接続状態が最後に更新された日時。 |
deviceId |
string |
デバイスの一意識別子。 |
deviceScope |
string |
デバイスのスコープ。 エッジ デバイスに対して自動生成および変更不可。リーフ デバイスで変更可能で、子/親リレーションシップを作成できます。 |
etag |
string |
RFC7232に従って、デバイス ID の弱い ETag を表す文字列。 |
generationId |
string |
IoT Hub生成された大文字と小文字を区別する文字列 (最大 128 文字)。 この値は、デバイスが削除されて再作成された場合に、同じ deviceId を持つデバイスを区別するために使用します。 |
lastActivityTime |
string |
デバイスが最後に接続、受信、またはメッセージを送信した日時。 |
parentScopes |
string[] |
該当する場合は、上位レベルのエッジ デバイスのスコープ。 エッジ デバイスでのみ使用できます。 |
status |
enum:
|
デバイスの状態。 状態が無効になっている場合、デバイスはサービスに接続できません。 |
statusReason |
string |
デバイス ID の状態の理由を格納する 128 文字の長い文字列。 すべての UTF-8 文字を使用できます。 |
statusUpdatedTime |
string |
状態フィールドが最後に更新された日時。 |
DeviceCapabilities
デバイスで有効になっている機能の状態。
名前 | 型 | 説明 |
---|---|---|
iotEdge |
boolean |
デバイスがエッジ デバイスかどうかを決定する プロパティ。 |
SymmetricKey
名前 | 型 | 説明 |
---|---|---|
primaryKey |
string |
デバイスの base64 でエンコードされた主キー。 |
secondaryKey |
string |
デバイスの base64 でエンコードされたセカンダリ キー。 |
X509Thumbprint
名前 | 型 | 説明 |
---|---|---|
primaryThumbprint |
string |
X509 クライアント証明書のプライマリ拇印。 |
secondaryThumbprint |
string |
X509 クライアント証明書のセカンダリ拇印。 |