Modules - Create Or Update Identity

Service:

IoT Hub

API Version:

2021-04-12

IoT Hub bir cihaz için modül kimliğini oluşturur veya güncelleştirir. moduleId ve generationId kullanıcı tarafından güncelleştirilemez.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
id	path	True	string	Cihazın benzersiz tanımlayıcısı.
mid	path	True	string	Modülü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 modül için zayıf bir ETag'i temsil eden dize. Bu, modül oluşturulurken ayarlanmamalıdır, ancak modül güncelleştirilirken ayarlanabilir.

İstek Gövdesi

Name	Tür	Description
authentication	AuthenticationMechanism	Hizmet ve uç hub'ına bağlanırken modül tarafından kullanılan kimlik doğrulama mekanizması.
cloudToDeviceMessageCount	integer	Şu anda modüle gönderilmek üzere kuyruğa alınan buluttan modüle ileti sayısı.
connectionState	enum: Disconnected Connected	Cihazın bağlantı durumu.
connectionStateUpdatedTime	string	Bağlantı durumunun son güncelleştirildiği tarih ve saat.
deviceId	string	Cihazın benzersiz tanımlayıcısı.
etag	string	RFC7232 göre modül kimliği için zayıf bir ETag'i temsil eden dize.
generationId	string	Oluşturulan IoT Hub, büyük/küçük harfe duyarlı dize en fazla 128 karakter uzunluğundadır. Bu değer, silinip yeniden oluşturulduklarında aynı moduleId'ye sahip modülleri ayırt etmek için kullanılır.
lastActivityTime	string	Cihazın en son bağlanıp alındığı veya ileti gönderdiği tarih ve saat.
managedBy	string	Bu modülü kimin yönettiğini tanımlar. Örneğin, bu modülün sahibi edge çalışma zamanıysa bu değer "IotEdge" olur.
moduleId	string	Modülün benzersiz tanımlayıcısı.

Yanıtlar

Name	Tür	Description
200 OK	Module	Tamam ögesini seçin.
201 Created	Module	Oluşturulan.

Tanımlar

Name	Description
AuthenticationMechanism
Module	Bir cihazdaki modül kimliği.
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.

Module

Bir cihazdaki modül kimliği.

Name	Tür	Description
authentication	AuthenticationMechanism	Hizmet ve uç hub'ına bağlanırken modül tarafından kullanılan kimlik doğrulama mekanizması.
cloudToDeviceMessageCount	integer	Şu anda modüle gönderilmek üzere kuyruğa alınan buluttan modüle ileti sayısı.
connectionState	enum: Connected Disconnected	Cihazın bağlantı durumu.
connectionStateUpdatedTime	string	Bağlantı durumunun son güncelleştirildiği tarih ve saat.
deviceId	string	Cihazın benzersiz tanımlayıcısı.
etag	string	RFC7232 göre modül kimliği için zayıf bir ETag'i temsil eden dize.
generationId	string	Oluşturulan IoT Hub, büyük/küçük harfe duyarlı dize en fazla 128 karakter uzunluğundadır. Bu değer, silinip yeniden oluşturulduklarında aynı moduleId'ye sahip modülleri ayırt etmek için kullanılır.
lastActivityTime	string	Cihazın en son bağlanıp alındığı veya ileti gönderdiği tarih ve saat.
managedBy	string	Bu modülü kimin yönettiğini tanımlar. Örneğin, bu modülün sahibi edge çalışma zamanıysa bu değer "IotEdge" olur.
moduleId	string	Modülün benzersiz tanımlayıcısı.

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.