Dela via

Modules - Create Or Update Identity

Tjänst:
IoT Hub
API-version:
2021-04-12

Skapar eller uppdaterar modulidentiteten för en enhet i IoT Hub. ModuleId och generationId kan inte uppdateras av användaren.

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

URI-parametrar

Name I Obligatorisk Typ Description
id
 path True

string

Enhetens unika identifierare.
mid
 path True

string

Modulens unika identifierare.
api-version
 query True

string

Version av API:et.

Begärandehuvud

Name Obligatorisk Typ Description
If-Match

string

Strängen representerar en svag ETag för modulen enligt RFC7232. Detta bör inte anges när du skapar en modul, men kan anges när du uppdaterar en modul.

Begärandetext

Name Typ Description
authentication

AuthenticationMechanism

Den autentiseringsmekanism som används av modulen vid anslutning till tjänsten och gränshubben.
cloudToDeviceMessageCount

integer (int32)

Antalet moln-till-modul-meddelanden som för närvarande placeras i kö för att skickas till modulen.
connectionState enum:
  • Disconnected
  • Connected

Enhetens anslutningstillstånd.
connectionStateUpdatedTime

string (date-time)

Datum och tid då anslutningstillståndet senast uppdaterades.
deviceId

string

Enhetens unika identifierare.
etag

string

Strängen som representerar en svag ETag för modulidentiteten enligt RFC7232.
generationId

string

Den IoT Hub-genererade, skiftlägeskänsliga strängen är upp till 128 tecken lång. Det här värdet används för att särskilja moduler med samma moduleId, när de har tagits bort och återskapats.
lastActivityTime

string (date-time)

Datum och tid då enheten senast anslöt, tog emot eller skickade ett meddelande.
managedBy

string

Identifierar vem som hanterar den här modulen. Det här värdet är till exempel "IotEdge" om edge-körningen äger den här modulen.
moduleId

string

Modulens unika identifierare.

Svar

Name Typ Description
200 OK

Module

OKEJ.
201 Created

Module

Skapad.

Definitioner

Name Description
AuthenticationMechanism
Module

Modulidentiteten på en enhet.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Objekt
Name Typ Description
symmetricKey

SymmetricKey

De primära och sekundära nycklar som används för SAS-baserad autentisering.
type enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Den typ av autentisering som används för att ansluta till tjänsten.
x509Thumbprint

X509Thumbprint

De primära och sekundära x509-tumavtrycken som används för x509-baserad autentisering.

Module

Objekt

Modulidentiteten på en enhet.

Name Typ Description
authentication

AuthenticationMechanism

Den autentiseringsmekanism som används av modulen vid anslutning till tjänsten och gränshubben.
cloudToDeviceMessageCount

integer (int32)

Antalet moln-till-modul-meddelanden som för närvarande placeras i kö för att skickas till modulen.
connectionState enum:
  • Connected
  • Disconnected

Enhetens anslutningstillstånd.
connectionStateUpdatedTime

string (date-time)

Datum och tid då anslutningstillståndet senast uppdaterades.
deviceId

string

Enhetens unika identifierare.
etag

string

Strängen som representerar en svag ETag för modulidentiteten enligt RFC7232.
generationId

string

Den IoT Hub-genererade, skiftlägeskänsliga strängen är upp till 128 tecken lång. Det här värdet används för att särskilja moduler med samma moduleId, när de har tagits bort och återskapats.
lastActivityTime

string (date-time)

Datum och tid då enheten senast anslöt, tog emot eller skickade ett meddelande.
managedBy

string

Identifierar vem som hanterar den här modulen. Det här värdet är till exempel "IotEdge" om edge-körningen äger den här modulen.
moduleId

string

Modulens unika identifierare.

SymmetricKey

Objekt
Name Typ Description
primaryKey

string

Den base64-kodade primärnyckeln för enheten.
secondaryKey

string

Enhetens base64-kodade sekundära nyckel.

X509Thumbprint

Objekt
Name Typ Description
primaryThumbprint

string

X509-klientcertifikatets primära tumavtryck.
secondaryThumbprint

string

X509-klientcertifikatets sekundära tumavtryck.