Condividi tramite


Enrollment Group - Create Or Update

Create o aggiornare un gruppo di registrazione dispositivi.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
id
path True

string

ID gruppo di registrazione.

api-version
query True

string

Versione dell'API da usare per la richiesta. Le versioni supportate includono: 2021-10-01

Intestazione della richiesta

Nome Necessario Tipo Descrizione
If-Match

string

ETag del record di registrazione.

Corpo della richiesta

Nome Necessario Tipo Descrizione
attestation True

AttestationMechanism

Meccanismo di attestazione per individualEnrollment e enrollmentGroup.

enrollmentGroupId True

string

ID gruppo di registrazione.

allocationPolicy enum:
  • hashed
  • geoLatency
  • static
  • custom

Criteri di allocazione di questa risorsa. Questo criterio sostituisce i criteri di allocazione a livello di tenant per questa singola registrazione o gruppo di registrazione. I valori possibili includono "hashed": è probabile che gli hub IoT collegati dispongano di dispositivi di cui è stato effettuato il provisioning, ovvero "geoLatency": viene effettuato il provisioning dei dispositivi in un hub IoT con la latenza più bassa per il dispositivo. Se più hub IoT collegati forniscono la stessa latenza più bassa, il servizio di provisioning esegue l'hashing dei dispositivi in tali hub, "statico" : la specifica dell'hub IoT desiderato nell'elenco di registrazioni ha la priorità sui criteri di allocazione a livello di servizio, "custom": viene effettuato il provisioning dei dispositivi in un hub IoT basato sulla logica personalizzata. Il servizio di provisioning passa informazioni sul dispositivo alla logica e la logica restituisce l'hub IoT desiderato e la configurazione iniziale desiderata. È consigliabile usare Funzioni di Azure per ospitare la logica.

capabilities

DeviceCapabilities

Funzionalità del dispositivo.

customAllocationDefinition

CustomAllocationDefinition

Indica al servizio Device Provisioning quale webhook chiamare quando si usa l'allocazione personalizzata.

etag

string

Tag di entità associato alla risorsa.

initialTwin

InitialTwin

Dispositivo gemello iniziale. Contiene un subset delle proprietà di Twin.

iotHubHostName

string

Nome host dell'hub Iot.

iotHubs

string[]

L'elenco di hub IoT nomi host a cui è possibile allocare i dispositivi in questa risorsa. Deve essere un subset di hub IoT a livello di tenant.

provisioningStatus enum:
  • enabled
  • disabled

Stato del provisioning.

reprovisionPolicy

ReprovisionPolicy

Comportamento del servizio quando viene eseguito di nuovo il provisioning di un dispositivo in un hub IoT.

Risposte

Nome Tipo Descrizione
200 OK

EnrollmentGroup

Operazione riuscita

Other Status Codes

ProvisioningServiceErrorDetails

Risposta di errore

Intestazioni

x-ms-error-code: string

Definizioni

Nome Descrizione
AttestationMechanism

Meccanismo di attestazione per individualEnrollment e enrollmentGroup.

CustomAllocationDefinition

Indica al servizio Device Provisioning quale webhook chiamare quando si usa l'allocazione personalizzata.

DeviceCapabilities

Funzionalità del dispositivo.

EnrollmentGroup

Record del gruppo di registrazione.

InitialTwin

Dispositivo gemello iniziale. Contiene un subset delle proprietà di Twin.

InitialTwinProperties

Rappresenta le proprietà iniziali che verranno impostate nel dispositivo gemello.

Metadata

Metadati per TwinCollection

ProvisioningServiceErrorDetails

Contiene le proprietà di un errore restituito dal servizio di provisioning hub IoT di Azure.

ReprovisionPolicy

Comportamento del servizio quando viene eseguito di nuovo il provisioning di un dispositivo in un hub IoT.

SymmetricKeyAttestation

Attestazione tramite SymmetricKey.

TpmAttestation

Attestazione tramite TPM.

TwinCollection

Rappresenta una raccolta di proprietà all'interno di un oggetto Twin

X509Attestation

Attestazione tramite X509.

X509CAReferences

Riferimenti alla CA primaria e secondaria.

X509CertificateInfo

Informazioni sul certificato X509.

X509Certificates

Certificati primari e secondari

X509CertificateWithInfo

Informazioni su certificato e certificato

AttestationMechanism

Meccanismo di attestazione per individualEnrollment e enrollmentGroup.

Nome Tipo Descrizione
symmetricKey

SymmetricKeyAttestation

Attestazione tramite SymmetricKey.

tpm

TpmAttestation

Attestazione tramite TPM.

type enum:
  • none
  • symmetricKey
  • tpm
  • x509

Tipo di attestazione.

x509

X509Attestation

Attestazione tramite X509.

CustomAllocationDefinition

Indica al servizio Device Provisioning quale webhook chiamare quando si usa l'allocazione personalizzata.

Nome Tipo Descrizione
apiVersion

string

La versione API dei tipi di servizio di provisioning (ad esempio IndividualEnrollment) inviata nella richiesta di allocazione personalizzata. Versione minima supportata: "2018-09-01-preview".

webhookUrl

string

URL del webhook usato per le richieste di allocazione.

DeviceCapabilities

Funzionalità del dispositivo.

Nome Tipo Valore predefinito Descrizione
iotEdge

boolean

False

Se impostato su true, questo dispositivo è un dispositivo IoTEdge.

EnrollmentGroup

Record del gruppo di registrazione.

Nome Tipo Valore predefinito Descrizione
allocationPolicy enum:
  • custom
  • geoLatency
  • hashed
  • static

Criteri di allocazione di questa risorsa. Questo criterio sostituisce i criteri di allocazione a livello di tenant per questa singola registrazione o gruppo di registrazione. I valori possibili includono "hashed": è probabile che gli hub IoT collegati dispongano di dispositivi di cui è stato effettuato il provisioning, ovvero "geoLatency": viene effettuato il provisioning dei dispositivi in un hub IoT con la latenza più bassa per il dispositivo. Se più hub IoT collegati forniscono la stessa latenza più bassa, il servizio di provisioning esegue l'hashing dei dispositivi in tali hub, "statico" : la specifica dell'hub IoT desiderato nell'elenco di registrazioni ha la priorità sui criteri di allocazione a livello di servizio, "custom": viene effettuato il provisioning dei dispositivi in un hub IoT basato sulla logica personalizzata. Il servizio di provisioning passa informazioni sul dispositivo alla logica e la logica restituisce l'hub IoT desiderato e la configurazione iniziale desiderata. È consigliabile usare Funzioni di Azure per ospitare la logica.

attestation

AttestationMechanism

Meccanismo di attestazione per individualEnrollment e enrollmentGroup.

capabilities

DeviceCapabilities

Funzionalità del dispositivo.

createdDateTimeUtc

string

Data/ora di creazione della risorsa.

customAllocationDefinition

CustomAllocationDefinition

Indica al servizio Device Provisioning quale webhook chiamare quando si usa l'allocazione personalizzata.

enrollmentGroupId

string

ID gruppo di registrazione.

etag

string

Tag di entità associato alla risorsa.

initialTwin

InitialTwin

Dispositivo gemello iniziale. Contiene un subset delle proprietà di Twin.

iotHubHostName

string

Nome host dell'hub Iot.

iotHubs

string[]

L'elenco di hub IoT nomi host a cui è possibile allocare i dispositivi in questa risorsa. Deve essere un subset di hub IoT a livello di tenant.

lastUpdatedDateTimeUtc

string

Data/ora dell'ultimo aggiornamento della risorsa.

provisioningStatus enum:
  • disabled
  • enabled
enabled

Stato del provisioning.

reprovisionPolicy

ReprovisionPolicy

Comportamento del servizio quando viene eseguito di nuovo il provisioning di un dispositivo in un hub IoT.

InitialTwin

Dispositivo gemello iniziale. Contiene un subset delle proprietà di Twin.

Nome Tipo Descrizione
properties

InitialTwinProperties

Rappresenta le proprietà iniziali che verranno impostate nel dispositivo gemello.

tags

TwinCollection

Rappresenta una raccolta di proprietà all'interno di un oggetto Twin

InitialTwinProperties

Rappresenta le proprietà iniziali che verranno impostate nel dispositivo gemello.

Nome Tipo Descrizione
desired

TwinCollection

Rappresenta una raccolta di proprietà all'interno di un oggetto Twin

Metadata

Metadati per TwinCollection

Nome Tipo Descrizione
lastUpdated

string

Ora dell'ultimo aggiornamento di TwinCollection

lastUpdatedVersion

integer

Questo valore è Null per i metadati delle proprietà segnalate e non è Null per i metadati delle proprietà desiderati.

ProvisioningServiceErrorDetails

Contiene le proprietà di un errore restituito dal servizio di provisioning hub IoT di Azure.

Nome Tipo Descrizione
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string

ReprovisionPolicy

Comportamento del servizio quando viene eseguito di nuovo il provisioning di un dispositivo in un hub IoT.

Nome Tipo Valore predefinito Descrizione
migrateDeviceData

boolean

True

Se impostato su true (impostazione predefinita), il servizio Device Provisioning eseguirà la migrazione dei dati del dispositivo (funzionalità del dispositivo gemello, funzionalità del dispositivo e ID dispositivo) da un hub IoT a un altro durante un aggiornamento dell'assegnazione dell'hub IoT. Se impostato su false, il servizio Device Provisioning reimposta i dati del dispositivo sulla configurazione iniziale desiderata archiviata nell'elenco di registrazioni corrispondente.

updateHubAssignment

boolean

True

Se impostato su true (impostazione predefinita), il servizio Device Provisioning valuterà l'assegnazione hub IoT del dispositivo e la aggiornerà, se necessario, per eventuali richieste di provisioning oltre il primo da un determinato dispositivo. Se impostato su false, il dispositivo rimarrà assegnato all'hub IoT corrente.

SymmetricKeyAttestation

Attestazione tramite SymmetricKey.

Nome Tipo Descrizione
primaryKey

string

Chiave simmetrica primaria.

secondaryKey

string

Chiave simmetrica secondaria.

TpmAttestation

Attestazione tramite TPM.

Nome Tipo Descrizione
endorsementKey

string

storageRootKey

string

TwinCollection

Rappresenta una raccolta di proprietà all'interno di un oggetto Twin

Nome Tipo Descrizione
count

integer

Numero di proprietà in TwinCollection

metadata

Metadata

Metadati per TwinCollection

version

integer

Versione di TwinCollection

X509Attestation

Attestazione tramite X509.

Nome Tipo Descrizione
caReferences

X509CAReferences

Riferimenti alla CA primaria e secondaria.

clientCertificates

X509Certificates

Certificati primari e secondari

signingCertificates

X509Certificates

Certificati primari e secondari

X509CAReferences

Riferimenti alla CA primaria e secondaria.

Nome Tipo Descrizione
primary

string

secondary

string

X509CertificateInfo

Informazioni sul certificato X509.

Nome Tipo Descrizione
issuerName

string

notAfterUtc

string

notBeforeUtc

string

serialNumber

string

sha1Thumbprint

string

sha256Thumbprint

string

subjectName

string

version

integer

X509Certificates

Certificati primari e secondari

Nome Tipo Descrizione
primary

X509CertificateWithInfo

Informazioni su certificato e certificato

secondary

X509CertificateWithInfo

Informazioni su certificato e certificato

X509CertificateWithInfo

Informazioni su certificato e certificato

Nome Tipo Descrizione
certificate

string

info

X509CertificateInfo

Informazioni sul certificato X509.