Delen via


Enrollment Group - Create Or Update

Een apparaatinschrijvingsgroep maken of bijwerken.

PUT https://your-dps.azure-devices-provisioning.net/enrollmentGroups/{id}?api-version=2021-10-01

URI-parameters

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

Aanvraagkoptekst

Name Vereist Type Description
If-Match

string

De ETag van de inschrijvingsrecord.

Aanvraagbody

Name Vereist Type Description
attestation True

AttestationMechanism

Attestation-mechanisme voor individualEnrollment en enrollmentGroup.

enrollmentGroupId True

string

minLength: 1

Id van inschrijvingsgroep.

allocationPolicy enum:
  • hashed
  • geoLatency
  • static
  • custom

Het toewijzingsbeleid van deze resource. Dit beleid overschrijft het toewijzingsbeleid op tenantniveau voor deze afzonderlijke inschrijving of inschrijvingsgroep. Mogelijke waarden zijn 'hashed': 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, hebben de inrichtingsservice-hashes apparaten in deze hubs statisch: Specificatie van de gewenste IoT-hub in de inschrijvingslijst 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. We raden u aan Azure Functions te gebruiken om uw logica te hosten.

capabilities

DeviceCapabilities

Apparaatmogelijkheden.

customAllocationDefinition

CustomAllocationDefinition

Dit vertelt DPS welke webhook moet worden aangeroepen wanneer aangepaste toewijzing wordt gebruikt.

etag

string

De entiteitstag die is gekoppeld aan de resource.

initialTwin

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 van de lijst met IoT-hubs op tenantniveau zijn.

provisioningStatus enum:
  • enabled
  • disabled

De inrichtingsstatus.

reprovisionPolicy

ReprovisionPolicy

Het gedrag van de service wanneer een apparaat opnieuw wordt ingericht voor een IoT-hub.

Antwoorden

Name Type Description
200 OK

EnrollmentGroup

Geslaagd

Other Status Codes

ProvisioningServiceErrorDetails

Foutreactie

Kopteksten

x-ms-error-code: string

Definities

Name Description
AttestationMechanism

Attestation-mechanisme voor individualEnrollment en enrollmentGroup.

CustomAllocationDefinition

Dit vertelt DPS welke webhook moet worden aangeroepen wanneer aangepaste toewijzing wordt gebruikt.

DeviceCapabilities

Apparaatmogelijkheden.

EnrollmentGroup

Registratiegroeprecord.

InitialTwin

Eerste apparaatdubbel. Bevat een subset van de eigenschappen van Dubbel.

InitialTwinProperties

Vertegenwoordigt de oorspronkelijke eigenschappen die worden ingesteld op de apparaatdubbel.

Metadata

Metagegevens voor de TwinCollection

ProvisioningServiceErrorDetails

Bevat de eigenschappen van een fout die wordt geretourneerd door azure IoT Hub Provisioning Service.

ReprovisionPolicy

Het gedrag van de service wanneer een apparaat opnieuw wordt ingericht voor een IoT-hub.

SymmetricKeyAttestation

Attestation via SymmetricKey.

TpmAttestation

Attestation via TPM.

TwinCollection

Vertegenwoordigt een verzameling eigenschappen binnen een tweeling

X509Attestation

Attestation via X509.

X509CAReferences

Primaire en secundaire CA-verwijzingen.

X509CertificateInfo

X509-certificaatgegevens.

X509Certificates

Primaire en secundaire certificaten

X509CertificateWithInfo

Certificaat- en certificaatgegevens

AttestationMechanism

Attestation-mechanisme voor individualEnrollment en enrollmentGroup.

Name Type Description
symmetricKey

SymmetricKeyAttestation

Attestation via SymmetricKey.

tpm

TpmAttestation

Attestation via TPM.

type enum:
  • none
  • symmetricKey
  • tpm
  • x509

Attestation-type.

x509

X509Attestation

Attestation via X509.

CustomAllocationDefinition

Dit vertelt DPS welke webhook moet worden aangeroepen wanneer aangepaste toewijzing wordt gebruikt.

Name Type Description
apiVersion

string

minLength: 1

De API-versie van de inrichtingsservicetypen (zoals IndividualEnrollment) die is verzonden in de aangepaste toewijzingsaanvraag. Minimaal ondersteunde versie: '2018-09-01-preview'.

webhookUrl

string

minLength: 1

De webhook-URL die wordt gebruikt voor toewijzingsaanvragen.

DeviceCapabilities

Apparaatmogelijkheden.

Name Type Default value Description
iotEdge

boolean

False

Als dit is ingesteld op true, is dit apparaat een IoTEdge-apparaat.

EnrollmentGroup

Registratiegroeprecord.

Name Type Default value Description
allocationPolicy enum:
  • custom
  • geoLatency
  • hashed
  • static

Het toewijzingsbeleid van deze resource. Dit beleid overschrijft het toewijzingsbeleid op tenantniveau voor deze afzonderlijke inschrijving of inschrijvingsgroep. Mogelijke waarden zijn 'hashed': 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, hebben de inrichtingsservice-hashes apparaten in deze hubs statisch: Specificatie van de gewenste IoT-hub in de inschrijvingslijst 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. We raden u aan Azure Functions te gebruiken om uw logica te hosten.

attestation

AttestationMechanism

Attestation-mechanisme voor individualEnrollment en enrollmentGroup.

capabilities

DeviceCapabilities

Apparaatmogelijkheden.

createdDateTimeUtc

string (date-time)

De datum/tijd waarop deze resource is gemaakt.

customAllocationDefinition

CustomAllocationDefinition

Dit vertelt DPS welke webhook moet worden aangeroepen wanneer aangepaste toewijzing wordt gebruikt.

enrollmentGroupId

string

minLength: 1

Id van inschrijvingsgroep.

etag

string

De entiteitstag die is gekoppeld aan de resource.

initialTwin

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 van de lijst met IoT-hubs op tenantniveau zijn.

lastUpdatedDateTimeUtc

string (date-time)

De datum/tijd waarop deze resource voor het laatst is bijgewerkt.

provisioningStatus enum:
  • disabled
  • enabled
enabled

De inrichtingsstatus.

reprovisionPolicy

ReprovisionPolicy

Het gedrag van de service wanneer een apparaat opnieuw wordt ingericht voor een IoT-hub.

InitialTwin

Eerste apparaatdubbel. Bevat een subset van de eigenschappen van Dubbel.

Name Type Description
properties

InitialTwinProperties

Vertegenwoordigt de oorspronkelijke eigenschappen die worden ingesteld op de apparaatdubbel.

tags

TwinCollection

Vertegenwoordigt een verzameling eigenschappen binnen een tweeling

InitialTwinProperties

Vertegenwoordigt de oorspronkelijke eigenschappen die worden ingesteld op de apparaatdubbel.

Name Type Description
desired

TwinCollection

Vertegenwoordigt een verzameling eigenschappen binnen een tweeling

Metadata

Metagegevens voor de TwinCollection

Name Type Description
lastUpdated

string (date-time)

De laatste keer dat de TwinCollection is bijgewerkt

lastUpdatedVersion

integer (int64)

Dit is null voor gerapporteerde metagegevens van eigenschappen en is niet null voor metagegevens van gewenste eigenschappen.

ProvisioningServiceErrorDetails

Bevat de eigenschappen van een fout die wordt geretourneerd door azure IoT Hub Provisioning Service.

Name Type Description
errorCode

integer (int32)

info

object

message

string

timestampUtc

string (date-time)

trackingId

string

ReprovisionPolicy

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 false, worden de gegevens van het apparaat opnieuw ingesteld op de initiële 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 indien nodig bij voor inrichtingsaanvragen buiten de eerste van een bepaald apparaat. Als deze optie is ingesteld op false, blijft het apparaat toegewezen aan de huidige IoT-hub.

SymmetricKeyAttestation

Attestation via SymmetricKey.

Name Type Description
primaryKey

string

Primaire symmetrische sleutel.

secondaryKey

string

Secundaire symmetrische sleutel.

TpmAttestation

Attestation via TPM.

Name Type Description
endorsementKey

string

storageRootKey

string

TwinCollection

Vertegenwoordigt een verzameling eigenschappen binnen een tweeling

Name Type Description
count

integer

Aantal eigenschappen in de TwinCollection

metadata

Metadata

Metagegevens voor de TwinCollection

version

integer (int64)

Versie van de TwinCollection

X509Attestation

Attestation via X509.

Name Type Description
caReferences

X509CAReferences

Primaire en secundaire CA-verwijzingen.

clientCertificates

X509Certificates

Primaire en secundaire certificaten

signingCertificates

X509Certificates

Primaire en secundaire certificaten

X509CAReferences

Primaire en secundaire CA-verwijzingen.

Name Type Description
primary

string

secondary

string

X509CertificateInfo

X509-certificaatgegevens.

Name Type Description
issuerName

string

notAfterUtc

string (date-time)

notBeforeUtc

string (date-time)

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer (int32)

X509Certificates

Primaire en secundaire certificaten

Name Type Description
primary

X509CertificateWithInfo

Certificaat- en certificaatgegevens

secondary

X509CertificateWithInfo

Certificaat- en certificaatgegevens

X509CertificateWithInfo

Certificaat- en certificaatgegevens

Name Type Description
certificate

string

info

X509CertificateInfo

X509-certificaatgegevens.