Modules - Create Or Update Identity

Service:

IoT Hub

API-versie:

2021-04-12

Hiermee wordt de module-id voor een apparaat in de IoT Hub gemaakt of bijgewerkt. De moduleId en generationId kunnen niet worden bijgewerkt door de gebruiker.

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

URI-parameters

Name	In	Vereist	Type	Description
id	path	True	string	De unieke id van het apparaat.
mid	path	True	string	De unieke id van de module.
api-version	query	True	string	Versie van de API.

Aanvraagkoptekst

Name	Vereist	Type	Description
If-Match		string	De tekenreeks die een zwakke ETag voor de module vertegenwoordigt, volgens RFC7232. Dit moet niet worden ingesteld bij het maken van een module, maar kan worden ingesteld bij het bijwerken van een module.

Aanvraagbody

Name	Type	Description
authentication	AuthenticationMechanism	Het verificatiemechanisme dat door de module wordt gebruikt bij het maken van verbinding met de service en edge-hub.
cloudToDeviceMessageCount	integer	Het aantal cloud-naar-module-berichten dat momenteel in de wachtrij staat om naar de module te worden verzonden.
connectionState	enum: Disconnected Connected	De verbindingsstatus van het apparaat.
connectionStateUpdatedTime	string	De datum en tijd waarop de verbindingsstatus voor het laatst is bijgewerkt.
deviceId	string	De unieke id van het apparaat.
etag	string	De tekenreeks die een zwakke ETag vertegenwoordigt voor de module-identiteit, volgens RFC7232.
generationId	string	De IoT Hub gegenereerde, hoofdlettergevoelige tekenreeks met een lengte van maximaal 128 tekens. Deze waarde wordt gebruikt om modules met dezelfde moduleId te onderscheiden wanneer ze zijn verwijderd en opnieuw zijn gemaakt.
lastActivityTime	string	De datum en tijd waarop het apparaat voor het laatst verbinding heeft gemaakt, een bericht heeft ontvangen of verzonden.
managedBy	string	Identificeert wie deze module beheert. Deze waarde is bijvoorbeeld 'IotEdge' als de edge-runtime eigenaar is van deze module.
moduleId	string	De unieke id van de module.

Antwoorden

Name	Type	Description
200 OK	Module	OK.
201 Created	Module	Gemaakt.

Definities

Name	Description
AuthenticationMechanism
Module	De module-id op een apparaat.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Name	Type	Description
symmetricKey	SymmetricKey	De primaire en secundaire sleutels die worden gebruikt voor verificatie op basis van SAS.
type	enum: certificateAuthority none sas selfSigned	Het type verificatie dat wordt gebruikt om verbinding te maken met de service.
x509Thumbprint	X509Thumbprint	De primaire en secundaire x509-vingerafdrukken die worden gebruikt voor x509-verificatie.

Module

De module-id op een apparaat.

Name	Type	Description
authentication	AuthenticationMechanism	Het verificatiemechanisme dat door de module wordt gebruikt bij het maken van verbinding met de service en edge-hub.
cloudToDeviceMessageCount	integer	Het aantal cloud-naar-module-berichten dat momenteel in de wachtrij staat om naar de module te worden verzonden.
connectionState	enum: Connected Disconnected	De verbindingsstatus van het apparaat.
connectionStateUpdatedTime	string	De datum en tijd waarop de verbindingsstatus voor het laatst is bijgewerkt.
deviceId	string	De unieke id van het apparaat.
etag	string	De tekenreeks die een zwakke ETag vertegenwoordigt voor de module-identiteit, volgens RFC7232.
generationId	string	De IoT Hub gegenereerde, hoofdlettergevoelige tekenreeks met een lengte van maximaal 128 tekens. Deze waarde wordt gebruikt om modules met dezelfde moduleId te onderscheiden wanneer ze zijn verwijderd en opnieuw zijn gemaakt.
lastActivityTime	string	De datum en tijd waarop het apparaat voor het laatst verbinding heeft gemaakt, een bericht heeft ontvangen of verzonden.
managedBy	string	Identificeert wie deze module beheert. Deze waarde is bijvoorbeeld 'IotEdge' als de edge-runtime eigenaar is van deze module.
moduleId	string	De unieke id van de module.

SymmetricKey

Name	Type	Description
primaryKey	string	De met base64 gecodeerde primaire sleutel van het apparaat.
secondaryKey	string	De met base64 gecodeerde secundaire sleutel van het apparaat.

X509Thumbprint

Name	Type	Description
primaryThumbprint	string	De primaire vingerafdruk van het X509-clientcertificaat.
secondaryThumbprint	string	De secundaire vingerafdruk van het X509-clientcertificaat.