Dela via

Modules - Replace Twin

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

Ersätter taggarna och önskade egenskaper för en modultvilling. Mer information finns i https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.

PUT https://fully-qualified-iothubname.azure-devices.net/twins/{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

Den unika identifieraren för modulen.
api-version
 query True

string

Version av API:et.

Begärandehuvud

Name Obligatorisk Typ Description
If-Match

string

Strängen som representerar en svag ETag för enhetstvillingen enligt RFC7232. Den avgör om ersättningsåtgärden ska utföras.

Begärandetext

Name Typ Description
authenticationType enum:
  • sas
  • selfSigned
  • certificateAuthority
  • none

Den autentiseringstyp som används av enheten.
capabilities

DeviceCapabilities

Status för funktioner som är aktiverade på enheten.
cloudToDeviceMessageCount

integer

Antalet meddelanden från molnet till enheten som skickas.
connectionState enum:
  • Disconnected
  • Connected

Enhetens anslutningstillstånd.
deviceEtag

string

Strängen som representerar en ETag för enheten enligt RFC7232.
deviceId

string

Den unika identifieraren för enheten i identitetsregistret för IoT Hub. Det är en skiftlägeskänslig sträng (upp till 128 tecken lång) av ASCII 7-bitars alfanumeriska tecken, och följande specialtecken {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
deviceScope

string

Enhetens omfång.
etag

string

Strängen som representerar en ETag för enhetstvillingen enligt RFC7232.
lastActivityTime

string

Datum och tid när enheten senast anslöt eller tog emot eller skickade ett meddelande. Datum och tid anges i ISO8601 datetime-format i UTC, till exempel 2015-01-28T16:24:48.789Z. Det här värdet uppdateras inte om enheten använder HTTP/1-protokollet för att utföra meddelandeåtgärder.
moduleId

string

Den unika identifieraren för modulen i identitetsregistret för IoT Hub. Det är en skiftlägeskänslig sträng (upp till 128 tecken lång) av ASCII 7-bitars alfanumeriska tecken, och följande specialtecken {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
parentScopes

string[]

Omfången för gränsenheterna på den övre nivån om tillämpligt. Endast tillgängligt för gränsenheter.
properties

TwinProperties

Önskade och rapporterade egenskaper för tvillingen.
status enum:
  • enabled
  • disabled

Enhetens aktiverade status. Om den är inaktiverad kan enheten inte ansluta till tjänsten.
statusReason

string

Orsaken till enhetens aktuella status, om det finns någon.
statusUpdateTime

string

Datum och tid då enhetens status senast uppdaterades.
tags

object

Insamling av nyckel/värde-par som lästs och skrivits av lösningens serverdel. De är inte synliga för enhetsappar. Nycklarna är UTF-8-kodade, skiftlägeskänsliga och upp till 1 kB långa. Tillåtna tecken utesluter UNICODE-kontrolltecken (segmenten C0 och C1), ".", "$" och blanksteg. Värdena är JSON-objekt med en längd på upp till 4 kB.
version

integer

Versionen för enhetstvillingen inklusive taggar och önskade egenskaper
x509Thumbprint

X509Thumbprint

Enhetens X509-tumavtryck.

Svar

Name Typ Description
200 OK

Twin

OK.

Definitioner

Name Description
DeviceCapabilities

Status för funktioner som är aktiverade på enheten.
Twin

Tillståndsinformation för en enhet eller modul. Detta skapas och tas bort implicit när motsvarande enhets-/modulidentitet skapas eller tas bort i IoT Hub.
TwinProperties

Önskade och rapporterade egenskaper för tvillingen. Objektets maximala djup är 10.
X509Thumbprint

DeviceCapabilities

Status för funktioner som är aktiverade på enheten.

Name Typ Description
iotEdge

boolean

Egenskapen som avgör om enheten är en gränsenhet eller inte.

Twin

Tillståndsinformation för en enhet eller modul. Detta skapas och tas bort implicit när motsvarande enhets-/modulidentitet skapas eller tas bort i IoT Hub.

Name Typ Description
authenticationType enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Den autentiseringstyp som används av enheten.
capabilities

DeviceCapabilities

Status för funktioner som är aktiverade på enheten.
cloudToDeviceMessageCount

integer

Antalet meddelanden från molnet till enheten som skickas.
connectionState enum:
  • Connected
  • Disconnected

Enhetens anslutningstillstånd.
deviceEtag

string

Strängen som representerar en ETag för enheten enligt RFC7232.
deviceId

string

Den unika identifieraren för enheten i identitetsregistret för IoT Hub. Det är en skiftlägeskänslig sträng (upp till 128 tecken lång) av ASCII 7-bitars alfanumeriska tecken, och följande specialtecken {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
deviceScope

string

Enhetens omfång.
etag

string

Strängen som representerar en ETag för enhetstvillingen enligt RFC7232.
lastActivityTime

string

Datum och tid när enheten senast anslöt eller tog emot eller skickade ett meddelande. Datum och tid anges i ISO8601 datetime-format i UTC, till exempel 2015-01-28T16:24:48.789Z. Det här värdet uppdateras inte om enheten använder HTTP/1-protokollet för att utföra meddelandeåtgärder.
moduleId

string

Den unika identifieraren för modulen i identitetsregistret för IoT Hub. Det är en skiftlägeskänslig sträng (upp till 128 tecken lång) av ASCII 7-bitars alfanumeriska tecken, och följande specialtecken {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
parentScopes

string[]

Omfången för gränsenheterna på den övre nivån om tillämpligt. Endast tillgängligt för gränsenheter.
properties

TwinProperties

Önskade och rapporterade egenskaper för tvillingen.
status enum:
  • disabled
  • enabled

Enhetens aktiverade status. Om den är inaktiverad kan enheten inte ansluta till tjänsten.
statusReason

string

Orsaken till enhetens aktuella status, om det finns någon.
statusUpdateTime

string

Datum och tid då enhetens status senast uppdaterades.
tags

object

Insamling av nyckel/värde-par som lästs och skrivits av lösningens serverdel. De är inte synliga för enhetsappar. Nycklarna är UTF-8-kodade, skiftlägeskänsliga och upp till 1 kB långa. Tillåtna tecken utesluter UNICODE-kontrolltecken (segmenten C0 och C1), ".", "$" och blanksteg. Värdena är JSON-objekt med en längd på upp till 4 kB.
version

integer

Versionen för enhetstvillingen inklusive taggar och önskade egenskaper
x509Thumbprint

X509Thumbprint

Enhetens X509-tumavtryck.

TwinProperties

Önskade och rapporterade egenskaper för tvillingen. Objektets maximala djup är 10.

Name Typ Description
desired

object

Samlingen med nyckel/värde-par för önskad egenskap. Nycklarna är UTF-8-kodade, skiftlägeskänsliga och upp till 1 kB långa. Tillåtna tecken utesluter UNICODE-kontrolltecken (segmenten C0 och C1), ".", "$" och blanksteg. Önskade porperty-värden är JSON-objekt med en längd på upp till 4 KB.
reported

object

Samlingen av nyckel/värde-par för rapporterade egenskaper. Nycklarna är UTF-8-kodade, skiftlägeskänsliga och upp till 1 kB långa. Tillåtna tecken utesluter UNICODE-kontrolltecken (segmenten C0 och C1), ".", "$" och blanksteg. De rapporterade egenskapsvärdena är JSON-objekt med en längd på upp till 4 KB.

X509Thumbprint

Name Typ Description
primaryThumbprint

string

X509-klientcertifikatets primära tumavtryck.
secondaryThumbprint

string

Det sekundära tumavtrycket för X509-klientcertifikatet.