Query - Get Twins

Hizmet:

IoT Hub

API Sürümü:

2021-04-12

SQL benzeri bir dil kullanarak cihaz ikizleri ile ilgili bilgileri almak için bir IoT Hub sorgula. Daha fazla bilgi edinmek için bkz. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language. Sayfalandırma desteklenir. Bu, yalnızca cihaz ikizleri hakkındaki bilgileri döndürür.

POST https://fully-qualified-iothubname.azure-devices.net/devices/query?api-version=2021-04-12

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
api-version	query	True	string	Api sürümü.

İstek Başlığı

Name	Gerekli	Tür	Description
x-ms-continuation		string	Sonuçların sonraki sayfasını almak için kullanılan devamlılık belirteci.
x-ms-max-item-count		string	Sayfa başına döndürülen en fazla öğe sayısı. Belirtilen değer kabul edilebilir değilse hizmet farklı bir değer kullanabilir.

İstek Gövdesi

Name	Tür	Description
query	string	Sorgu dizesi.

Yanıtlar

Name	Tür	Description
200 OK	Twin[]	Tamam ögesini seçin. Üst Bilgiler x-ms-item-type: string x-ms-continuation: string

Tanımlar

Name	Description
DeviceCapabilities	Cihazda etkinleştirilen özelliklerin durumu.
QuerySpecification	Json sorgu isteği.
Twin	Bir cihaz veya modülün durum bilgileri. Bu, IoT Hub ilgili cihaz/modül kimliği oluşturulduğunda veya silindiğinde örtük olarak oluşturulur ve silinir.
TwinProperties	İkizin istenen ve bildirilen özellikleri. Nesnenin maksimum derinliği 10'dur.
X509Thumbprint

DeviceCapabilities

Cihazda etkinleştirilen özelliklerin durumu.

Name	Tür	Description
iotEdge	boolean	Cihazın bir uç cihaz olup olmadığını belirleyen özellik.

QuerySpecification

Json sorgu isteği.

Name	Tür	Description
query	string	Sorgu dizesi.

Twin

Bir cihaz veya modülün durum bilgileri. Bu, IoT Hub ilgili cihaz/modül kimliği oluşturulduğunda veya silindiğinde örtük olarak oluşturulur ve silinir.

Name	Tür	Description
authenticationType	enum: certificateAuthority none sas selfSigned	Cihaz tarafından kullanılan kimlik doğrulama türü.
capabilities	DeviceCapabilities	Cihazda etkinleştirilen özelliklerin durumu.
cloudToDeviceMessageCount	integer	Gönderilen buluttan cihaza ileti sayısı.
connectionState	enum: Connected Disconnected	Cihazın bağlantı durumu.
deviceEtag	string	RFC7232 göre cihaz için ETag'i temsil eden dize.
deviceId	string	IoT Hub kimlik kayıt defterindeki cihazın benzersiz tanımlayıcısı. ASCII 7 bit alfasayısal karakterlerden oluşan büyük/küçük harfe duyarlı bir dizedir (en fazla 128 karakter uzunluğunda), ve aşağıdaki özel karakterler :{'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
deviceScope	string	Cihazın kapsamı.
etag	string	RFC7232 göre cihaz ikizi için ETag'i temsil eden dize.
lastActivityTime	string	Cihazın en son bağlanıp alındığı veya ileti gönderdiği tarih ve saat. Tarih ve saat UTC olarak ISO8601 tarih saat biçiminde belirtilir; örneğin, 2015-01-28T16:24:48.789Z. Cihaz mesajlaşma işlemlerini gerçekleştirmek için HTTP/1 protokolunu kullanıyorsa bu değer güncelleştirilmez.
moduleId	string	IoT Hub kimlik kayıt defterindeki modülün benzersiz tanımlayıcısı. ASCII 7 bit alfasayısal karakterlerden oluşan büyük/küçük harfe duyarlı bir dizedir (en fazla 128 karakter uzunluğunda), ve aşağıdaki özel karakterler :{'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
parentScopes	string[]	Varsa üst düzey uç cihazların kapsamları. Yalnızca uç cihazlar için kullanılabilir.
properties	TwinProperties	İkizin istenen ve bildirilen özellikleri.
status	enum: disabled enabled	Cihazın etkin durumu. Devre dışı bırakılırsa cihaz hizmete bağlanamaz.
statusReason	string	Varsa cihazın geçerli durumunun nedeni.
statusUpdateTime	string	Cihazın durumunun son güncelleştirildiği tarih ve saat.
tags	object	Çözüm arka ucu tarafından okunan ve yazılan anahtar-değer çiftleri koleksiyonu. Bunlar cihaz uygulamalarına görünmez. Bu anahtarlar UTF-8 kodlamalı, büyük/küçük harfe duyarlı ve en fazla 1 KB uzunluğundadır. İzin verilen karakterler UNICODE denetim karakterlerini (C0 ve C1 kesimleri), '.', '$' ve boşluklarını hariç tutar. Değerler, uzunluğu en fazla 4 KB olan JSON nesneleridir.
version	integer	Etiketler ve istenen özellikler dahil olmak üzere cihaz ikizi sürümü
x509Thumbprint	X509Thumbprint	Cihazın X509 parmak izi.

TwinProperties

İkizin istenen ve bildirilen özellikleri. Nesnenin maksimum derinliği 10'dur.

Name	Tür	Description
desired	object	İstenen özellik anahtar-değer çiftlerinin koleksiyonu. Anahtarlar UTF-8 kodlamalı, büyük/küçük harfe duyarlı ve 1 KB'a kadar uzunluktadır. İzin verilen karakterler UNICODE denetim karakterlerini (C0 ve C1 kesimleri), '.', '$' ve boşluklarını hariç tutar. İstenen porperty değerleri, uzunluğu 4 KB'a kadar olan JSON nesneleridir.
reported	object	Bildirilen özellik anahtar-değer çiftlerinin koleksiyonu. Anahtarlar UTF-8 kodlamalı, büyük/küçük harfe duyarlı ve 1 KB'a kadar uzunluktadır. İzin verilen karakterler UNICODE denetim karakterlerini (C0 ve C1 kesimleri), '.', '$' ve boşluklarını hariç tutar. Bildirilen özellik değerleri, uzunluğu 4 KB'a kadar olan JSON nesneleridir.

X509Thumbprint

Name	Tür	Description
primaryThumbprint	string	X509 istemci sertifikası birincil parmak izi.
secondaryThumbprint	string	X509 istemci sertifikası ikincil parmak izi.