Aracılığıyla paylaş

Devices - Create Or Update Identity

  • Başvuru
Service:
IoT Hub
API Version:
2021-04-12

IoT Hub kimlik kayıt defterinde bir cihazın kimliğini oluşturur veya güncelleştirir.

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

URI Parametreleri

Name İçinde Gerekli Tür Description
id
 path True

string

Cihazın benzersiz tanımlayıcısı.
api-version
 query True

string

Api sürümü.

İstek Başlığı

Name Gerekli Tür Description
If-Match

string

RFC7232 göre cihaz kimliği için zayıf bir ETag'i temsil eden dize. Bu ayar cihaz oluşturulurken ayarlanmamalıdır, ancak bir cihaz güncelleştirilirken ayarlanabilir.

İstek Gövdesi

Name Tür Description
authentication

AuthenticationMechanism

Cihaz tarafından kullanılan kimlik doğrulama mekanizması.
capabilities

DeviceCapabilities

Cihazın özellik kümesi. Örneğin, bu cihaz bir uç cihazsa veya değilse.
cloudToDeviceMessageCount

integer

Şu anda cihaza gönderilmek üzere kuyruğa alınan buluttan cihaza ileti sayısı.
connectionState enum:
  • Disconnected
  • Connected

Cihazın durumu.
connectionStateUpdatedTime

string

Bağlantı durumunun son güncelleştirildiği tarih ve saat.
deviceId

string

Cihazın benzersiz tanımlayıcısı.
deviceScope

string

Cihazın kapsamı. Uç cihazlar için otomatik olarak oluşturulan ve sabit olan ve alt/üst ilişki oluşturmak için yaprak cihazlarda değiştirilebilir.
etag

string

RFC7232 göre cihaz kimliği için zayıf bir ETag'i temsil eden dize.
generationId

string

en fazla 128 karakter uzunluğunda IoT Hub oluşturulan büyük/küçük harfe duyarlı dize. Bu değer, silinip yeniden oluşturulduklarında aynı deviceId değerine sahip cihazları ayırt etmek için kullanılır.
lastActivityTime

string

Cihazın son bağlanma, alma veya ileti gönderme tarihi ve son zamanı.
parentScopes

string[]

Varsa üst düzey uç cihazların kapsamları. Yalnızca uç cihazlarda kullanılabilir.
status enum:
  • enabled
  • disabled

Cihazın durumu. Durum devre dışı bırakılırsa cihaz hizmete bağlanamaz.
statusReason

string

Cihaz kimliği durumunun nedenini depolayan 128 karakter uzunluğunda dize. Tüm UTF-8 karakterlerine izin verilir.
statusUpdatedTime

string

Durum alanının son güncelleştirildiği tarih ve saat.

Yanıtlar

Name Tür Description
200 OK

Device

Tamam ögesini seçin.

Tanımlar

Name Description
AuthenticationMechanism
Device
DeviceCapabilities

Cihazda etkinleştirilen özelliklerin durumu.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Name Tür Description
symmetricKey

SymmetricKey

SAS tabanlı kimlik doğrulaması için kullanılan birincil ve ikincil anahtarlar.
type enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Hizmete bağlanmak için kullanılan kimlik doğrulama türü.
x509Thumbprint

X509Thumbprint

x509 tabanlı kimlik doğrulaması için kullanılan birincil ve ikincil x509 parmak izleri.

Device

Name Tür Description
authentication

AuthenticationMechanism

Cihaz tarafından kullanılan kimlik doğrulama mekanizması.
capabilities

DeviceCapabilities

Cihazın özellik kümesi. Örneğin, bu cihaz bir uç cihazsa veya değilse.
cloudToDeviceMessageCount

integer

Şu anda cihaza gönderilmek üzere kuyruğa alınan buluttan cihaza ileti sayısı.
connectionState enum:
  • Connected
  • Disconnected

Cihazın durumu.
connectionStateUpdatedTime

string

Bağlantı durumunun son güncelleştirildiği tarih ve saat.
deviceId

string

Cihazın benzersiz tanımlayıcısı.
deviceScope

string

Cihazın kapsamı. Uç cihazlar için otomatik olarak oluşturulan ve sabit olan ve alt/üst ilişki oluşturmak için yaprak cihazlarda değiştirilebilir.
etag

string

RFC7232 göre cihaz kimliği için zayıf bir ETag'i temsil eden dize.
generationId

string

en fazla 128 karakter uzunluğunda IoT Hub oluşturulan büyük/küçük harfe duyarlı dize. Bu değer, silinip yeniden oluşturulduklarında aynı deviceId değerine sahip cihazları ayırt etmek için kullanılır.
lastActivityTime

string

Cihazın son bağlanma, alma veya ileti gönderme tarihi ve son zamanı.
parentScopes

string[]

Varsa üst düzey uç cihazların kapsamları. Yalnızca uç cihazlarda kullanılabilir.
status enum:
  • disabled
  • enabled

Cihazın durumu. Durum devre dışı bırakılırsa cihaz hizmete bağlanamaz.
statusReason

string

Cihaz kimliği durumunun nedenini depolayan 128 karakter uzunluğunda dize. Tüm UTF-8 karakterlerine izin verilir.
statusUpdatedTime

string

Durum alanının son güncelleştirildiği tarih ve saat.

DeviceCapabilities

Cihazda etkinleştirilen özelliklerin durumu.

Name Tür Description
iotEdge

boolean

Cihazın bir uç cihaz olup olmadığını belirleyen özellik.

SymmetricKey

Name Tür Description
primaryKey

string

Cihazın base64 ile kodlanmış birincil anahtarı.
secondaryKey

string

Cihazın base64 kodlanmış ikincil anahtarı.

X509Thumbprint

Name Tür Description
primaryThumbprint

string

X509 istemci sertifikası birincil parmak izi.
secondaryThumbprint

string

X509 istemci sertifikası ikincil parmak izi.