Enrollment Group - Create Or Update
Creatie of werk een apparaatinschrijvingsgroep bij.
PUT https://your-dps.azure-devices-provisioning.net/enrollmentGroups/{id}?api-version=2021-10-01| Name | In | Vereist | Type | Description |
|---|---|---|---|---|
|
id
|
path | True |
string |
Id van inschrijvingsgroep. |
|
api-version
|
query | True |
string |
De API-versie die moet worden gebruikt voor de aanvraag. Ondersteunde versies zijn: 2021-10-01 |
| Name | Vereist | Type | Description |
|---|---|---|---|
| If-Match |
string |
De ETag van de inschrijvingsrecord. |
| Name | Vereist | Type | Description |
|---|---|---|---|
| attestation | True |
Attestation-mechanisme voor individualEnrollment en enrollmentGroup. |
|
| enrollmentGroupId | True |
string |
Registratiegroeps-id. |
| allocationPolicy |
enum:
|
Het toewijzingsbeleid van deze resource. Dit beleid overschrijft het toewijzingsbeleid op tenantniveau voor deze afzonderlijke inschrijving of inschrijvingsgroep. Mogelijke waarden zijn 'gehasht': gekoppelde IoT-hubs hebben even waarschijnlijk apparaten ingericht, 'geoLatency': apparaten worden ingericht voor een IoT-hub met de laagste latentie voor het apparaat. Als meerdere gekoppelde IoT-hubs dezelfde laagste latentie bieden, worden door de inrichtingsservice apparaten in deze hubs 'statisch' gehesen: de specificatie van de gewenste IoT-hub in de registratielijst heeft voorrang op het toewijzingsbeleid op serviceniveau 'aangepast': apparaten worden ingericht voor een IoT-hub op basis van uw eigen aangepaste logica. De inrichtingsservice geeft informatie over het apparaat door aan de logica en de logica retourneert de gewenste IoT-hub en de gewenste initiële configuratie. U wordt aangeraden Azure Functions te gebruiken om uw logica te hosten. |
|
| capabilities |
Apparaatmogelijkheden. |
||
| customAllocationDefinition |
Hiermee vertelt DPS welke webhook moet worden aangeroepen bij het gebruik van aangepaste toewijzing. |
||
| etag |
string |
De entiteitstag die is gekoppeld aan de resource. |
|
| initialTwin |
Eerste apparaatdubbel. Bevat een subset van de eigenschappen van Dubbel. |
||
| iotHubHostName |
string |
De hostnaam van de IoT Hub. |
|
| iotHubs |
string[] |
De lijst met IoT Hub hostnamen waaraan de apparaten in deze resource kunnen worden toegewezen. Moet een subset zijn van de lijst met IoT-hubs op tenantniveau. |
|
| provisioningStatus |
enum:
|
De inrichtingsstatus. |
|
| reprovisionPolicy |
Het gedrag van de service wanneer een apparaat opnieuw wordt ingericht voor een IoT-hub. |
| Name | Type | Description |
|---|---|---|
| 200 OK |
Geslaagd |
|
| Other Status Codes |
Foutreactie Kopteksten x-ms-error-code: string |
| Name | Description |
|---|---|
|
Attestation |
Attestation-mechanisme voor individualEnrollment en enrollmentGroup. |
|
Custom |
Hiermee vertelt DPS welke webhook moet worden aangeroepen bij het gebruik van aangepaste toewijzing. |
|
Device |
Apparaatmogelijkheden. |
|
Enrollment |
Registratiegroeprecord. |
|
Initial |
Eerste apparaatdubbel. Bevat een subset van de eigenschappen van Dubbel. |
|
Initial |
Vertegenwoordigt de eerste eigenschappen die worden ingesteld op de apparaatdubbel. |
| Metadata |
Metagegevens voor de TwinCollection |
|
Provisioning |
Bevat de eigenschappen van een fout die is geretourneerd door de Azure IoT Hub Provisioning Service. |
|
Reprovision |
Het gedrag van de service wanneer een apparaat opnieuw wordt ingericht voor een IoT-hub. |
|
Symmetric |
Attestation via SymmetricKey. |
|
Tpm |
Attestation via TPM. |
|
Twin |
Vertegenwoordigt een verzameling eigenschappen binnen een dubbel |
| X509Attestation |
Attestation via X509. |
| X509CAReferences |
Primaire en secundaire CA-verwijzingen. |
|
X509Certificate |
X509-certificaatgegevens. |
| X509Certificates |
Primaire en secundaire certificaten |
|
X509Certificate |
Certificaat en certificaatgegevens |
Attestation-mechanisme voor individualEnrollment en enrollmentGroup.
| Name | Type | Description |
|---|---|---|
| symmetricKey |
Attestation via SymmetricKey. |
|
| tpm |
Attestation via TPM. |
|
| type |
enum:
|
Attestation-type. |
| x509 |
Attestation via X509. |
Hiermee vertelt DPS welke webhook moet worden aangeroepen bij het gebruik van aangepaste toewijzing.
| Name | Type | Description |
|---|---|---|
| apiVersion |
string |
De API-versie van de inrichtingsservicetypen (zoals IndividualEnrollment) die zijn verzonden in de aangepaste toewijzingsaanvraag. Minimaal ondersteunde versie: "2018-09-01-preview". |
| webhookUrl |
string |
De url van de webhook die wordt gebruikt voor toewijzingsaanvragen. |
Apparaatmogelijkheden.
| Name | Type | Default value | Description |
|---|---|---|---|
| iotEdge |
boolean |
False |
Als dit is ingesteld op true, is dit apparaat een IoTEdge-apparaat. |
Registratiegroeprecord.
| Name | Type | Default value | Description |
|---|---|---|---|
| allocationPolicy |
enum:
|
Het toewijzingsbeleid van deze resource. Dit beleid overschrijft het toewijzingsbeleid op tenantniveau voor deze afzonderlijke inschrijving of inschrijvingsgroep. Mogelijke waarden zijn 'gehasht': gekoppelde IoT-hubs hebben even waarschijnlijk apparaten ingericht, 'geoLatency': apparaten worden ingericht voor een IoT-hub met de laagste latentie voor het apparaat. Als meerdere gekoppelde IoT-hubs dezelfde laagste latentie bieden, worden door de inrichtingsservice apparaten in deze hubs 'statisch' gehesen: de specificatie van de gewenste IoT-hub in de registratielijst heeft voorrang op het toewijzingsbeleid op serviceniveau 'aangepast': apparaten worden ingericht voor een IoT-hub op basis van uw eigen aangepaste logica. De inrichtingsservice geeft informatie over het apparaat door aan de logica en de logica retourneert de gewenste IoT-hub en de gewenste initiële configuratie. U wordt aangeraden Azure Functions te gebruiken om uw logica te hosten. |
|
| attestation |
Attestation-mechanisme voor individualEnrollment en enrollmentGroup. |
||
| capabilities |
Apparaatmogelijkheden. |
||
| createdDateTimeUtc |
string |
De Datum/tijd van deze resource is gemaakt. |
|
| customAllocationDefinition |
Hiermee vertelt DPS welke webhook moet worden aangeroepen bij het gebruik van aangepaste toewijzing. |
||
| enrollmentGroupId |
string |
Registratiegroeps-id. |
|
| etag |
string |
De entiteitstag die is gekoppeld aan de resource. |
|
| initialTwin |
Eerste apparaatdubbel. Bevat een subset van de eigenschappen van Dubbel. |
||
| iotHubHostName |
string |
De hostnaam van de IoT Hub. |
|
| iotHubs |
string[] |
De lijst met IoT Hub hostnamen waaraan de apparaten in deze resource kunnen worden toegewezen. Moet een subset zijn van de lijst met IoT-hubs op tenantniveau. |
|
| lastUpdatedDateTimeUtc |
string |
De Datum/tijd van deze resource is voor het laatst bijgewerkt. |
|
| provisioningStatus |
enum:
|
enabled |
De inrichtingsstatus. |
| reprovisionPolicy |
Het gedrag van de service wanneer een apparaat opnieuw wordt ingericht voor een IoT-hub. |
Eerste apparaatdubbel. Bevat een subset van de eigenschappen van Dubbel.
| Name | Type | Description |
|---|---|---|
| properties |
Vertegenwoordigt de eerste eigenschappen die worden ingesteld op de apparaatdubbel. |
|
| tags |
Vertegenwoordigt een verzameling eigenschappen binnen een dubbel |
Vertegenwoordigt de eerste eigenschappen die worden ingesteld op de apparaatdubbel.
| Name | Type | Description |
|---|---|---|
| desired |
Vertegenwoordigt een verzameling eigenschappen binnen een dubbel |
Metagegevens voor de TwinCollection
| Name | Type | Description |
|---|---|---|
| lastUpdated |
string |
De laatste keer dat de TwinCollection is bijgewerkt |
| lastUpdatedVersion |
integer |
Dit is null voor metagegevens van gerapporteerde eigenschappen en is niet null voor metagegevens van gewenste eigenschappen. |
Bevat de eigenschappen van een fout die is geretourneerd door de Azure IoT Hub Provisioning Service.
| Name | Type | Description |
|---|---|---|
| errorCode |
integer |
|
| info |
object |
|
| message |
string |
|
| timestampUtc |
string |
|
| trackingId |
string |
Het gedrag van de service wanneer een apparaat opnieuw wordt ingericht voor een IoT-hub.
| Name | Type | Default value | Description |
|---|---|---|---|
| migrateDeviceData |
boolean |
True |
Als deze optie is ingesteld op true (standaard), migreert Device Provisioning Service de gegevens van het apparaat (dubbel, apparaatmogelijkheden en apparaat-id) van de ene IoT-hub naar de andere tijdens een update van een IoT-hubtoewijzing. Als deze optie is ingesteld op onwaar, worden de gegevens van het apparaat opnieuw ingesteld op de oorspronkelijke gewenste configuratie die is opgeslagen in de bijbehorende inschrijvingslijst. |
| updateHubAssignment |
boolean |
True |
Als deze optie is ingesteld op true (standaard), evalueert Device Provisioning Service de IoT Hub toewijzing van het apparaat en werkt deze zo nodig bij voor inrichtingsaanvragen die verder gaan dan de eerste van een bepaald apparaat. Als dit is ingesteld op false, blijft het apparaat toegewezen aan de huidige IoT-hub. |
Attestation via SymmetricKey.
| Name | Type | Description |
|---|---|---|
| primaryKey |
string |
Primaire symmetrische sleutel. |
| secondaryKey |
string |
Secundaire symmetrische sleutel. |
Attestation via TPM.
| Name | Type | Description |
|---|---|---|
| endorsementKey |
string |
|
| storageRootKey |
string |
Vertegenwoordigt een verzameling eigenschappen binnen een dubbel
| Name | Type | Description |
|---|---|---|
| count |
integer |
Aantal eigenschappen in de TwinCollection |
| metadata |
Metagegevens voor de TwinCollection |
|
| version |
integer |
Versie van de TwinCollection |
Attestation via X509.
| Name | Type | Description |
|---|---|---|
| caReferences |
Primaire en secundaire CA-verwijzingen. |
|
| clientCertificates |
Primaire en secundaire certificaten |
|
| signingCertificates |
Primaire en secundaire certificaten |
Primaire en secundaire CA-verwijzingen.
| Name | Type | Description |
|---|---|---|
| primary |
string |
|
| secondary |
string |
X509-certificaatgegevens.
| Name | Type | Description |
|---|---|---|
| issuerName |
string |
|
| notAfterUtc |
string |
|
| notBeforeUtc |
string |
|
| serialNumber |
string |
|
| sha1Thumbprint |
string |
|
| sha256Thumbprint |
string |
|
| subjectName |
string |
|
| version |
integer |
Primaire en secundaire certificaten
| Name | Type | Description |
|---|---|---|
| primary |
Certificaat en certificaatgegevens |
|
| secondary |
Certificaat en certificaatgegevens |
Certificaat en certificaatgegevens
| Name | Type | Description |
|---|---|---|
| certificate |
string |
|
| info |
X509-certificaatgegevens. |