Devices - Create Or Update Identity
Hiermee maakt of werkt u de identiteit van een apparaat in het identiteitsregister van de IoT Hub bij.
PUT https://fully-qualified-iothubname.azure-devices.net/devices/{id}?api-version=2021-04-12URI-parameters
| Name | In | Vereist | Type | Description |
|---|---|---|---|---|
|
id
|
path | True |
string |
De unieke id van het apparaat. |
|
api-version
|
query | True |
string |
Versie van de API. |
Aanvraagkoptekst
| Name | Vereist | Type | Description |
|---|---|---|---|
| If-Match |
string |
De tekenreeks die een zwakke ETag vertegenwoordigt voor de apparaat-id, volgens RFC7232. Dit moet niet worden ingesteld bij het maken van een apparaat, maar kan worden ingesteld bij het bijwerken van een apparaat. |
Aanvraagbody
| Name | Type | Description |
|---|---|---|
| authentication |
Het verificatiemechanisme dat door het apparaat wordt gebruikt. |
|
| capabilities |
De set mogelijkheden van het apparaat. Als dit apparaat bijvoorbeeld een edge-apparaat is of niet. |
|
| cloudToDeviceMessageCount |
integer (int32) |
Het aantal cloud-naar-apparaat-berichten dat momenteel in de wachtrij wordt geplaatst om naar het apparaat te worden verzonden. |
| connectionState |
enum:
|
De status van het apparaat. |
| connectionStateUpdatedTime |
string (date-time) |
De datum en tijd waarop de verbindingsstatus voor het laatst is bijgewerkt. |
| deviceId |
string |
De unieke id van het apparaat. |
| deviceScope |
string |
Het bereik van het apparaat. Automatisch gegenereerd en onveranderbaar voor edge-apparaten en kan worden gewijzigd in leaf-apparaten om onderliggende/bovenliggende relatie te maken. |
| etag |
string |
De tekenreeks die een zwakke ETag vertegenwoordigt voor de apparaat-id, volgens RFC7232. |
| generationId |
string |
De door IoT Hub gegenereerde, hoofdlettergevoelige tekenreeks tot 128 tekens lang. Deze waarde wordt gebruikt om apparaten te onderscheiden met dezelfde deviceId wanneer ze zijn verwijderd en opnieuw zijn gemaakt. |
| lastActivityTime |
string (date-time) |
De datum en laatste keer dat het apparaat voor het laatst is verbonden, ontvangen of een bericht heeft verzonden. |
| parentScopes |
string[] |
De bereiken van de edge-apparaten op het hoogste niveau, indien van toepassing. Alleen beschikbaar voor edge-apparaten. |
| status |
enum:
|
De status van het apparaat. Als de status is uitgeschakeld, kan een apparaat geen verbinding maken met de service. |
| statusReason |
string |
De tekenreeks van 128 tekens die de reden voor de status van de apparaat-id opslaat. Alle UTF-8 tekens zijn toegestaan. |
| statusUpdatedTime |
string (date-time) |
De datum en tijd waarop het statusveld voor het laatst is bijgewerkt. |
Antwoorden
| Name | Type | Description |
|---|---|---|
| 200 OK |
OK. |
Definities
| Name | Description |
|---|---|
|
Authentication |
|
| Device | |
|
Device |
De status van de mogelijkheden die op het apparaat zijn ingeschakeld. |
|
Symmetric |
|
| X509Thumbprint |
AuthenticationMechanism
| Name | Type | Description |
|---|---|---|
| symmetricKey |
De primaire en secundaire sleutels die worden gebruikt voor verificatie op basis van SAS. |
|
| type |
enum:
|
Het type verificatie dat wordt gebruikt om verbinding te maken met de service. |
| x509Thumbprint |
De primaire en secundaire x509-vingerafdrukken die worden gebruikt voor verificatie op basis van x509. |
Device
| Name | Type | Description |
|---|---|---|
| authentication |
Het verificatiemechanisme dat door het apparaat wordt gebruikt. |
|
| capabilities |
De set mogelijkheden van het apparaat. Als dit apparaat bijvoorbeeld een edge-apparaat is of niet. |
|
| cloudToDeviceMessageCount |
integer (int32) |
Het aantal cloud-naar-apparaat-berichten dat momenteel in de wachtrij wordt geplaatst om naar het apparaat te worden verzonden. |
| connectionState |
enum:
|
De status van het apparaat. |
| connectionStateUpdatedTime |
string (date-time) |
De datum en tijd waarop de verbindingsstatus voor het laatst is bijgewerkt. |
| deviceId |
string |
De unieke id van het apparaat. |
| deviceScope |
string |
Het bereik van het apparaat. Automatisch gegenereerd en onveranderbaar voor edge-apparaten en kan worden gewijzigd in leaf-apparaten om onderliggende/bovenliggende relatie te maken. |
| etag |
string |
De tekenreeks die een zwakke ETag vertegenwoordigt voor de apparaat-id, volgens RFC7232. |
| generationId |
string |
De door IoT Hub gegenereerde, hoofdlettergevoelige tekenreeks tot 128 tekens lang. Deze waarde wordt gebruikt om apparaten te onderscheiden met dezelfde deviceId wanneer ze zijn verwijderd en opnieuw zijn gemaakt. |
| lastActivityTime |
string (date-time) |
De datum en laatste keer dat het apparaat voor het laatst is verbonden, ontvangen of een bericht heeft verzonden. |
| parentScopes |
string[] |
De bereiken van de edge-apparaten op het hoogste niveau, indien van toepassing. Alleen beschikbaar voor edge-apparaten. |
| status |
enum:
|
De status van het apparaat. Als de status is uitgeschakeld, kan een apparaat geen verbinding maken met de service. |
| statusReason |
string |
De tekenreeks van 128 tekens die de reden voor de status van de apparaat-id opslaat. Alle UTF-8 tekens zijn toegestaan. |
| statusUpdatedTime |
string (date-time) |
De datum en tijd waarop het statusveld voor het laatst is bijgewerkt. |
DeviceCapabilities
De status van de mogelijkheden die op het apparaat zijn ingeschakeld.
| Name | Type | Description |
|---|---|---|
| iotEdge |
boolean |
De eigenschap die bepaalt of het apparaat een edge-apparaat is of niet. |
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. |