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

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 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 (int32)

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 IoT Hub:s identitetsregister. 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 (date-time)

Datum och tid då 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 IoT Hubs identitetsregister. 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 de övre gränsenheterna om tillämpligt. Endast tillgängligt för gränsenheter.
properties

TwinProperties

De önskade och rapporterade egenskaperna 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 någon.
statusUpdateTime

string (date-time)

Datum och tid då enhetens status senast uppdaterades.
tags

object

Insamlingen 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 up-to 1 KB långa. Tillåtna tecken exkluderar UNICODE-kontrolltecken (segmenten C0 och C1), '.', '$' och blanksteg. Värdena är JSON-objekt, up-to 4 KB långa.
version

integer (int64)

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

X509Thumbprint

Enhetens X509-tumavtryck.

Svar

Name Typ Description
200 OK

Twin

OKEJ.

Definitioner

Name Description
DeviceCapabilities

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

Tillståndsinformationen 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

De önskade och rapporterade egenskaperna för tvillingen. Objektets maximala djup är 10.
X509Thumbprint

DeviceCapabilities

Objekt

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

Objekt

Tillståndsinformationen 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 (int32)

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 IoT Hub:s identitetsregister. 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 (date-time)

Datum och tid då 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 IoT Hubs identitetsregister. 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 de övre gränsenheterna om tillämpligt. Endast tillgängligt för gränsenheter.
properties

TwinProperties

De önskade och rapporterade egenskaperna 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 någon.
statusUpdateTime

string (date-time)

Datum och tid då enhetens status senast uppdaterades.
tags

object

Insamlingen 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 up-to 1 KB långa. Tillåtna tecken exkluderar UNICODE-kontrolltecken (segmenten C0 och C1), '.', '$' och blanksteg. Värdena är JSON-objekt, up-to 4 KB långa.
version

integer (int64)

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

X509Thumbprint

Enhetens X509-tumavtryck.

TwinProperties

Objekt

De önskade och rapporterade egenskaperna 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 up-to 1 KB långa. Tillåtna tecken exkluderar UNICODE-kontrolltecken (segmenten C0 och C1), '.', '$' och blanksteg. Önskade porperty-värden är JSON-objekt, up-to 4 KB långa.
reported

object

Samlingen av nyckel/värde-par för rapporterad egenskap. Nycklarna är UTF-8-kodade, skiftlägeskänsliga och up-to 1 KB långa. Tillåtna tecken exkluderar UNICODE-kontrolltecken (segmenten C0 och C1), '.', '$' och blanksteg. De rapporterade egenskapsvärdena är JSON-objekt up-to 4 KB långa.

X509Thumbprint

Objekt
Name Typ Description
primaryThumbprint

string

X509-klientcertifikatets primära tumavtryck.
secondaryThumbprint

string

X509-klientcertifikatets sekundära tumavtryck.